Api-Eventbridgev2-2025-05-15 - AWS SDK for PHP V3

Client: Aws\EventBridgeV2\EventBridgeV2Client

Service ID: eventbridgev2

Version: 2025-05-15

This page describes the parameters and results for the operations of the Amazon EventBridgeV2 (2025-05-15), and shows how to use the Aws\EventBridgeV2\EventBridgeV2Client object to call the described operations. This documentation is specific to the 2025-05-15 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateEventBus ( array $params = [] ): Creates an event bus.
CreateEventSource ( array $params = [] ): Creates an EventSource, which forwards events from an origin (an AWS service or another account) onto an event bus.
CreateSubscriber ( array $params = [] ): Creates a subscriber on an event bus, which delivers matching events to the configured target.
DeleteEventBus ( array $params = [] ): Deletes an event bus.
DeleteEventSource ( array $params = [] ): Deletes an EventSource.
DeleteResourcePolicy ( array $params = [] ): Deletes the named resource policy attached to an event bus.
DeleteSubscriber ( array $params = [] ): Deletes a subscriber.
DescribeEventBus ( array $params = [] ): Returns the full configuration and lifecycle state of an event bus.
DescribeEventSource ( array $params = [] ): Returns the full configuration and lifecycle state of an EventSource.
DescribeSubscriber ( array $params = [] ): Returns the full configuration and state of a subscriber.
GetResourcePolicy ( array $params = [] ): Returns the named resource policy attached to an event bus.
ListEventBuses ( array $params = [] ): Lists the event buses visible to the caller: buses the account owns and buses shared with it through AWS RAM.
ListEventSources ( array $params = [] ): Lists EventSources as summaries.
ListResourcePolicies ( array $params = [] ): Lists the resource policies attached to an event bus as summaries (policy name and revision ID).
ListSubscribers ( array $params = [] ): Lists subscribers as summaries.
ListTagsForResource ( array $params = [] ): Lists the tags on an event bus, subscriber, or event source.
PutEvents ( array $params = [] ): Publishes events to an event bus.
PutRawEvents ( array $params = [] ): Publishes pre-shaped events to an event bus.
PutResourcePolicy ( array $params = [] ): Attaches a named resource policy to an event bus — the only resource type that supports policies; other resource ARNs are rejected.
RevokeResource ( array $params = [] ): Revokes a subscriber or an EventSource.
TagResource ( array $params = [] ): Adds or replaces tags on an event bus, subscriber, or event source.
UntagResource ( array $params = [] ): Removes tags from an event bus, subscriber, or event source.
UpdateEventBus ( array $params = [] ): Updates an event bus.
UpdateEventSource ( array $params = [] ): Updates an EventSource.
UpdateSubscriber ( array $params = [] ): Updates a subscriber.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListEventBuses
ListEventSources
ListResourcePolicies
ListSubscribers

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
EventBusActive	DescribeEventBus	2	60
EventBusDeleted	DescribeEventBus	2	60

Operations

CreateEventBus

$result = $client->createEventBus([/* ... */]);
$promise = $client->createEventBusAsync([/* ... */]);

Creates an event bus. Provisioning is asynchronous: the bus is returned in the CREATING state and transitions to ACTIVE when ready (see the EventBusActive waiter). Retries carrying the same ClientToken are idempotent.

Parameter Syntax

$result = $client->createEventBus([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KmsKeyIdentifier' => '<string>',
    ],
    'Name' => '<string>', // REQUIRED
    'StorageConfiguration' => [
        'RetentionPeriodInDays' => <integer>,
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

ClientToken

: Type: string

Unique, case-sensitive identifier that ensures the idempotency of the request. The SDK generates one automatically when the field is omitted.

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EncryptionConfiguration

: Type: EncryptionConfiguration structure

Encryption configuration for an event bus.

Name

: Required: Yes
: Type: string

Name of an event bus. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'. The grammar matches the name segment of EventBusArn (event-busv2//), so every valid name can be represented in the bus's ARN. The same type is used everywhere a bus name appears.

StorageConfiguration

: Type: StorageConfiguration structure

Event storage configuration for an event bus.

Tags

: Type: Associative array of custom strings keys (TagKey) to strings

Tags attached to a resource, as key-value pairs.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KmsKeyIdentifier' => '<string>',
    ],
    'EventBusArn' => '<string>',
    'Name' => '<string>',
    'State' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING|ACTIVE|DELETE_FAILED',
    'StateReason' => '<string>',
    'StorageConfiguration' => [
        'RetentionPeriodInDays' => <integer>,
        'RetentionWindowStartTime' => <DateTime>,
    ],
]

Result Details

Members

CreationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event bus was created.

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EncryptionConfiguration

: Type: EncryptionConfiguration structure

Encryption configuration for an event bus.

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Name

: Type: string

State

: Type: string

Lifecycle state of an event bus.

CREATING: Bus creation is in progress.
CREATE_FAILED: Bus creation failed; see StateReason. The bus cannot be recovered or recreated in place: delete it with DeleteEventBus, then create a new bus.
ACTIVE: Bus is fully operational and can accept events.
UPDATING: Bus update is in progress.
UPDATE_FAILED: Bus update failed; the bus remains operational with its previous configuration.
DELETING: Bus deletion is actively in progress.
DELETE_FAILED: Bus deletion failed; see StateReason. Retry DeleteEventBus after removing subscribers and event sources.

StateReason

: Type: string

Human-readable explanation of why an event bus is in its current State. Omitted when the bus is in a normal operational state (ACTIVE). It stands in for the error response an asynchronous failure cannot return, so it applies only to resources with an asynchronous lifecycle: event buses. EventSources and subscribers are provisioned synchronously and report failures directly on the request.

StorageConfiguration

: Type: StorageConfigurationOutput structure

Event storage configuration of an event bus, as returned on reads.

Errors

LimitExceededException:: The request would exceed a service quota for the account.
AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
IdempotentParameterMismatchException:: The request reuses the client token of an earlier request with different parameters. Use a new client token, or resend the earlier request unchanged.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
ResourceAlreadyExistsException:: A resource with the same name already exists.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

CreateEventSource

$result = $client->createEventSource([/* ... */]);
$promise = $client->createEventSourceAsync([/* ... */]);

Creates an EventSource, which forwards events from an origin (an AWS service or another account) onto an event bus. The bus must be ACTIVE. Retries carrying the same ClientToken are idempotent.

Parameter Syntax

$result = $client->createEventSource([
    'ClientToken' => '<string>',
    'Configuration' => [ // REQUIRED
        'AwsServiceEventsConfiguration' => [
            'AwsService' => '<string>', // REQUIRED
            'OnFailureConfiguration' => [
                'Arn' => '<string>',
            ],
            'Pattern' => '<string>',
        ],
        'PartnerEventsConfiguration' => [
            'OnFailureConfiguration' => [
                'Arn' => '<string>',
            ],
            'PartnerBusKmsKeyIdentifier' => '<string>',
            'PartnerEventSourceArn' => '<string>', // REQUIRED
            'Pattern' => '<string>',
        ],
    ],
    'Description' => '<string>',
    'EventBusArn' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

ClientToken

: Type: string

Unique, case-sensitive identifier that ensures the idempotency of the request. The SDK generates one automatically when the field is omitted.

Configuration

: Required: Yes
: Type: EventSourceConfiguration structure

Discriminated EventSource configuration. Exactly one variant must be set.

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EventBusArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Name

: Required: Yes
: Type: string

EventSource name. First character alphanumeric; the rest may add '.', '-', '_'. Names may not begin with the reserved "aws." prefix. The grammar matches the ARN local-name segment in EventSourceArn (event-sourcev2///), mirroring EventBusName, so a name the ARN cannot represent cannot be created.

Tags

: Type: Associative array of custom strings keys (TagKey) to strings

Tags attached to a resource, as key-value pairs.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'EventBusArn' => '<string>',
    'EventSourceArn' => '<string>',
    'Name' => '<string>',
    'State' => 'CREATING|ACTIVE|UPDATING|CREATE_FAILED|UPDATE_FAILED|DELETING|DELETE_FAILED',
]

Result Details

Members

CreationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the EventSource was created.

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

EventSourceArn

: Type: string

EventSource ARN: event-sourcev2///. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events) and is not part of the resource's name. The id segment is a 25-character identifier generated by the service.

Name

: Type: string

State

: Type: string

Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.

Errors

LimitExceededException:: The request would exceed a service quota for the account.
AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
IdempotentParameterMismatchException:: The request reuses the client token of an earlier request with different parameters. Use a new client token, or resend the earlier request unchanged.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
ResourceAlreadyExistsException:: A resource with the same name already exists.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

CreateSubscriber

$result = $client->createSubscriber([/* ... */]);
$promise = $client->createSubscriberAsync([/* ... */]);

Creates a subscriber on an event bus, which delivers matching events to the configured target. The bus must be ACTIVE. Retries carrying the same ClientToken are idempotent.

Parameter Syntax

$result = $client->createSubscriber([
    'BatchConfiguration' => [
        'MaxBatchSize' => <integer>,
        'MaxBatchWindowInSeconds' => <integer>,
    ],
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'EventBusArn' => '<string>', // REQUIRED
    'FilterConfiguration' => [
        'Filters' => [
            [
                'Pattern' => '<string>', // REQUIRED
                'Scope' => 'DATA|METADATA|SYSTEM_METADATA', // REQUIRED
            ],
            // ...
        ],
        'Language' => 'EVENT_BRIDGE_PATTERN',
    ],
    'InvokeConfiguration' => [ // REQUIRED
        'EventBusV2Parameters' => [
            'DeduplicationConfiguration' => [
                'DeduplicationType' => 'CONTENT_BASED', // REQUIRED
            ],
            'Metadata' => ['<string>', ...],
            'SystemMetadata' => [
                'DeduplicationId' => '<string>',
                'EventGroupId' => '<string>',
            ],
        ],
        'HttpParameters' => [
            'HeaderParameters' => ['<string>', ...],
            'InvocationTimeoutSeconds' => '<string>',
            'PathParameterValues' => ['<string>', ...],
            'QueryStringParameters' => ['<string>', ...],
        ],
        'KinesisParameters' => [
            'ExplicitHashKey' => '<string>',
            'PartitionKey' => '<string>',
        ],
        'LambdaParameters' => [
            'DurableExecutionName' => '<string>',
            'InvocationTimeoutSeconds' => '<string>',
            'InvocationType' => 'EVENT|REQUEST_RESPONSE',
            'Qualifier' => '<string>',
            'TenantId' => '<string>',
        ],
        'RoleArn' => '<string>', // REQUIRED
        'SnsParameters' => [
            'MessageAttributes' => [
                '<MessageAttributeName>' => [
                    'BinaryValue' => '<string>',
                    'DataType' => '<string>',
                    'StringValue' => '<string>',
                ],
                // ...
            ],
            'MessageDeduplicationId' => '<string>',
            'MessageGroupId' => '<string>',
            'MessageStructure' => '<string>',
            'Subject' => '<string>',
        ],
        'SqsParameters' => [
            'DelaySeconds' => '<string>',
            'MessageAttributes' => [
                '<MessageAttributeName>' => [
                    'BinaryValue' => '<string>',
                    'DataType' => '<string>',
                    'StringValue' => '<string>',
                ],
                // ...
            ],
            'MessageDeduplicationId' => '<string>',
            'MessageGroupId' => '<string>',
            'MessageSystemAttributes' => [
                '<MessageAttributeName>' => [
                    'BinaryValue' => '<string>',
                    'DataType' => '<string>',
                    'StringValue' => '<string>',
                ],
                // ...
            ],
        ],
        'StepFunctionsParameters' => [
            'InvocationTimeoutSeconds' => '<string>',
            'InvocationType' => 'EVENT|REQUEST_RESPONSE',
            'Name' => '<string>',
            'TraceHeader' => '<string>',
        ],
        'TargetArn' => '<string>', // REQUIRED
        'UniversalTargetParameters' => [
            'Input' => '<string>', // REQUIRED
            'InvocationTimeoutSeconds' => '<string>',
        ],
    ],
    'LogConfiguration' => [
        'IncludePayload' => 'FULL|ON_ERROR_ONLY',
        'Level' => 'OFF|ERROR|INFO',
    ],
    'Name' => '<string>', // REQUIRED
    'OnFailureConfiguration' => [
        'Arn' => '<string>',
    ],
    'PointInTimeConfiguration' => [
        'EndPoint' => <integer || string || DateTime>,
        'PointType' => 'HORIZON|TIMESTAMP', // REQUIRED
        'StartingPoint' => <integer || string || DateTime>,
    ],
    'RetryPolicy' => [
        'MaxEventAgeInSeconds' => <integer>,
        'MaxRetryAttempts' => <integer>,
        'RetryStrategy' => 'ALL',
    ],
    'StartingPosition' => 'LATEST|POINT_IN_TIME',
    'State' => 'RUNNING|STOPPED',
    'Tags' => ['<string>', ...],
    'Transformer' => [
        'JsonataConfiguration' => [
            'Expression' => '<string>', // REQUIRED
        ],
        'Type' => 'RAW|WITH_METADATA|JSONATA',
    ],
    'Type' => 'FIFO|UNORDERED',
]);

Parameter Details

Members

BatchConfiguration

: Type: BatchConfiguration structure

Batching configuration for a subscriber.

ClientToken

: Type: string

Unique, case-sensitive identifier that ensures the idempotency of the request. The SDK generates one automatically when the field is omitted.

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EventBusArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

FilterConfiguration

: Type: FilterConfiguration structure

Configuration for filtering events delivered to a subscriber. On CreateSubscriber, Filters is required and must contain at least one Filter with a non-empty Pattern. On UpdateSubscriber, an empty FilterConfiguration:{} clears the existing filter. Any non-empty shape (including {Language:X} without Filters) must contain a valid Filters list — same contract as CreateSubscriber. A non-empty Filters list overwrites; an omitted FilterConfiguration preserves existing state. All Filters are implicitly ANDed — an event must match every Filter to be delivered.

InvokeConfiguration

: Required: Yes
: Type: InvokeConfiguration structure

Configuration for how the subscriber invokes its target.

LogConfiguration

: Type: LogConfiguration structure

Log configuration for a subscriber.

Name

: Required: Yes
: Type: string

Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

OnFailureConfiguration

: Type: OnFailureConfiguration structure

On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.

PointInTimeConfiguration

: Type: PointInTimeConfiguration structure

Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.

RetryPolicy

: Type: RetryPolicy structure

Retry policy for a subscriber.

StartingPosition

: Type: string

Starting position for a subscriber.

State

: Type: string

Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means "provisioned and healthy". Delivery requires State RUNNING on a subscriber that is not revoked.

Tags

: Type: Associative array of custom strings keys (TagKey) to strings

Tags attached to a resource, as key-value pairs.

Transformer

: Type: Transformer structure

Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.

Type

: Type: string

Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'EventBusArn' => '<string>',
    'Name' => '<string>',
    'PointInTimeConfiguration' => [
        'EndPoint' => <DateTime>,
        'PointType' => 'HORIZON|TIMESTAMP',
        'StartingPoint' => <DateTime>,
    ],
    'StartingPosition' => 'LATEST|POINT_IN_TIME',
    'State' => 'RUNNING|STOPPED',
    'SubscriberArn' => '<string>',
    'Type' => 'FIFO|UNORDERED',
]

Result Details

Members

CreationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the subscriber was created.

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Name

: Type: string

Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

PointInTimeConfiguration

: Type: PointInTimeConfiguration structure

Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.

StartingPosition

: Type: string

Starting position for a subscriber.

State

: Type: string

SubscriberArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

Type

: Type: string

Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

Errors

LimitExceededException:: The request would exceed a service quota for the account.
AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
IdempotentParameterMismatchException:: The request reuses the client token of an earlier request with different parameters. Use a new client token, or resend the earlier request unchanged.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
ResourceAlreadyExistsException:: A resource with the same name already exists.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

DeleteEventBus

$result = $client->deleteEventBus([/* ... */]);
$promise = $client->deleteEventBusAsync([/* ... */]);

Deletes an event bus. Deletion is asynchronous: the bus moves to DELETING and disappears when complete (see the EventBusDeleted waiter). A bus with subscribers or event sources cannot be deleted.

Parameter Syntax

$result = $client->deleteEventBus([
    'EventBusArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EventBusArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.
ResourceInUseException:: The resource is in use and cannot be deleted. For example, an event bus with subscribers or event sources cannot be deleted until they are deleted.

DeleteEventSource

$result = $client->deleteEventSource([/* ... */]);
$promise = $client->deleteEventSourceAsync([/* ... */]);

Deletes an EventSource. Forwarding from its origin stops.

Parameter Syntax

$result = $client->deleteEventSource([
    'EventSourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EventSourceArn

: Required: Yes
: Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the named resource policy attached to an event bus.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'ExpectedRevisionId' => '<string>',
    'PolicyName' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ExpectedRevisionId

: Type: string

The delete succeeds only if the named policy's current revision ID matches this value; if it differs or the policy does not exist, the operation fails with ConflictException. The "NO_POLICY" sentinel is not valid here. When omitted, deleting an absent policy is an idempotent success. Supplying this value makes the delete non-idempotent: once it succeeds the expected revision no longer exists, so retrying an unanswered request fails with ConflictException even though the policy was deleted. To establish the outcome, read the policy back: ResourceNotFoundException means the delete took effect.

PolicyName

: Type: string

Which named policy to delete. Defaults to "default" when omitted (a delete AWS Resource Access Manager makes on the owner's behalf resolves to "AWS_RAM" instead). The two writers are exclusive in both directions — only Resource Access Manager can delete "AWS_RAM", and only the bus owner can delete "default" — so naming the other party's policy fails with AccessDeniedException. A well-formed name that is neither of the two fails with InvalidInputException.

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Result Syntax

[
    'RevisionId' => '<string>',
]

Result Details

Members

RevisionId

: Type: string

Revision ID of the policy that was deleted. Absent when no policy was deleted.

Errors

AccessDeniedException:

The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.

ResourceNotFoundException:

The resource does not exist.

ThrottlingException:

The request was throttled because it exceeds a request rate limit. Retry the request with backoff.

ConflictException:

A client-supplied precondition (e.g. ExpectedRevisionId on a resource-policy write) did not match the current state of the resource. Retrying the same request will fail again; re-read the resource and re-evaluate before retrying.

A conditional request is not retry-safe on its own. If an earlier attempt committed but its response never reached the caller, retrying fails with this error, which is indistinguishable from another writer having won. Compare the resource's current contents with what the request intended: a successful attempt stores a revision ID the caller never saw, so the revision alone cannot tell the two apart, but matching contents mean the change took effect.

InvalidInputException:

A request parameter is missing or not valid.

InternalException:

The request failed because of an internal service error. Retry the request.

ConcurrentModificationException:

Another change to the resource is already in progress. Retry the request.

DeleteSubscriber

$result = $client->deleteSubscriber([/* ... */]);
$promise = $client->deleteSubscriberAsync([/* ... */]);

Deletes a subscriber. Events are no longer delivered to its target.

Parameter Syntax

$result = $client->deleteSubscriber([
    'SubscriberArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

SubscriberArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.

DescribeEventBus

$result = $client->describeEventBus([/* ... */]);
$promise = $client->describeEventBusAsync([/* ... */]);

Returns the full configuration and lifecycle state of an event bus.

Parameter Syntax

$result = $client->describeEventBus([
    'EventBusArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EventBusArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KmsKeyIdentifier' => '<string>',
    ],
    'EventBusArn' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
    'State' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING|ACTIVE|DELETE_FAILED',
    'StateReason' => '<string>',
    'StorageConfiguration' => [
        'RetentionPeriodInDays' => <integer>,
        'RetentionWindowStartTime' => <DateTime>,
    ],
]

Result Details

Members

CreationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event bus was created.

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EncryptionConfiguration

: Type: EncryptionConfiguration structure

Encryption configuration for an event bus.

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

LastModifiedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event bus was last modified.

Name

: Type: string

State

: Type: string

Lifecycle state of an event bus.

CREATING: Bus creation is in progress.
CREATE_FAILED: Bus creation failed; see StateReason. The bus cannot be recovered or recreated in place: delete it with DeleteEventBus, then create a new bus.
ACTIVE: Bus is fully operational and can accept events.
UPDATING: Bus update is in progress.
UPDATE_FAILED: Bus update failed; the bus remains operational with its previous configuration.
DELETING: Bus deletion is actively in progress.
DELETE_FAILED: Bus deletion failed; see StateReason. Retry DeleteEventBus after removing subscribers and event sources.

StateReason

: Type: string

StorageConfiguration

: Type: StorageConfigurationOutput structure

Event storage configuration of an event bus, as returned on reads.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.

DescribeEventSource

$result = $client->describeEventSource([/* ... */]);
$promise = $client->describeEventSourceAsync([/* ... */]);

Returns the full configuration and lifecycle state of an EventSource.

Parameter Syntax

$result = $client->describeEventSource([
    'EventSourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EventSourceArn

: Required: Yes
: Type: string

Result Syntax

[
    'Configuration' => [
        'AwsServiceEventsConfiguration' => [
            'AwsService' => '<string>',
            'OnFailureConfiguration' => [
                'Arn' => '<string>',
            ],
            'Pattern' => '<string>',
        ],
        'PartnerEventsConfiguration' => [
            'OnFailureConfiguration' => [
                'Arn' => '<string>',
            ],
            'PartnerBusKmsKeyIdentifier' => '<string>',
            'PartnerEventSourceArn' => '<string>',
            'Pattern' => '<string>',
        ],
    ],
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'EventBusArn' => '<string>',
    'EventSourceArn' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
    'Revoked' => true || false,
    'State' => 'CREATING|ACTIVE|UPDATING|CREATE_FAILED|UPDATE_FAILED|DELETING|DELETE_FAILED',
]

Result Details

Members

Configuration

: Type: EventSourceConfiguration structure

Discriminated EventSource configuration. Exactly one variant must be set.

CreationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the EventSource was created.

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

EventSourceArn

: Type: string

LastModifiedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the EventSource was last modified.

Name

: Type: string

Revoked

: Type: boolean

True when the bus owner has withdrawn this EventSource. Present only when true, so an absent member means the EventSource is not revoked. Revocation is terminal: it never returns to false. Mutating operations on a revoked EventSource fail with InvalidStateException, except DeleteEventSource, which stays available so a revoked EventSource can still be cleaned up.

State

: Type: string

Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.

DescribeSubscriber

$result = $client->describeSubscriber([/* ... */]);
$promise = $client->describeSubscriberAsync([/* ... */]);

Returns the full configuration and state of a subscriber.

Parameter Syntax

$result = $client->describeSubscriber([
    'SubscriberArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

SubscriberArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

Result Syntax

[
    'BatchConfiguration' => [
        'MaxBatchSize' => <integer>,
        'MaxBatchWindowInSeconds' => <integer>,
    ],
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'EventBusArn' => '<string>',
    'FilterConfiguration' => [
        'Filters' => [
            [
                'Pattern' => '<string>',
                'Scope' => 'DATA|METADATA|SYSTEM_METADATA',
            ],
            // ...
        ],
        'Language' => 'EVENT_BRIDGE_PATTERN',
    ],
    'InvokeConfiguration' => [
        'EventBusV2Parameters' => [
            'DeduplicationConfiguration' => [
                'DeduplicationType' => 'CONTENT_BASED',
            ],
            'Metadata' => ['<string>', ...],
            'SystemMetadata' => [
                'DeduplicationId' => '<string>',
                'EventGroupId' => '<string>',
            ],
        ],
        'HttpParameters' => [
            'HeaderParameters' => ['<string>', ...],
            'InvocationTimeoutSeconds' => '<string>',
            'PathParameterValues' => ['<string>', ...],
            'QueryStringParameters' => ['<string>', ...],
        ],
        'KinesisParameters' => [
            'ExplicitHashKey' => '<string>',
            'PartitionKey' => '<string>',
        ],
        'LambdaParameters' => [
            'DurableExecutionName' => '<string>',
            'InvocationTimeoutSeconds' => '<string>',
            'InvocationType' => 'EVENT|REQUEST_RESPONSE',
            'Qualifier' => '<string>',
            'TenantId' => '<string>',
        ],
        'RoleArn' => '<string>',
        'SnsParameters' => [
            'MessageAttributes' => [
                '<MessageAttributeName>' => [
                    'BinaryValue' => '<string>',
                    'DataType' => '<string>',
                    'StringValue' => '<string>',
                ],
                // ...
            ],
            'MessageDeduplicationId' => '<string>',
            'MessageGroupId' => '<string>',
            'MessageStructure' => '<string>',
            'Subject' => '<string>',
        ],
        'SqsParameters' => [
            'DelaySeconds' => '<string>',
            'MessageAttributes' => [
                '<MessageAttributeName>' => [
                    'BinaryValue' => '<string>',
                    'DataType' => '<string>',
                    'StringValue' => '<string>',
                ],
                // ...
            ],
            'MessageDeduplicationId' => '<string>',
            'MessageGroupId' => '<string>',
            'MessageSystemAttributes' => [
                '<MessageAttributeName>' => [
                    'BinaryValue' => '<string>',
                    'DataType' => '<string>',
                    'StringValue' => '<string>',
                ],
                // ...
            ],
        ],
        'StepFunctionsParameters' => [
            'InvocationTimeoutSeconds' => '<string>',
            'InvocationType' => 'EVENT|REQUEST_RESPONSE',
            'Name' => '<string>',
            'TraceHeader' => '<string>',
        ],
        'TargetArn' => '<string>',
        'UniversalTargetParameters' => [
            'Input' => '<string>',
            'InvocationTimeoutSeconds' => '<string>',
        ],
    ],
    'LastModifiedTime' => <DateTime>,
    'LogConfiguration' => [
        'IncludePayload' => 'FULL|ON_ERROR_ONLY',
        'Level' => 'OFF|ERROR|INFO',
    ],
    'Name' => '<string>',
    'OnFailureConfiguration' => [
        'Arn' => '<string>',
    ],
    'PointInTimeConfiguration' => [
        'EndPoint' => <DateTime>,
        'PointType' => 'HORIZON|TIMESTAMP',
        'StartingPoint' => <DateTime>,
    ],
    'RetryPolicy' => [
        'MaxEventAgeInSeconds' => <integer>,
        'MaxRetryAttempts' => <integer>,
        'RetryStrategy' => 'ALL',
    ],
    'Revoked' => true || false,
    'StartingPosition' => 'LATEST|POINT_IN_TIME',
    'State' => 'RUNNING|STOPPED',
    'SubscriberArn' => '<string>',
    'Transformer' => [
        'JsonataConfiguration' => [
            'Expression' => '<string>',
        ],
        'Type' => 'RAW|WITH_METADATA|JSONATA',
    ],
    'Type' => 'FIFO|UNORDERED',
]

Result Details

Members

BatchConfiguration

: Type: BatchConfiguration structure

Batching configuration for a subscriber.

CreationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the subscriber was created.

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

FilterConfiguration

: Type: FilterConfiguration structure

InvokeConfiguration

: Type: InvokeConfiguration structure

Configuration for how the subscriber invokes its target.

LastModifiedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the subscriber was last modified.

LogConfiguration

: Type: LogConfiguration structure

Log configuration for a subscriber.

Name

: Type: string

Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

OnFailureConfiguration

: Type: OnFailureConfiguration structure

On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.

PointInTimeConfiguration

: Type: PointInTimeConfiguration structure

Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.

RetryPolicy

: Type: RetryPolicy structure

Retry policy for a subscriber.

Revoked

: Type: boolean

True when the bus owner has revoked this subscriber. Present only when true, so an absent member means the subscriber is not revoked. Revocation is terminal: it never returns to false. Mutating operations on a revoked subscriber fail with InvalidStateException, except DeleteSubscriber, which stays available so a revoked subscriber can still be cleaned up.

StartingPosition

: Type: string

Starting position for a subscriber.

State

: Type: string

SubscriberArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

Transformer

: Type: Transformer structure

Absent for universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input.

Type

: Type: string

Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Returns the named resource policy attached to an event bus. Fails with ResourceNotFoundException when the event bus or the named policy does not exist.

Parameter Syntax

$result = $client->getResourcePolicy([
    'PolicyName' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

PolicyName

: Type: string

Which named policy to read. Defaults to "default" when omitted (a read AWS Resource Access Manager makes on the owner's behalf resolves to "AWS_RAM" instead). Unlike writing, neither name is reserved on a read: the bus owner can read both. There is no fallback between the two, so a bus shared only through Resource Access Manager fails with ResourceNotFoundException until "AWS_RAM" is named explicitly. A well-formed name that is neither of the two fails with InvalidInputException.

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Result Syntax

[
    'PolicyDocument' => '<string>',
    'PolicyName' => '<string>',
    'ResourceArn' => '<string>',
    'RevisionId' => '<string>',
]

Result Details

Members

PolicyDocument

: Required: Yes
: Type: string

A resource policy document, as a JSON string. The "default" policy can be up to 20 KB (20,480 bytes of UTF-8) by default. This quota is adjustable in Service Quotas. A "default" policy that exceeds the quota is rejected with PolicyLengthExceededException. No policy document can exceed 389,120 bytes of UTF-8, regardless of the quota.

PolicyName

: Required: Yes
: Type: string

Name of a policy attached to a resource. Valid values: "default" (the customer-managed policy) and "AWS_RAM" (managed exclusively by AWS Resource Access Manager). Any other value is rejected.

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

RevisionId

: Required: Yes
: Type: string

Revision ID of a resource policy. A new revision ID is generated on every successful write.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.

ListEventBuses

$result = $client->listEventBuses([/* ... */]);
$promise = $client->listEventBusesAsync([/* ... */]);

Lists the event buses visible to the caller: buses the account owns and buses shared with it through AWS RAM. Shared entries carry identity fields only (Name, EventBusArn, EventBusAccountId); owned entries carry every summary field. Set EventBusAccountId to scope the list to one owner account.

Parameter Syntax

$result = $client->listEventBuses([
    'EventBusAccountId' => '<string>',
    'MaxResults' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members

EventBusAccountId

: Type: string

AWS Account Id.

MaxResults

: Type: int

Maximum number of results to return in one page of a List operation.

NamePrefix

: Type: string

NextToken

: Type: string

Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.

Result Syntax

[
    'EventBuses' => [
        [
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'EventBusAccountId' => '<string>',
            'EventBusArn' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'State' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING|ACTIVE|DELETE_FAILED',
            'StateReason' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

EventBuses

: Type: Array of EventBusSummary structures

List of event bus summaries.

NextToken

: Type: string

Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.

ListEventSources

$result = $client->listEventSources([/* ... */]);
$promise = $client->listEventSourcesAsync([/* ... */]);

Lists EventSources as summaries. By default the list spans the EventSources the caller account owns; set EventBusArn to scope it to one bus. Use DescribeEventSource to retrieve full configuration.

Parameter Syntax

$result = $client->listEventSources([
    'EventBusArn' => '<string>',
    'MaxResults' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

MaxResults

: Type: int

Maximum number of results to return in one page of a List operation.

NamePrefix

: Type: string

NextToken

: Type: string

Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.

Result Syntax

[
    'EventSources' => [
        [
            'CreationTime' => <DateTime>,
            'EventBusArn' => '<string>',
            'EventSourceAccountId' => '<string>',
            'EventSourceArn' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Revoked' => true || false,
            'State' => 'CREATING|ACTIVE|UPDATING|CREATE_FAILED|UPDATE_FAILED|DELETING|DELETE_FAILED',
            'Type' => 'AWS_SERVICE_EVENTS|PARTNER_EVENTS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

EventSources

: Type: Array of EventSourceSummary structures

List of EventSource summaries.

NextToken

: Type: string

Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.

ListResourcePolicies

$result = $client->listResourcePolicies([/* ... */]);
$promise = $client->listResourcePoliciesAsync([/* ... */]);

Lists the resource policies attached to an event bus as summaries (policy name and revision ID). Use GetResourcePolicy to retrieve a policy document.

Parameter Syntax

$result = $client->listResourcePolicies([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

: Type: int

Maximum number of results to return in one page of a List operation.

NextToken

: Type: string

Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Result Syntax

[
    'NextToken' => '<string>',
    'PolicySummaries' => [
        [
            'PolicyName' => '<string>',
            'RevisionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.

PolicySummaries

: Type: Array of ResourcePolicySummary structures

List of resource policy summaries.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.

ListSubscribers

$result = $client->listSubscribers([/* ... */]);
$promise = $client->listSubscribersAsync([/* ... */]);

Lists subscribers as summaries. By default the list spans the subscribers the caller account owns across all buses; set EventBusArn to scope it to one bus. Use DescribeSubscriber to retrieve full configuration.

Parameter Syntax

$result = $client->listSubscribers([
    'EventBusArn' => '<string>',
    'MaxResults' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Members

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

MaxResults

: Type: int

Maximum number of results to return in one page of a List operation.

NamePrefix

: Type: string

Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

NextToken

: Type: string

Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'Subscribers' => [
        [
            'CreationTime' => <DateTime>,
            'EventBusArn' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Revoked' => true || false,
            'State' => 'RUNNING|STOPPED',
            'SubscriberAccountId' => '<string>',
            'SubscriberArn' => '<string>',
            'TargetArn' => '<string>',
            'Type' => 'FIFO|UNORDERED',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.

Subscribers

: Type: Array of SubscriberSummary structures

List of subscriber summaries.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags on an event bus, subscriber, or event source.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

ARN for an EventBridge resource that supports tagging: event buses, subscribers, and event sources.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

: Type: Associative array of custom strings keys (TagKey) to strings

Tags attached to a resource, as key-value pairs.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.

PutEvents

$result = $client->putEvents([/* ... */]);
$promise = $client->putEventsAsync([/* ... */]);

Publishes events to an event bus.

Parameter Syntax

$result = $client->putEvents([
    'DeduplicationConfiguration' => [
        'DeduplicationType' => 'CONTENT_BASED', // REQUIRED
    ],
    'Entries' => [ // REQUIRED
        [
            'Detail' => '<string>',
            'DetailType' => '<string>', // REQUIRED
            'Resources' => ['<string>', ...],
            'Source' => '<string>', // REQUIRED
            'SystemMetadata' => [
                'DeduplicationId' => '<string>',
                'EventGroupId' => '<string>',
            ],
            'Time' => <integer || string || DateTime>,
        ],
        // ...
    ],
    'EventBusArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeduplicationConfiguration

: Type: DeduplicationConfiguration structure

Request-level deduplication settings, applied to every entry in the batch.

Entries

: Required: Yes
: Type: Array of PutEventsRequestEntry structures

List of event entries to publish. Must contain at least one entry.

EventBusArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Result Syntax

[
    'Entries' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'EventId' => '<string>',
            'SequenceNumber' => '<string>',
            'SuccessCode' => 'PUBLISHED|DEDUPLICATED',
        ],
        // ...
    ],
    'FailedEntryCount' => <integer>,
]

Result Details

Members

Entries

: Type: Array of PutEventsResultEntry structures

List of per-entry publish results, in the same order as the request entries.

FailedEntryCount

: Type: int

The number of entries in the batch that failed to be published.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

PutRawEvents

$result = $client->putRawEvents([/* ... */]);
$promise = $client->putRawEventsAsync([/* ... */]);

Publishes pre-shaped events to an event bus.

Parameter Syntax

$result = $client->putRawEvents([
    'DeduplicationConfiguration' => [
        'DeduplicationType' => 'CONTENT_BASED', // REQUIRED
    ],
    'Entries' => [ // REQUIRED
        [
            'Data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
            'Metadata' => ['<string>', ...],
            'SystemMetadata' => [ // REQUIRED
                'ContentType' => '<string>', // REQUIRED
                'DeduplicationId' => '<string>',
                'EventGroupId' => '<string>',
            ],
        ],
        // ...
    ],
    'EventBusArn' => '<string>', // REQUIRED
    'SchemaRegistryConfiguration' => [
        'ConfluentPublicRegistryConfiguration' => [
            'ConnectionArn' => '<string>', // REQUIRED
        ],
        'RegistryUri' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

DeduplicationConfiguration

: Type: DeduplicationConfiguration structure

Request-level deduplication settings, applied to every entry in the batch.

Entries

: Required: Yes
: Type: Array of PutRawEventsRequestEntry structures

List of event entries to publish. Must contain at least one entry.

EventBusArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

SchemaRegistryConfiguration

: Type: SchemaRegistryConfiguration structure

Schema-registry settings for encoding open-format (Avro/Protobuf) events. Required for open-format entries; ignored for JSON entries. The registry is read with the caller's credentials, so the caller needs read access to the registry it references.

Result Syntax

[
    'Entries' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'EventId' => '<string>',
            'SequenceNumber' => '<string>',
            'SuccessCode' => 'PUBLISHED|DEDUPLICATED',
        ],
        // ...
    ],
    'FailedEntryCount' => <integer>,
]

Result Details

Members

Entries

: Type: Array of PutRawEventsResultEntry structures

List of per-entry publish results, in the same order as the request entries.

FailedEntryCount

: Type: int

The number of entries in the batch that failed to be published.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
SchemaRegistryUnavailableException:: The configured schema registry could not be reached. Retry the request.
InternalException:: The request failed because of an internal service error. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Attaches a named resource policy to an event bus — the only resource type that supports policies; other resource ARNs are rejected. Each bus holds two named policies: "default" (customer-managed, full IAM policy language including Deny) and "AWS_RAM" (written exclusively by AWS Resource Access Manager to reflect resource shares). Both policies are evaluated on cross-account authorization; an explicit Deny in either overrides an Allow in the other. Operations that omit PolicyName target "default". A "default" policy that would grant public access is rejected with PublicPolicyException and is not attached; this check is always on and cannot be disabled.

Parameter Syntax

$result = $client->putResourcePolicy([
    'ExpectedRevisionId' => '<string>',
    'PolicyDocument' => '<string>', // REQUIRED
    'PolicyName' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ExpectedRevisionId

: Type: string

The write succeeds only if the named policy's current revision ID matches this value; a policy that does not exist yet matches only the sentinel "NO_POLICY" (create-only). On mismatch the operation fails with ConflictException. When omitted, the write is unconditional. Every attempt stores a newly generated revision ID, so retrying an unanswered request can conflict with the caller's own earlier attempt; read the policy back and compare it with the one you intended before treating a conflict as another writer's change.

PolicyDocument

: Required: Yes
: Type: string

PolicyName

: Type: string

Which named policy to write. Defaults to "default", the customer-managed policy, when omitted (a write AWS Resource Access Manager makes on the owner's behalf resolves to "AWS_RAM" instead). The two writers are exclusive in both directions — only Resource Access Manager can write "AWS_RAM", and only the bus owner can write "default" — so naming the other party's policy fails with AccessDeniedException. A well-formed name that is neither of the two fails with InvalidInputException.

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Result Syntax

[
    'PolicyName' => '<string>',
    'ResourceArn' => '<string>',
    'RevisionId' => '<string>',
]

Result Details

Members

PolicyName

: Required: Yes
: Type: string

Name of a policy attached to a resource. Valid values: "default" (the customer-managed policy) and "AWS_RAM" (managed exclusively by AWS Resource Access Manager). Any other value is rejected.

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

RevisionId

: Type: string

Absent when the write removed the policy; a removal produces no new revision.

Errors

PolicyLengthExceededException:

The policy document is larger than the account's resource policy size quota, or larger than the service maximum.

AccessDeniedException:

The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.

ResourceNotFoundException:

The resource does not exist.

ThrottlingException:

The request was throttled because it exceeds a request rate limit. Retry the request with backoff.

ConflictException:

InvalidInputException:

A request parameter is missing or not valid.

InternalException:

The request failed because of an internal service error. Retry the request.

ConcurrentModificationException:

Another change to the resource is already in progress. Retry the request.

PublicPolicyException:

The policy was rejected because it would grant public access to the event bus. A statement grants public access when its principal is a wildcard and no condition limits the callers to specific AWS accounts or principals. To fix it, replace the wildcard principal with specific principals, or add a condition that limits the callers to specific AWS accounts. Conditions on event content (events:source, events:detail-type, events:Metadata/*) do not identify the caller and do not make a wildcard principal non-public. Returned only for the "default" policy; the "AWS_RAM" policy is composed by AWS Resource Access Manager and never grants public access.

RevokeResource

$result = $client->revokeResource([/* ... */]);
$promise = $client->revokeResourceAsync([/* ... */]);

Revokes a subscriber or an EventSource. The bus owner calls this to withdraw a misbehaving resource attached to their bus. Revocation is terminal: there is no operation that clears it. A revoked resource refuses mutating operations with InvalidStateException; delete stays available for cleanup.

Parameter Syntax

$result = $client->revokeResource([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

: Required: Yes
: Type: string

ARN of a resource a bus owner can revoke: a subscriber or an EventSource. The pattern is the revocable subset of TaggableResourceArn; buses are not revocable.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members

Arn

: Type: string

ARN of a resource a bus owner can revoke: a subscriber or an EventSource. The pattern is the revocable subset of TaggableResourceArn; buses are not revocable.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or replaces tags on an event bus, subscriber, or event source.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

ARN for an EventBridge resource that supports tagging: event buses, subscribers, and event sources.

Tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

Tags attached to a resource, as key-value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

LimitExceededException:: The request would exceed a service quota for the account.
AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from an event bus, subscriber, or event source.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

ARN for an EventBridge resource that supports tagging: event buses, subscribers, and event sources.

TagKeys

: Required: Yes
: Type: Array of strings

List of tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

UpdateEventBus

$result = $client->updateEventBus([/* ... */]);
$promise = $client->updateEventBusAsync([/* ... */]);

Updates an event bus. The update is asynchronous: the bus moves to UPDATING and returns to ACTIVE when the change is applied. Fields omitted from the request are left unchanged.

Parameter Syntax

$result = $client->updateEventBus([
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KmsKeyIdentifier' => '<string>',
    ],
    'EventBusArn' => '<string>', // REQUIRED
    'StorageConfiguration' => [
        'RetentionPeriodInDays' => <integer>,
    ],
]);

Parameter Details

Members

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EncryptionConfiguration

: Type: EncryptionConfiguration structure

Encryption configuration for an event bus.

EventBusArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

StorageConfiguration

: Type: StorageConfiguration structure

Event storage configuration for an event bus.

Result Syntax

[
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KmsKeyIdentifier' => '<string>',
    ],
    'EventBusArn' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
    'State' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING|ACTIVE|DELETE_FAILED',
    'StateReason' => '<string>',
    'StorageConfiguration' => [
        'RetentionPeriodInDays' => <integer>,
        'RetentionWindowStartTime' => <DateTime>,
    ],
]

Result Details

Members

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EncryptionConfiguration

: Type: EncryptionConfiguration structure

Encryption configuration for an event bus.

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

LastModifiedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event bus was last modified.

Name

: Type: string

State

: Type: string

Lifecycle state of an event bus.

CREATING: Bus creation is in progress.
CREATE_FAILED: Bus creation failed; see StateReason. The bus cannot be recovered or recreated in place: delete it with DeleteEventBus, then create a new bus.
ACTIVE: Bus is fully operational and can accept events.
UPDATING: Bus update is in progress.
UPDATE_FAILED: Bus update failed; the bus remains operational with its previous configuration.
DELETING: Bus deletion is actively in progress.
DELETE_FAILED: Bus deletion failed; see StateReason. Retry DeleteEventBus after removing subscribers and event sources.

StateReason

: Type: string

StorageConfiguration

: Type: StorageConfigurationOutput structure

Event storage configuration of an event bus, as returned on reads.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

UpdateEventSource

$result = $client->updateEventSource([/* ... */]);
$promise = $client->updateEventSourceAsync([/* ... */]);

Updates an EventSource. Fields omitted from the request are left unchanged.

Parameter Syntax

$result = $client->updateEventSource([
    'Configuration' => [
        'AwsServiceEventsConfiguration' => [
            'AwsService' => '<string>', // REQUIRED
            'OnFailureConfiguration' => [
                'Arn' => '<string>',
            ],
            'Pattern' => '<string>',
        ],
        'PartnerEventsConfiguration' => [
            'OnFailureConfiguration' => [
                'Arn' => '<string>',
            ],
            'PartnerBusKmsKeyIdentifier' => '<string>',
            'PartnerEventSourceArn' => '<string>', // REQUIRED
            'Pattern' => '<string>',
        ],
    ],
    'Description' => '<string>',
    'EventSourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Configuration

: Type: EventSourceConfiguration structure

Discriminated EventSource configuration. Exactly one variant must be set.

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EventSourceArn

: Required: Yes
: Type: string

Result Syntax

[
    'EventBusArn' => '<string>',
    'EventSourceArn' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
    'State' => 'CREATING|ACTIVE|UPDATING|CREATE_FAILED|UPDATE_FAILED|DELETING|DELETE_FAILED',
]

Result Details

Members

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

EventSourceArn

: Type: string

LastModifiedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the EventSource was last modified.

Name

: Type: string

State

: Type: string

Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.

Errors

AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

UpdateSubscriber

$result = $client->updateSubscriber([/* ... */]);
$promise = $client->updateSubscriberAsync([/* ... */]);

Updates a subscriber. Fields omitted from the request are left unchanged.

Parameter Syntax

$result = $client->updateSubscriber([
    'BatchConfiguration' => [
        'MaxBatchSize' => <integer>,
        'MaxBatchWindowInSeconds' => <integer>,
    ],
    'Description' => '<string>',
    'FilterConfiguration' => [
        'Filters' => [
            [
                'Pattern' => '<string>', // REQUIRED
                'Scope' => 'DATA|METADATA|SYSTEM_METADATA', // REQUIRED
            ],
            // ...
        ],
        'Language' => 'EVENT_BRIDGE_PATTERN',
    ],
    'InvokeConfiguration' => [
        'EventBusV2Parameters' => [
            'DeduplicationConfiguration' => [
                'DeduplicationType' => 'CONTENT_BASED', // REQUIRED
            ],
            'Metadata' => ['<string>', ...],
            'SystemMetadata' => [
                'DeduplicationId' => '<string>',
                'EventGroupId' => '<string>',
            ],
        ],
        'HttpParameters' => [
            'HeaderParameters' => ['<string>', ...],
            'InvocationTimeoutSeconds' => '<string>',
            'PathParameterValues' => ['<string>', ...],
            'QueryStringParameters' => ['<string>', ...],
        ],
        'KinesisParameters' => [
            'ExplicitHashKey' => '<string>',
            'PartitionKey' => '<string>',
        ],
        'LambdaParameters' => [
            'DurableExecutionName' => '<string>',
            'InvocationTimeoutSeconds' => '<string>',
            'InvocationType' => 'EVENT|REQUEST_RESPONSE',
            'Qualifier' => '<string>',
            'TenantId' => '<string>',
        ],
        'RoleArn' => '<string>', // REQUIRED
        'SnsParameters' => [
            'MessageAttributes' => [
                '<MessageAttributeName>' => [
                    'BinaryValue' => '<string>',
                    'DataType' => '<string>',
                    'StringValue' => '<string>',
                ],
                // ...
            ],
            'MessageDeduplicationId' => '<string>',
            'MessageGroupId' => '<string>',
            'MessageStructure' => '<string>',
            'Subject' => '<string>',
        ],
        'SqsParameters' => [
            'DelaySeconds' => '<string>',
            'MessageAttributes' => [
                '<MessageAttributeName>' => [
                    'BinaryValue' => '<string>',
                    'DataType' => '<string>',
                    'StringValue' => '<string>',
                ],
                // ...
            ],
            'MessageDeduplicationId' => '<string>',
            'MessageGroupId' => '<string>',
            'MessageSystemAttributes' => [
                '<MessageAttributeName>' => [
                    'BinaryValue' => '<string>',
                    'DataType' => '<string>',
                    'StringValue' => '<string>',
                ],
                // ...
            ],
        ],
        'StepFunctionsParameters' => [
            'InvocationTimeoutSeconds' => '<string>',
            'InvocationType' => 'EVENT|REQUEST_RESPONSE',
            'Name' => '<string>',
            'TraceHeader' => '<string>',
        ],
        'UniversalTargetParameters' => [
            'Input' => '<string>', // REQUIRED
            'InvocationTimeoutSeconds' => '<string>',
        ],
    ],
    'LogConfiguration' => [
        'IncludePayload' => 'FULL|ON_ERROR_ONLY',
        'Level' => 'OFF|ERROR|INFO',
    ],
    'OnFailureConfiguration' => [
        'Arn' => '<string>',
    ],
    'ResumePosition' => 'LAST_PROCESSED|LATEST',
    'RetryPolicy' => [
        'MaxEventAgeInSeconds' => <integer>,
        'MaxRetryAttempts' => <integer>,
        'RetryStrategy' => 'ALL',
    ],
    'State' => 'RUNNING|STOPPED',
    'SubscriberArn' => '<string>', // REQUIRED
    'Transformer' => [
        'JsonataConfiguration' => [
            'Expression' => '<string>', // REQUIRED
        ],
        'Type' => 'RAW|WITH_METADATA|JSONATA',
    ],
]);

Parameter Details

Members

BatchConfiguration

: Type: BatchConfiguration structure

Batching configuration for a subscriber.

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

FilterConfiguration

: Type: FilterConfiguration structure

InvokeConfiguration

: Type: UpdateInvokeConfiguration structure

Update-able configuration for how the subscriber invokes its target.

LogConfiguration

: Type: LogConfiguration structure

Log configuration for a subscriber.

OnFailureConfiguration

: Type: OnFailureConfiguration structure

On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.

ResumePosition

: Type: string

Position from which delivery resumes when a subscriber is unpaused. Honored only on an UpdateSubscriber call that transitions State from STOPPED to RUNNING (unpause); ignored on any other call and not accepted on Create. Defaults to LAST_PROCESSED when omitted.

RetryPolicy

: Type: RetryPolicy structure

Retry policy for a subscriber.

State

: Type: string

SubscriberArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

Transformer

: Type: Transformer structure

Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.

Result Syntax

[
    'EventBusArn' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
    'PointInTimeConfiguration' => [
        'EndPoint' => <DateTime>,
        'PointType' => 'HORIZON|TIMESTAMP',
        'StartingPoint' => <DateTime>,
    ],
    'StartingPosition' => 'LATEST|POINT_IN_TIME',
    'State' => 'RUNNING|STOPPED',
    'SubscriberArn' => '<string>',
    'Type' => 'FIFO|UNORDERED',
]

Result Details

Members

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

LastModifiedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the subscriber was last modified.

Name

: Type: string

Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

PointInTimeConfiguration

: Type: PointInTimeConfiguration structure

Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.

StartingPosition

: Type: string

Starting position for a subscriber.

State

: Type: string

SubscriberArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

Type

: Type: string

Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

Errors

LimitExceededException:: The request would exceed a service quota for the account.
AccessDeniedException:: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
ResourceNotFoundException:: The resource does not exist.
ThrottlingException:: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
InvalidInputException:: A request parameter is missing or not valid.
InternalException:: The request failed because of an internal service error. Retry the request.
ConcurrentModificationException:: Another change to the resource is already in progress. Retry the request.
InvalidStateException:: The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

Shapes

AccessDeniedException

Description

The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.

Members

Message

: Type: string

AwsServiceEventsSourceConfiguration

Description

Configuration for forwarding a single AWS service's events from the account's default event bus.

Members

AwsService

: Required: Yes
: Type: string

A single AWS service source identifier, e.g. "aws.s3". Wildcards and lists are rejected.

OnFailureConfiguration

: Type: OnFailureConfiguration structure

The destination for events that could not be forwarded.

Pattern

: Type: string

A filter pattern, as a JSON string, that defines which of the service's events are forwarded to the event bus. Do not include source, account, or region as top-level fields. If no pattern is specified, all events from the service are forwarded.

BatchConfiguration

Description

Batching configuration for a subscriber.

Members

MaxBatchSize

: Type: int

The maximum number of events to include in a single batch delivered to the target. The service delivers up to this many events per batch; fewer may be delivered when the batch window elapses or the target's per-batch limit is smaller. This is a maximum, not a guaranteed count. Valid range is 1-500 (default: 10, or the target API's per-batch maximum). The resolved value applied by the service is returned on read.

MaxBatchWindowInSeconds

: Type: int

The maximum time in seconds to wait for a batch to fill before delivering it to the target. This is a maximum; a batch may be delivered sooner if it reaches MaxBatchSize or another delivery condition is met. Valid range is 0-300 (default: 0, meaning no wait). The resolved value applied by the service is always returned on read.

ConcurrentModificationException

Description

Another change to the resource is already in progress. Retry the request.

Members

Message

: Type: string

ConflictException

Description

Members

Message

: Type: string

ConfluentPublicRegistryConfiguration

Description

Authentication configuration for public Confluent Schema Registry via EventBridge Connection.

Members

ConnectionArn

: Required: Yes
: Type: string

EventBridge Connection ARN that provides API Key or OAuth credentials for the registry.

DeduplicationConfiguration

Description

Deduplication settings for a publish request.

Members

DeduplicationType

: Required: Yes
: Type: string

How duplicate events are detected: by a hash of the event content (CONTENT_BASED). To deduplicate by a caller-supplied token instead, omit DeduplicationConfiguration and set DeduplicationId on each entry.

EncryptionConfiguration

Description

Encryption configuration for an event bus.

Members

KmsKeyIdentifier

: Type: string

Identifier of the AWS KMS customer managed key used to encrypt events: a key ID, key ARN, alias name, or alias ARN. When absent, events are encrypted with an AWS owned key.

EventBusSummary

Description

Summary of an event bus, as returned by ListEventBuses.

Members

CreationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event bus was created.

Description

: Type: string

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

EventBusAccountId

: Type: string

AWS Account Id.

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

LastModifiedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event bus was last modified.

Name

: Type: string

State

: Type: string

Lifecycle state of an event bus.

CREATING: Bus creation is in progress.
CREATE_FAILED: Bus creation failed; see StateReason. The bus cannot be recovered or recreated in place: delete it with DeleteEventBus, then create a new bus.
ACTIVE: Bus is fully operational and can accept events.
UPDATING: Bus update is in progress.
UPDATE_FAILED: Bus update failed; the bus remains operational with its previous configuration.
DELETING: Bus deletion is actively in progress.
DELETE_FAILED: Bus deletion failed; see StateReason. Retry DeleteEventBus after removing subscribers and event sources.

StateReason

: Type: string

EventBusV2Parameters

Description

Parameters for forwarding events to another EventBridge event bus.

Members

DeduplicationConfiguration

: Type: DeduplicationConfiguration structure

Deduplication settings applied to the forwarded events on the downstream bus.

Metadata

: Type: Associative array of custom strings keys (String) to strings

Customer-defined metadata forwarded with each event.

SystemMetadata

: Type: EventBusV2SystemMetadata structure

Customer-controllable system metadata attached to each forwarded event.

EventBusV2SystemMetadata

Description

Customer-controllable system metadata attached to events forwarded to the downstream event bus.

Members

DeduplicationId

: Type: string

Deduplication ID for FIFO deduplication on the downstream bus. Accepts a literal or a JSONata expression.

EventGroupId

: Type: string

Event group ID for FIFO ordering on the downstream bus. Accepts a literal or a JSONata expression.

EventSourceConfiguration

Description

Discriminated EventSource configuration. Exactly one variant must be set.

Members

AwsServiceEventsConfiguration

: Type: AwsServiceEventsSourceConfiguration structure

Configuration for forwarding a single AWS service's events from the account's default event bus.

PartnerEventsConfiguration

: Type: PartnerEventsSourceConfiguration structure

Configuration for forwarding a partner event source's events through a managed partner event bus.

EventSourceSummary

Description

Summary of an EventSource, as returned by ListEventSources.

Members

CreationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the EventSource was created.

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

EventSourceAccountId

: Type: string

AWS Account Id.

EventSourceArn

: Type: string

LastModifiedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the EventSource was last modified.

Name

: Type: string

Revoked

: Type: boolean

True when the bus owner has withdrawn this EventSource. Present only when true, so a bus owner listing EventSources sees at a glance which ones they revoked. See DescribeEventSourceResponse$Revoked.

State

: Type: string

Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.

Type

: Type: string

Origin type of an EventSource: an AWS service's events (AWS_SERVICE_EVENTS) or a partner event source's events (PARTNER_EVENTS).

Filter

Description

A single filter entry within a FilterConfiguration.

Members

Pattern

: Required: Yes
: Type: string

An event pattern, as a JSON string, that selects which events match.

Scope

: Required: Yes
: Type: string

Scope of a filter pattern within a FilterConfiguration.

FilterConfiguration

Description

Members

Filters

: Type: Array of Filter structures

List of filters. An event must match every filter to be delivered.

Language

: Type: string

Defaults to EVENT_BRIDGE_PATTERN when not specified.

HttpParameters

Description

HTTP invocation parameters for subscribers (API Gateway / API Destination). Values are forwarded to the HTTP endpoint.

Members

HeaderParameters

: Type: Associative array of custom strings keys (HeaderKey) to strings

Map of HTTP header names to values, sent with the request to an HTTP target.

InvocationTimeoutSeconds

: Type: string

Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.

PathParameterValues

: Type: Array of strings

Values substituted, in order, for the path-parameter placeholders in an HTTP target's endpoint path.

QueryStringParameters

: Type: Associative array of custom strings keys (QueryStringKey) to strings

: Type: EventBusV2Parameters structure

Parameters for forwarding events to another EventBridge event bus.

HttpParameters

: Type: HttpParameters structure

HTTP invocation parameters for subscribers (API Gateway / API Destination). Values are forwarded to the HTTP endpoint.

KinesisParameters

: Type: KinesisParameters structure

Kinesis Data Streams invocation parameters for subscribers. Values are forwarded to the Kinesis PutRecords API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.partitionKey %}").

LambdaParameters

: Type: LambdaParameters structure

Lambda invocation parameters for subscribers. Values are forwarded to the Lambda Invoke API. Every string member accepts a literal or a JSONata expression (e.g. "{% $events.Data.qualifier %}").

RoleArn

: Required: Yes
: Type: string

IAM role the service assumes to invoke the target. Must belong to the calling account.

SnsParameters

: Type: SnsParameters structure

SNS invocation parameters for subscribers. Values are forwarded to the SNS PublishBatch API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.groupId %}").

SqsParameters

: Type: SqsParameters structure

SQS invocation parameters for subscribers. Values are forwarded to the SQS SendMessageBatch API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.groupId %}").

StepFunctionsParameters

: Type: StepFunctionsParameters structure

Step Functions invocation parameters for subscribers. Values are forwarded to the Step Functions StartExecution or StartSyncExecution API. Every string member accepts a literal or a JSONata expression (e.g. "{% $events.Data.executionName %}").

TargetArn

: Required: Yes
: Type: string

ARN of the target a subscriber invokes. The resource grammar is service-neutral because target services use different separators and the USI form omits region and account.

UniversalTargetParameters

: Type: UniversalTargetParameters structure

Parameters for USI (Universal Service Integration) targets. Used when TargetArn is in the format arn:aws:events:::aws-sdk:{service}:{apiAction}

JsonataConfiguration

Description

JSONata transform settings for a subscriber.

Members

Expression

: Required: Yes
: Type: string

JSONata expression to transform the event. Must be wrapped in {% %} delimiters.

KinesisParameters

Description

Members

ExplicitHashKey

: Type: string

Explicit hash key forwarded to PutRecords unchanged. Accepts JSONata expression.

PartitionKey

: Type: string

Required by PutRecords even when an explicit hash key is supplied. Accepts JSONata expression.

LambdaParameters

Description

Lambda invocation parameters for subscribers. Values are forwarded to the Lambda Invoke API. Every string member accepts a literal or a JSONata expression (e.g. "{% $events.Data.qualifier %}").

Members

DurableExecutionName

: Type: string

Durable execution name. Accepts a JSONata expression.

InvocationTimeoutSeconds

: Type: string

Timeout in seconds for each invocation of the target. String-typed so the value may be a JSONata expression.

InvocationType

: Type: string

Lambda invocation type. EVENT invokes the function asynchronously; REQUEST_RESPONSE waits for its result.

Qualifier

: Type: string

Lambda qualifier: $LATEST, $LATEST.PUBLISHED, a numeric version, or an alias. Accepts a JSONata expression.

TenantId

: Type: string

Tenant identifier. Accepts a JSONata expression.

LimitExceededException

Description

The request would exceed a service quota for the account.

Members

Message

: Type: string

LogConfiguration

Description

Log configuration for a subscriber.

Members

IncludePayload

: Type: string

Whether the customer event payload is embedded in log records. Defaults to ON_ERROR_ONLY.

Level

: Type: string

Minimum log level. Records below this level are not emitted. Defaults to OFF.

OnFailureConfiguration

Description

On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.

Members

Arn

: Type: string

The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.

PartnerEventsSourceConfiguration

Description

Configuration for forwarding a partner event source's events through a managed partner event bus.

Members

OnFailureConfiguration

: Type: OnFailureConfiguration structure

The destination for events that could not be forwarded, covering both the forwarding target and the managed partner event bus.

PartnerBusKmsKeyIdentifier

: Type: string

Identifier of the AWS KMS customer managed key used to encrypt events: a key ID, key ARN, alias name, or alias ARN. When absent, events are encrypted with an AWS owned key.

PartnerEventSourceArn

: Required: Yes
: Type: string

ARN of the partner event source to forward. It is a partner-owned resource, so the account segment is empty: arn:aws:events:::event-source/aws.partner/.

Pattern

: Type: string

A filter pattern, as a JSON string, that defines which of the partner event source's events are forwarded to the event bus. If no pattern is specified, all events from the partner event source are forwarded.

PointInTimeConfiguration

Description

Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.

Members

EndPoint

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp to stop at. Optional.

PointType

: Required: Yes
: Type: string

Whether to start from the horizon or a specific timestamp.

StartingPoint

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp to start from. Required when PointType is TIMESTAMP.

PolicyLengthExceededException

Description

The policy document is larger than the account's resource policy size quota, or larger than the service maximum.

Members

Message

: Type: string

PublicPolicyException

Description

Members

Message

: Type: string

PutEventsRequestEntry

Description

A single event entry in a PutEvents request.

Members

Detail

: Type: string

The event payload, as a valid JSON string.

DetailType

: Required: Yes
: Type: string

Free-form detail-type classifying an event within its source.

Resources

: Type: Array of strings

ARNs of resources the event concerns. Included in the event delivered to subscribers.

Source

: Required: Yes
: Type: string

The source of the event. The aws. value prefix is service-reserved and cannot be used as a value.

SystemMetadata

: Type: PutEventsSystemMetadata structure

System metadata for PutEvents entries. ContentType is not applicable (always application/eventbridge+json, set server-side).

Time

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the event occurred. Defaults to the time the service receives the event when omitted.

PutEventsResultEntry

Description

Result entry for a published event. The position of each entry in the response list aligns 1:1 with the corresponding request entry.

Members

ErrorCode

: Type: string

Error code identifying why a publish batch entry failed.

ErrorMessage

: Type: string

Human-readable explanation of why a publish batch entry failed.

EventId

: Type: string

Unique event ID assigned by the service.

SequenceNumber

: Type: string

Sequence number assigned to the message for ordering within the message group.

SuccessCode

: Type: string

Indicates the outcome for a successfully processed publish entry.

PutEventsSystemMetadata

Description

System metadata for PutEvents entries. ContentType is not applicable (always application/eventbridge+json, set server-side).

Members

DeduplicationId

: Type: string

Deduplication ID for FIFO deduplication.

EventGroupId

: Type: string

Event group ID for FIFO ordering.

PutRawEventsRequestEntry

Description

A single event entry in a raw publish request.

Members

Data

: Required: Yes
: Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The event data as a base64-encoded blob. Supports binary formats.

Metadata

: Type: Associative array of custom strings keys (EventMetadataKey) to strings

Metadata key-value pairs you define. Keys must be 1-128 characters and must not contain "/".

SystemMetadata

: Required: Yes
: Type: PutRawEventsSystemMetadata structure

Structured system metadata with defined properties.

PutRawEventsResultEntry

Description

Result entry for a published event. The position of each entry in the response list aligns 1:1 with the corresponding request entry, enabling co-location by index.

Members

ErrorCode

: Type: string

Error code if the entry failed.

ErrorMessage

: Type: string

Error message if the entry failed.

EventId

: Type: string

Unique event ID assigned by the service. Present on successful entries.

SequenceNumber

: Type: string

Sequence number for ordering within the event group.

SuccessCode

: Type: string

Indicates how the entry was processed. Present only on successful entries.

PutRawEventsSystemMetadata

Description

System metadata for PutRawEvents entries. ContentType is required because PutRawEvents supports arbitrary binary formats.

Members

ContentType

: Required: Yes
: Type: string

Content type of the event data (e.g., "application/cloudevents+json").

DeduplicationId

: Type: string

Deduplication ID for FIFO deduplication.

EventGroupId

: Type: string

: Required: Yes
: Type: string

Name of a policy attached to a resource. Valid values: "default" (the customer-managed policy) and "AWS_RAM" (managed exclusively by AWS Resource Access Manager). Any other value is rejected.

RevisionId

: Required: Yes
: Type: string

Revision ID of a resource policy. A new revision ID is generated on every successful write.

RetryPolicy

Description

Retry policy for a subscriber.

Members

MaxEventAgeInSeconds

: Type: int

Maximum age of an event in seconds before it is discarded (60-86400, default: 300).

MaxRetryAttempts

: Type: int

Maximum number of retry attempts (0-185, default: 5).

RetryStrategy

: Type: string

Strategy for determining which exceptions are retried. Default: ALL.

SchemaRegistryConfiguration

Description

Schema registry settings used to encode open-format (Avro/Protobuf) events.

Members

ConfluentPublicRegistryConfiguration

: Type: ConfluentPublicRegistryConfiguration structure

Required when RegistryUri is an HTTPS URL. Provides Connection-based auth for Confluent Cloud.

RegistryUri

: Required: Yes
: Type: string

Glue Schema Registry ARN, or Confluent Cloud HTTPS URL.

SchemaRegistryUnavailableException

Description

The configured schema registry could not be reached. Retry the request.

Members

Message

: Type: string

SnsMessageAttributeValue

Description

A custom SNS message attribute (data type plus string or binary value).

Members

BinaryValue

: Type: string

Base64-encoded literal binary attribute value.

DataType

: Type: string

Attribute data type. Requiredness and the accepted vocabulary belong to SNS, which rejects an attribute without a data type on delivery.

StringValue

: Type: string

String attribute value. A JSONata expression resolves once per delivered event.

SnsParameters

Description

SNS invocation parameters for subscribers. Values are forwarded to the SNS PublishBatch API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.groupId %}").

Members

MessageAttributes

: Type: Associative array of custom strings keys (MessageAttributeName) to SnsMessageAttributeValue structures

Custom message attributes for SNS filtering.

MessageDeduplicationId

: Type: string

Message deduplication ID for FIFO topics. Accepts JSONata expression.

MessageGroupId

: Type: string

Message group ID for FIFO topics. Accepts JSONata expression.

MessageStructure

: Type: string

Per-protocol message formatting mode, forwarded to SNS Publish unchanged. Accepts JSONata expression.

Subject

: Type: string

Subject line for email protocol subscriptions. Accepts JSONata expression.

SqsMessageAttributeValue

Description

A custom SQS message attribute (data type plus string or binary value).

Members

BinaryValue

: Type: string

Base64-encoded literal binary attribute value.

DataType

: Type: string

Attribute data type. Requiredness, the accepted vocabulary, and any custom label belong to SQS, which rejects an attribute without a data type on delivery.

StringValue

: Type: string

String attribute value. A JSONata expression resolves once per delivered event.

SqsParameters

Description

SQS invocation parameters for subscribers. Values are forwarded to the SQS SendMessageBatch API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.groupId %}").

Members

DelaySeconds

: Type: string

Delay in seconds before the message becomes visible, standard queues only. Accepts JSONata expression.

MessageAttributes

: Type: Associative array of custom strings keys (MessageAttributeName) to SqsMessageAttributeValue structures

Custom message attributes (name/type/value).

MessageDeduplicationId

: Type: string

Message deduplication ID for FIFO queues. Accepts JSONata expression.

MessageGroupId

: Type: string

Message group ID for FIFO queues. Accepts JSONata expression.

MessageSystemAttributes

: Type: Associative array of custom strings keys (MessageAttributeName) to SqsMessageAttributeValue structures

System message attributes (e.g., AWSTraceHeader).

StepFunctionsParameters

Description

Members

InvocationTimeoutSeconds

: Type: string

Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.

InvocationType

: Type: string

Selects StartExecution (EVENT) or StartSyncExecution (REQUEST_RESPONSE) at delivery.

Name

: Type: string

Name for the execution. Must be unique per account/region/state machine. Accepts JSONata expression.

TraceHeader

: Type: string

X-Ray trace header for distributed tracing. Accepts JSONata expression.

StorageConfiguration

Description

Event storage configuration for an event bus.

Members

RetentionPeriodInDays

: Type: int

Number of days events are retained on the event bus.

StorageConfigurationOutput

Description

Event storage configuration of an event bus, as returned on reads.

Members

RetentionPeriodInDays

: Type: int

Number of days events are retained on the event bus.

RetentionWindowStartTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The earliest point in time from which stored events are available. Events older than this have expired from retention.

SubscriberSummary

Description

Summary of a subscriber, as returned by ListSubscribers.

Members

CreationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the subscriber was created.

EventBusArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

LastModifiedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the subscriber was last modified.

Name

: Type: string

Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

Revoked

: Type: boolean

True when the bus owner has revoked this subscriber. Present only when true, so a bus owner listing subscribers sees at a glance which ones they revoked. See DescribeSubscriberResponse$Revoked.

State

: Type: string

SubscriberAccountId

: Type: string

AWS Account Id.

SubscriberArn

: Type: string

The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

TargetArn

: Type: string

ARN of the target a subscriber invokes. The resource grammar is service-neutral because target services use different separators and the USI form omits region and account.

Type

: Type: string

Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

ThrottlingException

Description

The request was throttled because it exceeds a request rate limit. Retry the request with backoff.

Members

Message

: Type: string

Transformer

Description

Transformer configuration for a subscriber.

Members

JsonataConfiguration

: Type: JsonataConfiguration structure

JSONata expression configuration. Required when Type is JSONATA.

Type

: Type: string

Transform type.

UniversalTargetParameters

Description

Parameters for USI (Universal Service Integration) targets. Used when TargetArn is in the format arn:aws:events:::aws-sdk:{service}:{apiAction}

Members

Input

: Required: Yes
: Type: string

JSON string or JSONata expression that produces the API request. Supports {% ... %} JSONata expressions for dynamic values from the event.

InvocationTimeoutSeconds

: Type: string

Timeout in seconds for each invocation of the target (1-30, default 30). Accepts a literal integer or a {% ... %} JSONata expression evaluated against the event at invocation time. A JSONata expression is syntax-checked at create time. Resolved values outside of the range [1, 30] will be constrained to the nearest bound at delivery time. Defaults to 30 seconds when unset.

UpdateInvokeConfiguration

Description

Update-able configuration for how the subscriber invokes its target.

Members

EventBusV2Parameters

: Type: EventBusV2Parameters structure

Parameters for forwarding events to another EventBridge event bus.

HttpParameters

: Type: HttpParameters structure

HTTP invocation parameters for subscribers (API Gateway / API Destination). Values are forwarded to the HTTP endpoint.

KinesisParameters

: Type: KinesisParameters structure

LambdaParameters

: Type: LambdaParameters structure

Lambda invocation parameters for subscribers. Values are forwarded to the Lambda Invoke API. Every string member accepts a literal or a JSONata expression (e.g. "{% $events.Data.qualifier %}").

RoleArn

: Required: Yes
: Type: string

IAM role the service assumes to invoke the target. Must belong to the calling account.

SnsParameters

: Type: SnsParameters structure

SNS invocation parameters for subscribers. Values are forwarded to the SNS PublishBatch API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.groupId %}").

SqsParameters

: Type: SqsParameters structure

SQS invocation parameters for subscribers. Values are forwarded to the SQS SendMessageBatch API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.groupId %}").

StepFunctionsParameters

: Type: StepFunctionsParameters structure

UniversalTargetParameters

: Type: UniversalTargetParameters structure

Parameters for USI (Universal Service Integration) targets. Used when TargetArn is in the format arn:aws:events:::aws-sdk:{service}:{apiAction}

Amazon EventBridgeV2 2025-05-15

Operation Summary

Paginators

Waiters

Operations

CreateEventBus

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateEventSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateSubscriber

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteEventBus

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteEventSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteResourcePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteSubscriber

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeEventBus

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeEventSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeSubscriber

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details