--- title: AWS EventBridge actions source: https://docs.newrelic.com/docs/workflow-automation/setup-and-configure/actions-catalog/aws/aws-eventbridge --- This page provides a reference for AWS EventBridge actions available in the workflow automation actions catalog. Use these actions to emit events, manage rule state, and run archive, replay, and partner event source operations. ## Prerequisites Before using AWS actions in workflow automation, ensure you have: - An AWS account with appropriate permissions. - AWS credentials configured (IAM user credentials, IAM role ARN, or session credentials). - The necessary IAM permissions for EventBridge. At minimum, the IAM role or user needs `events:*` on the target resources. See [Set up AWS credentials](https://docs.newrelic.com/docs/workflow-automation/setup-and-configure/set-up-aws-credentials/) for information on how to create IAM users and IAM roles, and set up static and session AWS credentials for integration with workflow automation AWS actions. ## Send a single event to an event bus The action identifier is `aws.eventBridge.putEvent`. Sends a single custom event to an AWS EventBridge event bus so it can be matched against rules. This is a single-entry convenience wrapper — use `aws.eventBridge.putEvents` to send multiple events in one call. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region of the target event bus. | `us-east-1` | | `source` | String | Required. The source of the event. | `my.application` | | `detailType` | String | Required. Free-form string (maximum 128 characters) that describes the type of event detail. | `OrderPlaced` | | `detail` | String | Required. A valid serialized JSON string. Maximum size is 256 KB. | `"{\"orderId\": \"12345\", \"amount\": 99.99}"` | | `eventBusName` | String | Optional. Name or ARN of the event bus to receive the event. Omit to use the default event bus. | `my-event-bus` | | `resources` | List | Optional. AWS resources, identified by ARN, that the event primarily concerns. | `["arn:aws:s3:::my-bucket"]` | | `traceHeader` | String | Optional. An X-Ray trace header (`X-Amzn-Trace-Id`) to associate with the event. | `Root=1-5e272390-8c398be037738dc042009320` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "failedEntryCount", "expression": ".response.FailedEntryCount"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------------------------------------------------------------------------- | | `response` | Object | `{"FailedEntryCount": 0, "Entries": [{"EventId": "11710aed-b79e-4468-a20b-bb3c0c3b4860"}]}` | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Send multiple events to an event bus The action identifier is `aws.eventBridge.putEvents`. Sends multiple custom events to Amazon EventBridge in a single call. Maximum 10 events per request. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region of the target event bus. | `us-east-1` | | `entries` | List | Required. List of events to send. Each entry must include `Source`, `DetailType`, and `Detail`. Maximum 10 entries per request. | `[{"Source": "my.application", "DetailType": "OrderPlaced", "Detail": "{\"orderId\": \"12345\"}", "EventBusName": "default"}]` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "failedEntryCount", "expression": ".response.FailedEntryCount"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------------------------------------------------------------------------------ | | `response` | Object | `{"FailedEntryCount": 0, "Entries": [{"EventId": "11710aed-..."}, {"EventId": "d804d26a-..."}]}` | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Enable an EventBridge rule The action identifier is `aws.eventBridge.enableRule`. Enables a disabled EventBridge rule. If the rule does not exist, the operation fails. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the rule is located. | `us-east-1` | | `name` | String | Required. Name of the rule to enable. | `my-rule` | | `eventBusName` | String | Optional. Name or ARN of the event bus associated with the rule. Omit for the default event bus. | `my-event-bus` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "response", "expression": ".response"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------- | | `response` | Object | `{}` (empty on success) | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Disable an EventBridge rule The action identifier is `aws.eventBridge.disableRule`. Disables an active EventBridge rule. A disabled rule won't match any events and won't self-trigger if it has a schedule expression. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the rule is located. | `us-east-1` | | `name` | String | Required. Name of the rule to disable. | `my-rule` | | `eventBusName` | String | Optional. Name or ARN of the event bus associated with the rule. Omit for the default event bus. | `my-event-bus` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "response", "expression": ".response"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------- | | `response` | Object | `{}` (empty on success) | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Create an archive The action identifier is `aws.eventBridge.createArchive`. Creates an archive to store events from an event bus for later replay. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the archive will be created. | `us-east-1` | | `archiveName` | String | Required. Name for the archive. | `my-archive` | | `eventSourceArn` | String | Required. ARN of the event bus that sends events to the archive. | `arn:aws:events:us-east-1:123456789012:event-bus/default` | | `description` | String | Optional. Description for the archive. | `Archive for production events` | | `eventPattern` | String | Optional. Event pattern to filter which events are stored in the archive. | `"{\"source\": [\"my.application\"]}"` | | `retentionDays` | Integer | Optional. Number of days to retain events. Set to `0` to retain events indefinitely. | `90` | | `kmsKeyIdentifier` | String | Optional. KMS key ID, ARN, or alias for encrypting the archive. Omit to use the AWS-managed default key. | `arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "archiveArn", "expression": ".response.ArchiveArn"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `response` | Object | `{"ArchiveArn": "arn:aws:events:us-east-1:123456789012:archive/my-archive", "State": "CREATING", "CreationTime": "2024-01-15T10:00:00Z"}` | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Describe an archive The action identifier is `aws.eventBridge.describeArchive`. Retrieves details about an archive, including its state, event count, and retention settings. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the archive is located. | `us-east-1` | | `archiveName` | String | Required. Name of the archive to describe. | `my-archive` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "state", "expression": ".response.State"}, {"name": "eventCount", "expression": ".response.EventCount"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `response` | Object | `{"ArchiveArn": "arn:aws:events:...", "ArchiveName": "my-archive", "State": "ENABLED", "EventCount": 100, "RetentionDays": 90, "SizeBytes": 10240}` | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Update an archive The action identifier is `aws.eventBridge.updateArchive`. Updates the description, event pattern, retention period, or KMS key of an existing archive. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the archive is located. | `us-east-1` | | `archiveName` | String | Required. Name of the archive to update. | `my-archive` | | `description` | String | Optional. Updated description for the archive. | `Updated archive description` | | `eventPattern` | String | Optional. Updated event pattern to filter events stored in the archive. | `"{\"source\": [\"my.application\"]}"` | | `retentionDays` | Integer | Optional. Updated number of days to retain events. Set to `0` to retain events indefinitely. | `180` | | `kmsKeyIdentifier` | String | Optional. Updated KMS key for encrypting the archive. Set to an empty string to revert to the AWS-managed default key. | `arn:aws:kms:us-east-1:123456789012:key/mrk-1234abcd12ab34cd56ef1234567890ab` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "archiveArn", "expression": ".response.ArchiveArn"}, {"name": "state", "expression": ".response.State"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `response` | Object | `{"ArchiveArn": "arn:aws:events:us-east-1:123456789012:archive/my-archive", "State": "UPDATING", "CreationTime": "2024-01-15T10:00:00Z"}` | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Delete an archive The action identifier is `aws.eventBridge.deleteArchive`. Deletes an existing archive and all events stored in it. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | --------------------------------------------------------------------------- | --------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the archive is located. | `us-east-1` | | `archiveName` | String | Required. Name of the archive to delete. | `my-archive` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "response", "expression": ".response"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------- | | `response` | Object | `{}` (empty on success) | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## List archives The action identifier is `aws.eventBridge.listArchives`. Lists archives, optionally filtered by name prefix, event source ARN, or state. Use `limit` and `nextToken` to paginate large result sets — Workflow Automation enforces a 100 KB output size limit. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region to list archives from. | `us-east-1` | | `namePrefix` | String | Optional. Filter archives by name prefix. | `my-` | | `eventSourceArn` | String | Optional. Filter archives by the ARN of the associated event bus. | `arn:aws:events:us-east-1:123456789012:event-bus/default` | | `state` | String | Optional. Filter by archive state. Valid values: `ENABLED`, `DISABLED`, `CREATING`, `UPDATING`, `CREATE_FAILED`, `UPDATE_FAILED`. | `ENABLED` | | `nextToken` | String | Optional. Pagination token from a previous response to retrieve the next page of results. | | | `limit` | Integer | Optional. Maximum number of results to return (maximum 100). | `50` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "archives", "expression": ".response.Archives"}, {"name": "nextToken", "expression": ".response.NextToken"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- | | `response` | Object | `{"Archives": [{"ArchiveName": "my-archive", "State": "ENABLED", "EventCount": 100, "RetentionDays": 90}], "NextToken": "..."}` | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Start a replay The action identifier is `aws.eventBridge.startReplay`. Starts replaying archived events from a specified time range to one or more event buses. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the archive and destination bus are located. | `us-east-1` | | `replayName` | String | Required. Name of the replay to start. | `my-replay` | | `eventSourceArn` | String | Required. ARN of the archive to replay events from. | `arn:aws:events:us-east-1:123456789012:archive/my-archive` | | `eventStartTime` | String | Required. Start of the time range to replay, in ISO 8601 format. | `2024-03-01T00:00:00Z` | | `eventEndTime` | String | Required. End of the time range to replay, in ISO 8601 format. | `2024-03-31T23:59:59Z` | | `destination` | Map | Required. Destination for replayed events. Must include `Arn` (event bus ARN). Optionally include `FilterArns` (list of rule ARNs) to limit which rules receive the replayed events — omit to replay to all rules on the bus. | `{"Arn": "arn:aws:events:us-east-1:123456789012:event-bus/default"}` | | `description` | String | Optional. Description for the replay. | `Replaying March 2024 orders` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "replayArn", "expression": ".response.ReplayArn"}, {"name": "state", "expression": ".response.State"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `response` | Object | `{"ReplayArn": "arn:aws:events:us-east-1:123456789012:replay/my-replay", "State": "STARTING", "StateReason": "Replay is starting", "ReplayStartTime": "2024-04-01T10:00:00Z"}` | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Describe a replay The action identifier is `aws.eventBridge.describeReplay`. Retrieves details and progress of a specific replay, including its state, event time range, and timing. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the replay is located. | `us-east-1` | | `replayName` | String | Required. Name of the replay to describe. | `my-replay` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "state", "expression": ".response.State"}, {"name": "stateReason", "expression": ".response.StateReason"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `response` | Object | `{"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` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Cancel a replay The action identifier is `aws.eventBridge.cancelReplay`. Cancels an in-progress replay. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the replay is located. | `us-east-1` | | `replayName` | String | Required. Name of the replay to cancel. | `my-replay` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "replayArn", "expression": ".response.ReplayArn"}, {"name": "state", "expression": ".response.State"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `response` | Object | `{"ReplayArn": "arn:aws:events:us-east-1:123456789012:replay/my-replay", "State": "CANCELLING", "StateReason": "User requested cancellation"}` | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## List replays The action identifier is `aws.eventBridge.listReplays`. Lists replays, optionally filtered by name prefix, state, or source archive ARN. Use `limit` and `nextToken` to paginate large result sets — Workflow Automation enforces a 100 KB output size limit. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region to list replays from. | `us-east-1` | | `namePrefix` | String | Optional. Filter replays by name prefix. | `my-` | | `state` | String | Optional. Filter by replay state. Valid values: `STARTING`, `RUNNING`, `CANCELLING`, `COMPLETED`, `CANCELLED`, `FAILED`. | `COMPLETED` | | `eventSourceArn` | String | Optional. Filter replays by the ARN of the source archive. | `arn:aws:events:us-east-1:123456789012:archive/my-archive` | | `nextToken` | String | Optional. Pagination token from a previous response to retrieve the next page of results. | | | `limit` | Integer | Optional. Maximum number of results to return (maximum 100). | `50` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "replays", "expression": ".response.Replays"}, {"name": "nextToken", "expression": ".response.NextToken"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `response` | Object | `{"Replays": [{"ReplayName": "my-replay", "State": "COMPLETED", "EventStartTime": "2024-03-01T00:00:00Z", "EventEndTime": "2024-03-31T23:59:59Z"}], "NextToken": "..."}` | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Activate a partner event source The action identifier is `aws.eventBridge.activateEventSource`. Activates a partner event source that has been deactivated. Partner event source actions apply to SaaS partner event sources only. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | --------------------------------------------------------------------------- | --------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the partner event source is located. | `us-east-1` | | `name` | String | Required. Name of the partner event source to activate. | `aws.partner/example.com/my-partner-event-source` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "response", "expression": ".response"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------- | | `response` | Object | `{}` (empty on success) | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Deactivate a partner event source The action identifier is `aws.eventBridge.deactivateEventSource`. Deactivates a partner event source. Partner event source actions apply to SaaS partner event sources only. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | --------------------------------------------------------------------------- | --------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the partner event source is located. | `us-east-1` | | `name` | String | Required. Name of the partner event source to deactivate. | `aws.partner/example.com/my-partner-event-source` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "response", "expression": ".response"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ------------------------- | | `response` | Object | `{}` (empty on success) | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## Describe a partner event source The action identifier is `aws.eventBridge.describeEventSource`. Retrieves details of a specific partner event source, including its state and expiration time. Partner event source actions apply to SaaS partner event sources only. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region where the partner event source is located. | `us-east-1` | | `name` | String | Required. Name of the partner event source to describe. | `aws.partner/example.com/my-partner-event-source` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "arn", "expression": ".response.Arn"}, {"name": "state", "expression": ".response.State"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `response` | Object | `{"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` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. | ## List partner event sources The action identifier is `aws.eventBridge.listEventSources`. Lists partner event sources, optionally filtered by name prefix. Partner event source actions apply to SaaS partner event sources only. Use `limit` and `nextToken` to paginate large result sets — Workflow Automation enforces a 100 KB output size limit. The following table describes the input fields for this action. | **Input** | **Type** | **Description** | **Example** | | -------------------- | -------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `awsRoleArn` | String | Optional. IAM role ARN to assume for AWS API calls. | `arn:aws:iam::123456789012:role/my-workflow-role` | | `awsAccessKeyId` | String | Optional. AWS access key ID. Pass as a secret. | `${{ :secrets:awsAccessKeyId }}` | | `awsSecretAccessKey` | String | Optional. AWS secret access key. Pass as a secret. | `${{ :secrets:awsSecretAccessKey }}` | | `awsSessionToken` | String | Optional. Temporary session token for STS authentication. Pass as a secret. | `${{ :secrets:awsSessionToken }}` | | `region` | String | Required. AWS region to list partner event sources from. | `us-east-1` | | `namePrefix` | String | Optional. Filter results to event sources with names starting with this prefix. | `aws.partner/example.com` | | `nextToken` | String | Optional. Pagination token from a previous response to retrieve the next page of results. | | | `limit` | Integer | Optional. Maximum number of results to return (maximum 100). | `50` | | `selectors` | List | Optional. JQ selectors to extract specific fields from the action output. | `[{"name": "eventSources", "expression": ".response.EventSources"}, {"name": "nextToken", "expression": ".response.NextToken"}]` | The following table describes the output fields for this action. | **Output** | **Type** | **Example** | | -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `response` | Object | `{"EventSources": [{"Arn": "arn:aws:events:...", "Name": "aws.partner/example.com/my-source", "State": "ACTIVE", "ExpirationTime": "2024-07-15T10:00:00Z"}], "NextToken": "..."}` | | `success` | Boolean | `true` or `false` | | `errorMessage` | String | Error message on failure. |