AWS SQSアクション

このページでは、ワークフロー自動化アクションカタログで利用可能なAWS SQSアクションのリファレンスを提供します。これらのアクションを使用して、Amazon SQSキューとメッセージを管理します。

前提条件

前提条件と認証情報のセットアップについては、AWS認証情報のセットアップをご覧ください。

SQSキューにメッセージを送信する

アクション識別子はaws.sqs.sendMessageです。

指定された Amazon SQS キューにメッセージを送信します。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョン。	`us-east-2`
`queueUrl`	弦	必須。ターゲットSQSキューのURL。	`https://sqs.us-east-2.amazonaws.com/123456789012/my-queue`
`messageBody`	弦	必須。キューに送信するメッセージ本文。	`"This is a test message"`
`messageDeduplicationId`	弦	オプション。 FIFOキューでの重複排除に使用されるトークン。	`"abc123deduplicationId5678"`
`messageGroupId`	弦	オプション。 FIFOキューのメッセージグループID。	`"group1"`
`messageAttributes`	地図	オプション。キーの値のペアとしてのメッセージ属性。	`{"my_attribute_name_1": {"DataType": "String", "StringValue": "my_attribute_value_1"}}`
`delaySeconds`	Int	オプション。メッセージの配信を遅延させる秒数。	`123`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{"statusCode": 200, "payload": {"MessageId": "e9b73a52-...", "MD5OfMessageBody": "fae535c7f..."}}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"SQS.Client.exceptions.QueueDoesNotExist: The specified queue does not exist."`

出力

タイプ

例

response

オブジェクト

{"statusCode": 200, "payload": {"MessageId": "e9b73a52-...", "MD5OfMessageBody": "fae535c7f..."}}

success

ブール値

true

または

false

errorMessage

弦

"SQS.Client.exceptions.QueueDoesNotExist: The specified queue does not exist."

SQSキューからメッセージを受信します

アクション識別子はaws.sqs.receiveMessageです。

指定されたキューから1つ以上のメッセージを取得します。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョン。	`us-east-2`
`queueUrl`	弦	必須。ターゲットSQSキューのURL。	`https://sqs.us-east-2.amazonaws.com/123456789012/my-queue`
`maxNumberOfMessages`	Int	オプション。取得するメッセージの最大数（1～10）。	`10`
`waitTimeSeconds`	Int	オプション。ロングポーリングの期間（秒）。	`5`
`VisibilityTimeout`	Int	オプション。受信したメッセージが他の消費者から隠される秒数です。	`123`
`AttributeNames`	リスト	オプション。レスポンスに含めるキューの属性名です。	`["All"]`
`messageAttributeNames`	リスト	オプション。取得するメッセージの属性名です。	`["message_attribute_name"]`
`messageSystemAttributeNames`	リスト	オプション。取得するシステムメッセージ属性。	`["SenderId", "SentTimestamp"]`
`receiveRequestAttemptId`	弦	オプション。 FIFOキューの受信requests用の重複排除トークン。	`"req-1234abcd"`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{"Messages": [{"MessageId": "...", "Body": "...", "ReceiptHandle": "..."}]}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"SQS.Client.exceptions.QueueDoesNotExist: The specified queue does not exist."`

出力

タイプ

例

response

オブジェクト

{"Messages": [{"MessageId": "...", "Body": "...", "ReceiptHandle": "..."}]}

success

ブール値

true

または

false

errorMessage

弦

"SQS.Client.exceptions.QueueDoesNotExist: The specified queue does not exist."

SQSキューを作成します

アクション識別子はaws.sqs.createQueueです。

指定された設定で新しいAmazon SQSキューを作成します。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが作成されるAWSリージョン。	`us-east-1`
`queueName`	弦	必須。新しいキューの名前（1～80文字）。アカウントおよびリージョン内で一意である必要があります。FIFOキューの場合、名前は `.fifo` で終わる必要があります。	`"my-app-queue"`
`attributes`	地図	オプション。キーの値のペアとしてのキュー属性。共通属性： `DelaySeconds` 、 `MessageRetentionPeriod` 、 `VisibilityTimeout` 、 `RedrivePolicy` 。数値を含め、すべての値は文字列である必要があります。	`{"DelaySeconds": "0", "MessageRetentionPeriod": "345600"}`
`tags`	地図	オプション。キーの値のペアとしてキューに割り当てるタグです。最大50個のタグです。 `aws:` プレフィックスは予約されています。	`{"Environment": "production", "Team": "backend"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "queueUrl", "expression": ".response.QueueUrl"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{"QueueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue"}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"QueueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue"}

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

SQSキューの削除

アクション識別子はaws.sqs.deleteQueueです。

Amazon SQSキューを削除します。キュー内のすべてのメッセージは完全に削除され、この操作は元に戻すことができません。同じ名前のキューを再作成できるようになるまで60秒の遅延があります。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョン。	`us-east-2`
`queueUrl`	弦	必須。削除するキューのURLです。	`https://sqs.us-east-1.amazonaws.com/123456789012/my-queue`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "status", "expression": ".success"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{}` （成功時は空）
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

SQSキュー属性を取得する

アクション識別子はaws.sqs.getQueueAttributesです。

メッセージ数、ARN、可視性タイムアウト、その他の設定など、Amazon SQSキューの属性を取得します。属性名では大文字と小文字が区別されます。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョン。	`us-east-2`
`queueUrl`	弦	必須。キューのURL。	`https://sqs.us-east-1.amazonaws.com/123456789012/my-queue`
`attributeNames`	リスト	オプション。取得する属性名。すべての属性を返すには、 `["All"]` を使用します。デフォルトはすべてです。	`["ApproximateNumberOfMessages", "QueueArn"]`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "messageCount", "expression": ".response.Attributes.ApproximateNumberOfMessages"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{"Attributes": {"QueueArn": "arn:aws:sqs:...", "ApproximateNumberOfMessages": "5", "VisibilityTimeout": "30"}}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"Attributes": {"QueueArn": "arn:aws:sqs:...", "ApproximateNumberOfMessages": "5", "VisibilityTimeout": "30"}}

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

SQSキュー属性の設定

アクション識別子はaws.sqs.setQueueAttributesです。

Amazon SQSキューの1つ以上の属性を更新します。数値を含め、すべての属性値は文字列である必要があります。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョン。	`us-east-2`
`queueUrl`	弦	必須。更新するキューのURL。	`https://sqs.us-east-1.amazonaws.com/123456789012/my-queue`
`attributes`	地図	必須。キーの値のペアとして設定するキュー属性。共通属性： `DelaySeconds` 、 `MessageRetentionPeriod` 、 `VisibilityTimeout` 、 `RedrivePolicy` 、 `KmsMasterKeyId` 。すべての値は文字列である必要があります。	`{"VisibilityTimeout": "60", "MessageRetentionPeriod": "345600"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "status", "expression": ".success"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{}` （成功時は空）
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

SQS キューのパージ

アクション識別子はaws.sqs.purgeQueueです。

キュー自体を削除せずに、Amazon SQSキュー内のすべてのメッセージを削除します。この操作は元に戻せません。パージの完了には最大60秒かかる場合があり、この期間中に送信されたメッセージも削除される可能性があります。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョン。	`us-east-2`
`queueUrl`	弦	必須。パージするキューのURLです。	`https://sqs.us-east-1.amazonaws.com/123456789012/my-queue`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "status", "expression": ".success"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{}` （成功時は空）
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

SQSキューを一覧表示

アクション識別子はaws.sqs.listQueuesです。

AWSアカウント内のSQSキューを一覧表示します。オプションでキュー名のプレフィックスでフィルタリングできます。キュー名の照合では大文字と小文字が区別されます。デフォルトでは、1リクエストにつき最大1,000件の結果を返します。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューを一覧表示するAWSリージョン。	`us-east-2`
`queueNamePrefix`	弦	オプション。名前のプレフィックスでキューをフィルタリングします。	`"prod-"`
`maxResults`	数	オプション。返す結果の最大数です（1～1,000）。デフォルトは1,000です。	`100`
`nextToken`	弦	オプション。次のページの結果を取得するための、前回のレスポンスのページネーショントークンです。
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "queueUrls", "expression": ".response.QueueUrls // []"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{"QueueUrls": ["https://sqs.us-east-1.amazonaws.com/123456789012/queue1", "..."], "NextToken": "..."}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"QueueUrls": ["https://sqs.us-east-1.amazonaws.com/123456789012/queue1", "..."], "NextToken": "..."}

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

SQSキューからのメッセージの削除

アクション識別子はaws.sqs.deleteMessageです。

受信ハンドルを使用して、Amazon SQSキューから特定のメッセージを削除します。aws.sqs.receiveMessageから受信ハンドルを取得します。受信ハンドルは、キューの可視性タイムアウト後に期限切れになります。タイムアウトが期限切れになった場合は、メッセージを再度受信して新しいハンドルを取得してください。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョン。	`us-east-2`
`queueUrl`	弦	必須。メッセージを含むキューのURLです。	`https://sqs.us-east-1.amazonaws.com/123456789012/my-queue`
`receiptHandle`	弦	必須。削除するメッセージのレシートハンドル。 `aws.sqs.receiveMessage` から取得します。
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "status", "expression": ".success"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{}` （成功時は空）
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

SQSキューにタグを付ける

アクション識別子はaws.sqs.tagQueueです。

Amazon SQSキューのタグを追加または更新します。この操作は、既存のタグを削除せずに、指定されたタグのみを追加または更新します。キューあたり最大50個のタグ。タグのキーと値は、大文字と小文字を区別します。aws:プレフィックスは予約されており、使用できません。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョン。	`us-east-2`
`queueUrl`	弦	必須。タグ付けするキューのURL。	`https://sqs.us-east-1.amazonaws.com/123456789012/my-queue`
`tags`	地図	必須。キーの値のペアとして追加または更新するタグ。	`{"Environment": "production", "Team": "backend"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "status", "expression": ".success"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{}` （成功時は空）
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

SQSキューからタグを削除

アクション識別子はaws.sqs.untagQueueです。

Amazon SQSキューから指定されたタグを削除します。タグキーでは大文字と小文字が区別されます。存在しないキーを指定してもエラーは発生しません。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョン。	`us-east-2`
`queueUrl`	弦	必須。タグを解除するキューのURLです。	`https://sqs.us-east-1.amazonaws.com/123456789012/my-queue`
`tagKeys`	リスト	必須。キューから削除するタグキー。	`["TestRun", "ExpirationDate"]`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "status", "expression": ".success"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{}` （成功時は空）
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

SQSキューのタグを一覧表示

アクション識別子はaws.sqs.listQueueTagsです。

Amazon SQSキューに関連付けられたすべてのタグを一覧表示します。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョン。	`us-east-2`
`queueUrl`	弦	必須。キューのURL。	`https://sqs.us-east-1.amazonaws.com/123456789012/my-queue`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "tags", "expression": ".response.Tags"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{"Tags": {"Environment": "production", "Team": "backend"}}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"Tags": {"Environment": "production", "Team": "backend"}}

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

メッセージ移動タスクを開始します

アクション識別子はaws.sqs.startMessageMoveTaskです。

あるキューから別のキューにメッセージを移動するタスクを開始します。主なユースケースは、デッドレターキュー（DLQ）からソースキューにメッセージを復元することです。ソースキューごとに、一度に許可されるアクティブなメッセージ移動タスクは1つのみです。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョンです。	`us-east-2`
`sourceArn`	弦	必須。メッセージの移動元となるソースキュー（通常はDLQ）のARN。	`arn:aws:sqs:us-east-1:123456789012:my-app-dlq`
`destinationArn`	弦	オプション。宛先キューのARN。指定されていない場合、メッセージは元のソースキューに戻ります。	`arn:aws:sqs:us-east-1:123456789012:my-app-queue`
`maxNumberOfMessagesPerSecond`	数	オプション。 1秒あたりに移動する最大メッセージ数（1～500）。宛先キューの過負荷を避けるために、より低い値を使用してください。	`100`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "taskHandle", "expression": ".response.TaskHandle"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{"TaskHandle": "AQEBIYN..."}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"TaskHandle": "AQEBIYN..."}

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

メッセージ移動タスクを一覧表示します

アクション識別子はaws.sqs.listMessageMoveTasksです。

ソースキューのメッセージ移動タスクを一覧表示し、そのステータスを確認します。このアクションを使用して、DLQリカバリ操作の進行状況をモニターします。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。ソースキューが配置されているAWSリージョン。	`us-east-2`
`sourceArn`	弦	必須。タスクを一覧表示するソースキューのARN。	`arn:aws:sqs:us-east-1:123456789012:my-app-dlq`
`maxResults`	数	オプション。返す結果の最大数（1～10）。デフォルトは10です。	`10`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "taskStatus", "expression": ".response.Results[0].Status"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{"Results": [{"TaskHandle": "...", "Status": "RUNNING", "SourceArn": "...", "ApproximateNumberOfMessagesMoved": 42}]}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"Results": [{"TaskHandle": "...", "Status": "RUNNING", "SourceArn": "...", "ApproximateNumberOfMessagesMoved": 42}]}

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

メッセージ移動タスクをキャンセルします。

アクション識別子はaws.sqs.cancelMessageMoveTaskです。

実行中のメッセージ移動タスクをキャンセルします。キャンセルは即座には行われません。タスクのステータスはCANCELLEDに到達する前にCANCELLINGを経由します。すでに移動されたメッセージはロールバックされません。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。キューが配置されているAWSリージョンです。	`us-east-2`
`taskHandle`	弦	必須。 `aws.sqs.startMessageMoveTask` が返すタスク識別子です。タスクハンドルは、タスクの完了後に有効期限が切れます。
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "messagesMoved", "expression": ".response.ApproximateNumberOfMessagesMoved"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{"ApproximateNumberOfMessagesMoved": 127}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"ApproximateNumberOfMessagesMoved": 127}

success

ブール値

true

または

false

errorMessage

弦

失敗時のエラーメッセージ。

この機械翻訳は、参考として提供されています。

前提条件.css-21sua1{background:none;border:none;width:0;padding:0;}

SQSキューにメッセージを送信する

SQSキューからメッセージを受信します

SQSキューを作成します

SQSキューの削除

SQSキュー属性を取得する

SQSキュー属性の設定

SQS キューのパージ

SQSキューを一覧表示

SQSキューからのメッセージの削除

SQSキューにタグを付ける

SQSキューからタグを削除

SQSキューのタグを一覧表示

メッセージ移動タスクを開始します

メッセージ移動タスクを一覧表示します

メッセージ移動タスクをキャンセルします。

前提条件