AWS EventBridgeアクション

このページでは、ワークフロー自動化アクションカタログで利用可能なAWS EventBridgeアクションのリファレンスを提供します。これらのアクションを使用して、イベントの発行、ルールの状態の管理、およびアーカイブ、リプレイ、パートナーイベントソースの操作を実行します。

前提条件

ワークフロー自動化で AWS アクションを使用する前に、次の点を確認してください。

適切な権限を持つ AWS アカウント。
設定された AWS 認証情報 (IAM ユーザー認証情報、IAM ロール ARN、またはセッション認証情報)。
EventBridgeに必要なIAM権限。少なくとも、IAMロールまたはユーザーにはターゲットリソースに対するevents:*が必要です。

IAM ユーザーおよび IAM ロールを作成する方法、およびワークフローオートメーションAWSアクションと統合するための静的 AWS 認証情報とセッションAWS認証情報を設定する方法については、 AWS認証情報のセットアップ」を参照してください。

単一のイベントをイベントバスに送信します

アクション識別子はaws.eventBridge.putEventです。

ルールと照合できるように、単一のカスタムイベントをAWS EventBridgeイベントバスに送信します。これは単一エントリの便利なラッパーです — 1回の呼び出しで複数のイベントを送信するにはaws.eventBridge.putEventsを使用します。

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

入力	タイプ	説明	例
`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`
`source`	弦	必須。イベントのソース。	`my.application`
`detailType`	弦	必須。イベント詳細のタイプを記述するフリーフォーム文字列（最大128文字）。	`OrderPlaced`
`detail`	弦	必須。有効なシリアル化されたJSON文字列。最大サイズは256 KBです。	`"{\"orderId\": \"12345\", \"amount\": 99.99}"`
`eventBusName`	弦	オプション。イベントを受信するイベントバスの名前またはARN。デフォルトのイベントバスを使用する場合は省略します。	`my-event-bus`
`resources`	リスト	オプション。イベントが主に関係する、ARNによって識別されるAWSリソース。	`["arn:aws:s3:::my-bucket"]`
`traceHeader`	弦	オプション。イベントに関連付けるX-Rayトレースヘッダー（ `X-Amzn-Trace-Id` ）。	`Root=1-5e272390-8c398be037738dc042009320`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "failedEntryCount", "expression": ".response.FailedEntryCount"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"FailedEntryCount": 0, "Entries": [{"EventId": "11710aed-b79e-4468-a20b-bb3c0c3b4860"}]}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"FailedEntryCount": 0, "Entries": [{"EventId": "11710aed-b79e-4468-a20b-bb3c0c3b4860"}]}

success

ブール値

true

または

false

errorMessage

弦

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

複数のイベントをイベントバスに送信します

アクション識別子はaws.eventBridge.putEventsです。

1回の呼び出しで複数のカスタムイベントをAmazon EventBridgeに送信します。1リクエストにつき最大10イベント。

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

入力	タイプ	説明	例
`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`
`entries`	リスト	必須。送信するイベントのリスト。各エントリには `Source` 、 `DetailType` 、および `Detail` を含める必要があります。1リクエストにつき最大10エントリ。	`[{"Source": "my.application", "DetailType": "OrderPlaced", "Detail": "{\"orderId\": \"12345\"}", "EventBusName": "default"}]`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "failedEntryCount", "expression": ".response.FailedEntryCount"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"FailedEntryCount": 0, "Entries": [{"EventId": "11710aed-..."}, {"EventId": "d804d26a-..."}]}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"FailedEntryCount": 0, "Entries": [{"EventId": "11710aed-..."}, {"EventId": "d804d26a-..."}]}

success

ブール値

true

または

false

errorMessage

弦

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

EventBridgeルールを有効にする

アクション識別子はaws.eventBridge.enableRuleです。

無効になっているEventBridgeルールを有効にします。ルールが存在しない場合、操作は失敗します。

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

入力	タイプ	説明	例
`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`
`name`	弦	必須。有効にするルールの名前。	`my-rule`
`eventBusName`	弦	オプション。ルールに関連付けられたイベントバスの名前またはARN。デフォルトのイベントバスの場合は省略します。	`my-event-bus`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "response", "expression": ".response"}]`

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

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

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

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

EventBridgeルールを無効にする

アクション識別子はaws.eventBridge.disableRuleです。

アクティブなEventBridgeルールを無効にします。無効化されたルールはどのイベントにも一致せず、スケジュール式がある場合でも自己トリガーしません。

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

入力	タイプ	説明	例
`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`
`name`	弦	必須。無効にするルールの名前。	`my-rule`
`eventBusName`	弦	オプション。ルールに関連付けられたイベントバスの名前またはARN。デフォルトのイベントバスの場合は省略します。	`my-event-bus`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "response", "expression": ".response"}]`

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

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

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

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

アーカイブの作成

アクション識別子はaws.eventBridge.createArchiveです。

後でリプレイするためにイベントバスからのイベントを保存するアーカイブを作成します。

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

入力	タイプ	説明	例
`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`
`archiveName`	弦	必須。アーカイブの名前。	`my-archive`
`eventSourceArn`	弦	必須。アーカイブにイベントを送信するイベントバスのARN。	`arn:aws:events:us-east-1:123456789012:event-bus/default`
`description`	弦	オプション。アーカイブの説明。	`Archive for production events`
`eventPattern`	弦	オプション。アーカイブに保存されるイベントをフィルタリングするためのイベントパターン。	`"{\"source\": [\"my.application\"]}"`
`retentionDays`	整数	オプション。イベントを保持する日数。イベントを無期限に保持するには、 `0` に設定します。	`90`
`kmsKeyIdentifier`	弦	オプション。アーカイブを暗号化するためのKMSキーID、ARN、またはエイリアス。AWS管理のデフォルトキーを使用する場合は省略します。	`arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "archiveArn", "expression": ".response.ArchiveArn"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"ArchiveArn": "arn:aws:events:us-east-1:123456789012:archive/my-archive", "State": "CREATING", "CreationTime": "2024-01-15T10:00:00Z"}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"ArchiveArn": "arn:aws:events:us-east-1:123456789012:archive/my-archive", "State": "CREATING", "CreationTime": "2024-01-15T10:00:00Z"}

success

ブール値

true

または

false

errorMessage

弦

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

アーカイブの記述

アクション識別子はaws.eventBridge.describeArchiveです。

状態、イベント数、および保持設定を含む、アーカイブに関する詳細を取得します。

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

入力	タイプ	説明	例
`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`
`archiveName`	弦	必須。記述するアーカイブの名前。	`my-archive`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "state", "expression": ".response.State"}, {"name": "eventCount", "expression": ".response.EventCount"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"ArchiveArn": "arn:aws:events:...", "ArchiveName": "my-archive", "State": "ENABLED", "EventCount": 100, "RetentionDays": 90, "SizeBytes": 10240}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"ArchiveArn": "arn:aws:events:...", "ArchiveName": "my-archive", "State": "ENABLED", "EventCount": 100, "RetentionDays": 90, "SizeBytes": 10240}

success

ブール値

true

または

false

errorMessage

弦

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

アーカイブの更新

アクション識別子はaws.eventBridge.updateArchiveです。

既存のアーカイブの説明、イベントパターン、保持期間、またはKMSキーを更新します。

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

入力	タイプ	説明	例
`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`
`archiveName`	弦	必須。更新するアーカイブの名前。	`my-archive`
`description`	弦	オプション。アーカイブの説明を更新しました。	`Updated archive description`
`eventPattern`	弦	オプション。アーカイブに保存されているイベントをフィルタリングするための更新されたイベントパターン。	`"{\"source\": [\"my.application\"]}"`
`retentionDays`	整数	オプション。イベントを保持する日数を更新しました。イベントを無期限に保持するには、 `0` に設定します。	`180`
`kmsKeyIdentifier`	弦	オプション。アーカイブを暗号化するための更新されたKMSキー。AWS管理のデフォルトキーに戻すには、空の文字列に設定します。	`arn:aws:kms:us-east-1:123456789012:key/mrk-1234abcd12ab34cd56ef1234567890ab`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "archiveArn", "expression": ".response.ArchiveArn"}, {"name": "state", "expression": ".response.State"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"ArchiveArn": "arn:aws:events:us-east-1:123456789012:archive/my-archive", "State": "UPDATING", "CreationTime": "2024-01-15T10:00:00Z"}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"ArchiveArn": "arn:aws:events:us-east-1:123456789012:archive/my-archive", "State": "UPDATING", "CreationTime": "2024-01-15T10:00:00Z"}

success

ブール値

true

または

false

errorMessage

弦

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

アーカイブの削除

アクション識別子はaws.eventBridge.deleteArchiveです。

既存のアーカイブとそこに保存されているすべてのイベントを削除します。

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

入力	タイプ	説明	例
`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`
`archiveName`	弦	必須。削除するアーカイブの名前。	`my-archive`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "response", "expression": ".response"}]`

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

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

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

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

アーカイブのリスト

アクション識別子はaws.eventBridge.listArchivesです。

名前のプレフィックス、イベントソースARN、または状態でオプションでフィルタリングして、アーカイブを一覧表示します。大規模な結果セットをページネーションするには、limitとnextTokenを使用します — ワークフロー自動化では100 KBの出力サイズ制限が適用されます。

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

入力	タイプ	説明	例
`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`
`namePrefix`	弦	オプション。名前のプレフィックスでアーカイブをフィルタリングします。	`my-`
`eventSourceArn`	弦	オプション。関連付けられたイベントバスのARNでアーカイブをフィルタリングします。	`arn:aws:events:us-east-1:123456789012:event-bus/default`
`state`	弦	オプション。アーカイブの状態でフィルタリングします。有効な値： `ENABLED` 、 `DISABLED` 、 `CREATING` 、 `UPDATING` 、 `CREATE_FAILED` 、 `UPDATE_FAILED` 。	`ENABLED`
`nextToken`	弦	オプション。結果の次のページを取得するための、以前のレスポンスからのページネーショントークン。
`limit`	整数	オプション。返す結果の最大数（最大100）。	`50`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "archives", "expression": ".response.Archives"}, {"name": "nextToken", "expression": ".response.NextToken"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"Archives": [{"ArchiveName": "my-archive", "State": "ENABLED", "EventCount": 100, "RetentionDays": 90}], "NextToken": "..."}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"Archives": [{"ArchiveName": "my-archive", "State": "ENABLED", "EventCount": 100, "RetentionDays": 90}], "NextToken": "..."}

success

ブール値

true

または

false

errorMessage

弦

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

リプレイを開始します

アクション識別子はaws.eventBridge.startReplayです。

指定した時間範囲のアーカイブされたイベントの、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-1`
`replayName`	弦	必須。開始するリプレイの名前。	`my-replay`
`eventSourceArn`	弦	必須。イベントをリプレイする元のアーカイブのARN。	`arn:aws:events:us-east-1:123456789012:archive/my-archive`
`eventStartTime`	弦	必須。リプレイする時間範囲の開始（ISO 8601形式）。	`2024-03-01T00:00:00Z`
`eventEndTime`	弦	必須。再生する時間範囲の終了（ISO 8601形式）。	`2024-03-31T23:59:59Z`
`destination`	地図	必須。再生されたイベントの宛先。 `Arn` （イベントバスARN）を含める必要があります。再生されたイベントを受信するルールを制限するには、オプションで `FilterArns` （ルールARNのリスト）を含めます — バスのすべてのルールに再生する場合は省略します。	`{"Arn": "arn:aws:events:us-east-1:123456789012:event-bus/default"}`
`description`	弦	オプション。リプレイの説明。	`Replaying March 2024 orders`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "replayArn", "expression": ".response.ReplayArn"}, {"name": "state", "expression": ".response.State"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"ReplayArn": "arn:aws:events:us-east-1:123456789012:replay/my-replay", "State": "STARTING", "StateReason": "Replay is starting", "ReplayStartTime": "2024-04-01T10:00:00Z"}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"ReplayArn": "arn:aws:events:us-east-1:123456789012:replay/my-replay", "State": "STARTING", "StateReason": "Replay is starting", "ReplayStartTime": "2024-04-01T10:00:00Z"}

success

ブール値

true

または

false

errorMessage

弦

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

リプレイの説明

アクション識別子はaws.eventBridge.describeReplayです。

状態、イベントの時間範囲、タイミングなど、特定のリプレイの詳細と進行状況を取得します。

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

入力	タイプ	説明	例
`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`
`replayName`	弦	必須。説明するリプレイの名前。	`my-replay`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "state", "expression": ".response.State"}, {"name": "stateReason", "expression": ".response.StateReason"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"ReplayArn": "arn:aws:events:...", "ReplayName": "my-replay", "State": "COMPLETED", "StateReason": "Replay completed successfully", "EventStartTime": "2024-03-01T00:00:00Z", "EventEndTime": "2024-03-31T23:59:59Z"}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"ReplayArn": "arn:aws:events:...", "ReplayName": "my-replay", "State": "COMPLETED", "StateReason": "Replay completed successfully", "EventStartTime": "2024-03-01T00:00:00Z", "EventEndTime": "2024-03-31T23:59:59Z"}

success

ブール値

true

または

false

errorMessage

弦

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

リプレイのキャンセル

アクション識別子はaws.eventBridge.cancelReplayです。

進行中のリプレイをキャンセルします。

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

入力	タイプ	説明	例
`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`
`replayName`	弦	必須。キャンセルするリプレイの名前。	`my-replay`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "replayArn", "expression": ".response.ReplayArn"}, {"name": "state", "expression": ".response.State"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"ReplayArn": "arn:aws:events:us-east-1:123456789012:replay/my-replay", "State": "CANCELLING", "StateReason": "User requested cancellation"}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"ReplayArn": "arn:aws:events:us-east-1:123456789012:replay/my-replay", "State": "CANCELLING", "StateReason": "User requested cancellation"}

success

ブール値

true

または

false

errorMessage

弦

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

リプレイの一覧表示

アクション識別子はaws.eventBridge.listReplaysです。

リプレイを一覧表示します。オプションで、名前のプレフィックス、状態、またはソースアーカイブARNでフィルタリングできます。limitとnextTokenを使用して大きな結果セットをページ分割します — ワークフロー自動化では100 KBの出力サイズ制限が適用されます。

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

入力	タイプ	説明	例
`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`
`namePrefix`	弦	オプション。名前のプレフィックスでリプレイをフィルタリングします。	`my-`
`state`	弦	オプション。リプレイの状態でフィルタリングします。有効な値： `STARTING` 、 `RUNNING` 、 `CANCELLING` 、 `COMPLETED` 、 `CANCELLED` 、 `FAILED` 。	`COMPLETED`
`eventSourceArn`	弦	オプション。ソースアーカイブのARNでリプレイをフィルタリングします。	`arn:aws:events:us-east-1:123456789012:archive/my-archive`
`nextToken`	弦	オプション。結果の次のページを取得するための、以前のレスポンスからのページネーショントークン。
`limit`	整数	オプション。返す結果の最大数（最大100）。	`50`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "replays", "expression": ".response.Replays"}, {"name": "nextToken", "expression": ".response.NextToken"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"Replays": [{"ReplayName": "my-replay", "State": "COMPLETED", "EventStartTime": "2024-03-01T00:00:00Z", "EventEndTime": "2024-03-31T23:59:59Z"}], "NextToken": "..."}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"Replays": [{"ReplayName": "my-replay", "State": "COMPLETED", "EventStartTime": "2024-03-01T00:00:00Z", "EventEndTime": "2024-03-31T23:59:59Z"}], "NextToken": "..."}

success

ブール値

true

または

false

errorMessage

弦

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

パートナーイベントソースのアクティブ化

アクション識別子はaws.eventBridge.activateEventSourceです。

非アクティブ化されたパートナーイベントソースをアクティブ化します。パートナーイベントソースアクションは、SaaSパートナーイベントソースにのみ適用されます。

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

入力	タイプ	説明	例
`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`
`name`	弦	必須。アクティブ化するパートナーイベントソースの名前。	`aws.partner/example.com/my-partner-event-source`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "response", "expression": ".response"}]`

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

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

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

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

パートナーイベントソースの非アクティブ化

アクション識別子はaws.eventBridge.deactivateEventSourceです。

パートナーイベントソースを非アクティブ化します。パートナーイベントソースのアクションは、SaaSパートナーイベントソースにのみ適用されます。

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

入力	タイプ	説明	例
`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`
`name`	弦	必須。非アクティブ化するパートナーイベントソースの名前。	`aws.partner/example.com/my-partner-event-source`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "response", "expression": ".response"}]`

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

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

出力

タイプ

例

response

オブジェクト

{}

（成功時は空）

success

ブール値

true

または

false

errorMessage

弦

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

パートナーイベントソースの説明

アクション識別子はaws.eventBridge.describeEventSourceです。

状態や有効期限など、特定のパートナーイベントソースの詳細を取得します。パートナーイベントソースのアクションは、SaaSパートナーイベントソースにのみ適用されます。

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

入力	タイプ	説明	例
`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`
`name`	弦	必須。記述するパートナーイベントソースの名前。	`aws.partner/example.com/my-partner-event-source`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "arn", "expression": ".response.Arn"}, {"name": "state", "expression": ".response.State"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"Arn": "arn:aws:events:us-east-1:123456789012:eventsource/aws.partner/example.com/my-source", "Name": "aws.partner/example.com/my-partner-event-source", "State": "ACTIVE", "CreatedBy": "aws.partner/example.com", "ExpirationTime": "2024-07-15T10:00:00Z"}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"Arn": "arn:aws:events:us-east-1:123456789012:eventsource/aws.partner/example.com/my-source", "Name": "aws.partner/example.com/my-partner-event-source", "State": "ACTIVE", "CreatedBy": "aws.partner/example.com", "ExpirationTime": "2024-07-15T10:00:00Z"}

success

ブール値

true

または

false

errorMessage

弦

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

パートナーイベントソースのリスト

アクション識別子はaws.eventBridge.listEventSourcesです。

パートナーイベントソースを一覧表示します。オプションで名前のプレフィックスでフィルタリングできます。パートナーイベントソースアクションは、SaaSパートナーイベントソースにのみ適用されます。大規模な結果セットをページネーションするには、limitとnextTokenを使用します — ワークフロー自動化では、100 KBの出力サイズ制限が適用されます。

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

入力	タイプ	説明	例
`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`
`namePrefix`	弦	オプション。このプレフィックスで始まる名前のイベントソースに結果をフィルタリングします。	`aws.partner/example.com`
`nextToken`	弦	オプション。結果の次のページを取得するための、以前のレスポンスからのページネーショントークン。
`limit`	整数	オプション。返す結果の最大数（最大100）。	`50`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "eventSources", "expression": ".response.EventSources"}, {"name": "nextToken", "expression": ".response.NextToken"}]`

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

出力	タイプ	例
`response`	オブジェクト	`{"EventSources": [{"Arn": "arn:aws:events:...", "Name": "aws.partner/example.com/my-source", "State": "ACTIVE", "ExpirationTime": "2024-07-15T10:00:00Z"}], "NextToken": "..."}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	失敗時のエラーメッセージ。

出力

タイプ

例

response

オブジェクト

{"EventSources": [{"Arn": "arn:aws:events:...", "Name": "aws.partner/example.com/my-source", "State": "ACTIVE", "ExpirationTime": "2024-07-15T10:00:00Z"}], "NextToken": "..."}

success

ブール値

true

または

false

errorMessage

弦

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

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

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

単一のイベントをイベントバスに送信します

複数のイベントをイベントバスに送信します

EventBridgeルールを有効にする

EventBridgeルールを無効にする

アーカイブの作成

アーカイブの記述

アーカイブの更新

アーカイブの削除

アーカイブのリスト

リプレイを開始します

リプレイの説明

リプレイのキャンセル

リプレイの一覧表示

パートナーイベントソースのアクティブ化

パートナーイベントソースの非アクティブ化

パートナーイベントソースの説明

パートナーイベントソースのリスト

前提条件