2026/09/24 - Amazon EventBridgeV2 - 25 new api methods
Changes Introducing Amazon EventBridge enhanced Custom event bus, a new shareable event bus for organizational-scale event-driven applications feature ordered delivery, deduplication, open event formats, and cross-account bus sharing.
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.
See also: AWS API Documentation
Request Syntax
client.delete_event_bus(
EventBusArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.list_event_sources(
EventBusArn='string',
NamePrefix='string',
NextToken='string',
MaxResults=123
)
string
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
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.
string
Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.
integer
Maximum number of results to return in one page of a List operation.
dict
Response Syntax
{
'EventSources': [
{
'EventSourceArn': 'string',
'Name': 'string',
'EventBusArn': 'string',
'Type': 'AWS_SERVICE_EVENTS'|'PARTNER_EVENTS',
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'Revoked': True|False,
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'EventSourceAccountId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EventSources (list) --
List of EventSource summaries.
(dict) --
Summary of an EventSource, as returned by ListEventSources.
EventSourceArn (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 (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.
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
Type (string) --
Origin type of an EventSource: an AWS service's events (AWS_SERVICE_EVENTS) or a partner event source's events (PARTNER_EVENTS).
State (string) --
Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.
Revoked (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.
CreationTime (datetime) --
The time the EventSource was created.
LastModifiedTime (datetime) --
The time the EventSource was last modified.
EventSourceAccountId (string) --
AWS Account Id.
NextToken (string) --
Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.
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.
See also: AWS API Documentation
Request Syntax
client.list_subscribers(
EventBusArn='string',
NamePrefix='string',
NextToken='string',
MaxResults=123
)
string
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
string
Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
string
Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.
integer
Maximum number of results to return in one page of a List operation.
dict
Response Syntax
{
'Subscribers': [
{
'SubscriberArn': 'string',
'Name': 'string',
'EventBusArn': 'string',
'TargetArn': 'string',
'Type': 'FIFO'|'UNORDERED',
'Revoked': True|False,
'State': 'RUNNING'|'STOPPED',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'SubscriberAccountId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Subscribers (list) --
List of subscriber summaries.
(dict) --
Summary of a subscriber, as returned by ListSubscribers.
SubscriberArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
Name (string) --
Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
TargetArn (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 (string) --
Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.
Revoked (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 (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.
CreationTime (datetime) --
The time the subscriber was created.
LastModifiedTime (datetime) --
The time the subscriber was last modified.
SubscriberAccountId (string) --
AWS Account Id.
NextToken (string) --
Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.
Returns the full configuration and lifecycle state of an EventSource.
See also: AWS API Documentation
Request Syntax
client.describe_event_source(
EventSourceArn='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{
'EventSourceArn': 'string',
'Name': 'string',
'EventBusArn': 'string',
'Configuration': {
'AwsServiceEventsConfiguration': {
'AwsService': 'string',
'Pattern': 'string',
'OnFailureConfiguration': {
'Arn': 'string'
}
},
'PartnerEventsConfiguration': {
'PartnerEventSourceArn': 'string',
'Pattern': 'string',
'PartnerBusKmsKeyIdentifier': 'string',
'OnFailureConfiguration': {
'Arn': 'string'
}
}
},
'Description': 'string',
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'Revoked': True|False,
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventSourceArn (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 (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.
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
Configuration (dict) --
Discriminated EventSource configuration. Exactly one variant must be set.
AwsServiceEventsConfiguration (dict) --
Configuration for forwarding a single AWS service's events from the account's default event bus.
AwsService (string) --
A single AWS service source identifier, e.g. "aws.s3". Wildcards and lists are rejected.
Pattern (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.
OnFailureConfiguration (dict) --
The destination for events that could not be forwarded.
Arn (string) --
The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.
PartnerEventsConfiguration (dict) --
Configuration for forwarding a partner event source's events through a managed partner event bus.
PartnerEventSourceArn (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 (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.
PartnerBusKmsKeyIdentifier (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.
OnFailureConfiguration (dict) --
The destination for events that could not be forwarded, covering both the forwarding target and the managed partner event bus.
Arn (string) --
The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.
Description (string) --
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
State (string) --
Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.
Revoked (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.
CreationTime (datetime) --
The time the EventSource was created.
LastModifiedTime (datetime) --
The time the EventSource was last modified.
Updates an EventSource. Fields omitted from the request are left unchanged.
See also: AWS API Documentation
Request Syntax
client.update_event_source(
EventSourceArn='string',
Configuration={
'AwsServiceEventsConfiguration': {
'AwsService': 'string',
'Pattern': 'string',
'OnFailureConfiguration': {
'Arn': 'string'
}
},
'PartnerEventsConfiguration': {
'PartnerEventSourceArn': 'string',
'Pattern': 'string',
'PartnerBusKmsKeyIdentifier': 'string',
'OnFailureConfiguration': {
'Arn': 'string'
}
}
},
Description='string'
)
string
[REQUIRED]
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.
dict
Discriminated EventSource configuration. Exactly one variant must be set.
AwsServiceEventsConfiguration (dict) --
Configuration for forwarding a single AWS service's events from the account's default event bus.
AwsService (string) -- [REQUIRED]
A single AWS service source identifier, e.g. "aws.s3". Wildcards and lists are rejected.
Pattern (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.
OnFailureConfiguration (dict) --
The destination for events that could not be forwarded.
Arn (string) --
The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.
PartnerEventsConfiguration (dict) --
Configuration for forwarding a partner event source's events through a managed partner event bus.
PartnerEventSourceArn (string) -- [REQUIRED]
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 (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.
PartnerBusKmsKeyIdentifier (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.
OnFailureConfiguration (dict) --
The destination for events that could not be forwarded, covering both the forwarding target and the managed partner event bus.
Arn (string) --
The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.
string
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
dict
Response Syntax
{
'EventSourceArn': 'string',
'Name': 'string',
'EventBusArn': 'string',
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventSourceArn (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 (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.
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
State (string) --
Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.
LastModifiedTime (datetime) --
The time the EventSource was last modified.
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.
See also: AWS API Documentation
Request Syntax
client.create_event_source(
Name='string',
EventBusArn='string',
Configuration={
'AwsServiceEventsConfiguration': {
'AwsService': 'string',
'Pattern': 'string',
'OnFailureConfiguration': {
'Arn': 'string'
}
},
'PartnerEventsConfiguration': {
'PartnerEventSourceArn': 'string',
'Pattern': 'string',
'PartnerBusKmsKeyIdentifier': 'string',
'OnFailureConfiguration': {
'Arn': 'string'
}
}
},
Description='string',
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
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.
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
dict
[REQUIRED]
Discriminated EventSource configuration. Exactly one variant must be set.
AwsServiceEventsConfiguration (dict) --
Configuration for forwarding a single AWS service's events from the account's default event bus.
AwsService (string) -- [REQUIRED]
A single AWS service source identifier, e.g. "aws.s3". Wildcards and lists are rejected.
Pattern (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.
OnFailureConfiguration (dict) --
The destination for events that could not be forwarded.
Arn (string) --
The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.
PartnerEventsConfiguration (dict) --
Configuration for forwarding a partner event source's events through a managed partner event bus.
PartnerEventSourceArn (string) -- [REQUIRED]
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 (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.
PartnerBusKmsKeyIdentifier (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.
OnFailureConfiguration (dict) --
The destination for events that could not be forwarded, covering both the forwarding target and the managed partner event bus.
Arn (string) --
The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.
string
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
dict
Tags attached to a resource, as key-value pairs.
(string) --
(string) --
string
Unique, case-sensitive identifier that ensures the idempotency of the request. The SDK generates one automatically when the field is omitted.
This field is autopopulated if not provided.
dict
Response Syntax
{
'EventSourceArn': 'string',
'Name': 'string',
'EventBusArn': 'string',
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventSourceArn (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 (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.
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
State (string) --
Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.
CreationTime (datetime) --
The time the EventSource was created.
Returns the named resource policy attached to an event bus. Fails with ResourceNotFoundException when the event bus or the named policy does not exist.
See also: AWS API Documentation
Request Syntax
client.get_resource_policy(
ResourceArn='string',
PolicyName='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
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.
dict
Response Syntax
{
'ResourceArn': 'string',
'PolicyDocument': 'string',
'PolicyName': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
Returned only when the named policy exists. A missing event bus or a missing named policy fails with ResourceNotFoundException rather than returning an empty or null policy document. Every member is therefore always present on a successful response.
ResourceArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
PolicyDocument (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 (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 (string) --
Revision ID of a resource policy. A new revision ID is generated on every successful write.
Lists the tags on an event bus, subscriber, or event source.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
ARN for an EventBridge resource that supports tagging: event buses, subscribers, and event sources.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
Tags attached to a resource, as key-value pairs.
(string) --
(string) --
Returns the full configuration and lifecycle state of an event bus.
See also: AWS API Documentation
Request Syntax
client.describe_event_bus(
EventBusArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
dict
Response Syntax
{
'EventBusArn': 'string',
'Name': 'string',
'Description': 'string',
'EncryptionConfiguration': {
'KmsKeyIdentifier': 'string'
},
'StorageConfiguration': {
'RetentionPeriodInDays': 123,
'RetentionWindowStartTime': datetime(2015, 1, 1)
},
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'State': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ACTIVE'|'DELETE_FAILED',
'StateReason': 'string'
}
Response Structure
(dict) --
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
Name (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.
Description (string) --
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
EncryptionConfiguration (dict) --
Encryption configuration for an event bus.
KmsKeyIdentifier (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.
StorageConfiguration (dict) --
Event storage configuration of an event bus, as returned on reads.
RetentionPeriodInDays (integer) --
Number of days events are retained on the event bus.
RetentionWindowStartTime (datetime) --
The earliest point in time from which stored events are available. Events older than this have expired from retention.
CreationTime (datetime) --
The time the event bus was created.
LastModifiedTime (datetime) --
The time the event bus was last modified.
State (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 (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.
Updates a subscriber. Fields omitted from the request are left unchanged.
See also: AWS API Documentation
Request Syntax
client.update_subscriber(
SubscriberArn='string',
Description='string',
State='RUNNING'|'STOPPED',
ResumePosition='LAST_PROCESSED'|'LATEST',
InvokeConfiguration={
'RoleArn': 'string',
'LambdaParameters': {
'InvocationType': 'EVENT'|'REQUEST_RESPONSE',
'Qualifier': 'string',
'DurableExecutionName': 'string',
'TenantId': 'string',
'InvocationTimeoutSeconds': 'string'
},
'SqsParameters': {
'MessageGroupId': 'string',
'MessageDeduplicationId': 'string',
'DelaySeconds': 'string',
'MessageAttributes': {
'string': {
'DataType': 'string',
'StringValue': 'string',
'BinaryValue': 'string'
}
},
'MessageSystemAttributes': {
'string': {
'DataType': 'string',
'StringValue': 'string',
'BinaryValue': 'string'
}
}
},
'SnsParameters': {
'MessageGroupId': 'string',
'MessageDeduplicationId': 'string',
'Subject': 'string',
'MessageStructure': 'string',
'MessageAttributes': {
'string': {
'DataType': 'string',
'StringValue': 'string',
'BinaryValue': 'string'
}
}
},
'KinesisParameters': {
'PartitionKey': 'string',
'ExplicitHashKey': 'string'
},
'StepFunctionsParameters': {
'InvocationType': 'EVENT'|'REQUEST_RESPONSE',
'Name': 'string',
'TraceHeader': 'string',
'InvocationTimeoutSeconds': 'string'
},
'HttpParameters': {
'PathParameterValues': [
'string',
],
'HeaderParameters': {
'string': 'string'
},
'QueryStringParameters': {
'string': 'string'
},
'InvocationTimeoutSeconds': 'string'
},
'UniversalTargetParameters': {
'Input': 'string',
'InvocationTimeoutSeconds': 'string'
},
'EventBusV2Parameters': {
'Metadata': {
'string': 'string'
},
'SystemMetadata': {
'EventGroupId': 'string',
'DeduplicationId': 'string'
},
'DeduplicationConfiguration': {
'DeduplicationType': 'CONTENT_BASED'
}
}
},
FilterConfiguration={
'Language': 'EVENT_BRIDGE_PATTERN',
'Filters': [
{
'Pattern': 'string',
'Scope': 'DATA'|'METADATA'|'SYSTEM_METADATA'
},
]
},
BatchConfiguration={
'MaxBatchSize': 123,
'MaxBatchWindowInSeconds': 123
},
Transformer={
'Type': 'RAW'|'WITH_METADATA'|'JSONATA',
'JsonataConfiguration': {
'Expression': 'string'
}
},
RetryPolicy={
'MaxRetryAttempts': 123,
'MaxEventAgeInSeconds': 123,
'RetryStrategy': 'ALL'
},
OnFailureConfiguration={
'Arn': 'string'
},
LogConfiguration={
'Level': 'OFF'|'ERROR'|'INFO',
'IncludePayload': 'FULL'|'ON_ERROR_ONLY'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
string
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
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.
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.
dict
Update-able configuration for how the subscriber invokes its target.
RoleArn (string) -- [REQUIRED]
IAM role the service assumes to invoke the target. Must belong to the calling account.
LambdaParameters (dict) --
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 %}").
InvocationType (string) --
Lambda invocation type. EVENT invokes the function asynchronously; REQUEST_RESPONSE waits for its result.
Qualifier (string) --
Lambda qualifier: $LATEST, $LATEST.PUBLISHED, a numeric version, or an alias. Accepts a JSONata expression.
DurableExecutionName (string) --
Durable execution name. Accepts a JSONata expression.
TenantId (string) --
Tenant identifier. Accepts a JSONata expression.
InvocationTimeoutSeconds (string) --
Timeout in seconds for each invocation of the target. String-typed so the value may be a JSONata expression.
SqsParameters (dict) --
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 %}").
MessageGroupId (string) --
Message group ID for FIFO queues. Accepts JSONata expression.
MessageDeduplicationId (string) --
Message deduplication ID for FIFO queues. Accepts JSONata expression.
DelaySeconds (string) --
Delay in seconds before the message becomes visible, standard queues only. Accepts JSONata expression.
MessageAttributes (dict) --
Custom message attributes (name/type/value).
(string) --
Message attribute name. The ceiling is wide enough to hold a JSONata expression, because a name may be a literal or an expression resolved once per delivered event.
(dict) --
A custom SQS message attribute (data type plus string or binary value).
DataType (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 (string) --
String attribute value. A JSONata expression resolves once per delivered event.
BinaryValue (string) --
Base64-encoded literal binary attribute value.
MessageSystemAttributes (dict) --
System message attributes (e.g., AWSTraceHeader).
(string) --
Message attribute name. The ceiling is wide enough to hold a JSONata expression, because a name may be a literal or an expression resolved once per delivered event.
(dict) --
A custom SQS message attribute (data type plus string or binary value).
DataType (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 (string) --
String attribute value. A JSONata expression resolves once per delivered event.
BinaryValue (string) --
Base64-encoded literal binary attribute value.
SnsParameters (dict) --
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 %}").
MessageGroupId (string) --
Message group ID for FIFO topics. Accepts JSONata expression.
MessageDeduplicationId (string) --
Message deduplication ID for FIFO topics. Accepts JSONata expression.
Subject (string) --
Subject line for email protocol subscriptions. Accepts JSONata expression.
MessageStructure (string) --
Per-protocol message formatting mode, forwarded to SNS Publish unchanged. Accepts JSONata expression.
MessageAttributes (dict) --
Custom message attributes for SNS filtering.
(string) --
Message attribute name. The ceiling is wide enough to hold a JSONata expression, because a name may be a literal or an expression resolved once per delivered event.
(dict) --
A custom SNS message attribute (data type plus string or binary value).
DataType (string) --
Attribute data type. Requiredness and the accepted vocabulary belong to SNS, which rejects an attribute without a data type on delivery.
StringValue (string) --
String attribute value. A JSONata expression resolves once per delivered event.
BinaryValue (string) --
Base64-encoded literal binary attribute value.
KinesisParameters (dict) --
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 %}").
PartitionKey (string) --
Required by PutRecords even when an explicit hash key is supplied. Accepts JSONata expression.
ExplicitHashKey (string) --
Explicit hash key forwarded to PutRecords unchanged. Accepts JSONata expression.
StepFunctionsParameters (dict) --
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 %}").
InvocationType (string) --
Selects StartExecution (EVENT) or StartSyncExecution (REQUEST_RESPONSE) at delivery.
Name (string) --
Name for the execution. Must be unique per account/region/state machine. Accepts JSONata expression.
TraceHeader (string) --
X-Ray trace header for distributed tracing. Accepts JSONata expression.
InvocationTimeoutSeconds (string) --
Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.
HttpParameters (dict) --
HTTP invocation parameters for subscribers (API Gateway / API Destination). Values are forwarded to the HTTP endpoint.
PathParameterValues (list) --
Values substituted, in order, for the path-parameter placeholders in an HTTP target's endpoint path.
(string) --
HeaderParameters (dict) --
Map of HTTP header names to values, sent with the request to an HTTP target.
(string) --
(string) --
QueryStringParameters (dict) --
Map of query-string parameter names to values, appended to the request to an HTTP target.
(string) --
(string) --
InvocationTimeoutSeconds (string) --
Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.
UniversalTargetParameters (dict) --
Parameters for USI (Universal Service Integration) targets. Used when TargetArn is in the format arn:aws:events:::aws-sdk:{service}:{apiAction}
Input (string) -- [REQUIRED]
JSON string or JSONata expression that produces the API request. Supports {% ... %} JSONata expressions for dynamic values from the event.
InvocationTimeoutSeconds (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.
EventBusV2Parameters (dict) --
Parameters for forwarding events to another EventBridge event bus.
Metadata (dict) --
Customer-defined metadata forwarded with each event.
(string) --
(string) --
SystemMetadata (dict) --
Customer-controllable system metadata attached to each forwarded event.
EventGroupId (string) --
Event group ID for FIFO ordering on the downstream bus. Accepts a literal or a JSONata expression.
DeduplicationId (string) --
Deduplication ID for FIFO deduplication on the downstream bus. Accepts a literal or a JSONata expression.
DeduplicationConfiguration (dict) --
Deduplication settings applied to the forwarded events on the downstream bus.
DeduplicationType (string) -- [REQUIRED]
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.
dict
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.
Language (string) --
Defaults to EVENT_BRIDGE_PATTERN when not specified.
Filters (list) --
List of filters. An event must match every filter to be delivered.
(dict) --
A single filter entry within a FilterConfiguration.
Pattern (string) -- [REQUIRED]
An event pattern, as a JSON string, that selects which events match.
Scope (string) -- [REQUIRED]
Scope of a filter pattern within a FilterConfiguration.
dict
Batching configuration for a subscriber.
MaxBatchSize (integer) --
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 (integer) --
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.
dict
Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.
Type (string) --
Transform type.
JsonataConfiguration (dict) --
JSONata expression configuration. Required when Type is JSONATA.
Expression (string) -- [REQUIRED]
JSONata expression to transform the event. Must be wrapped in {% %} delimiters.
dict
Retry policy for a subscriber.
MaxRetryAttempts (integer) --
Maximum number of retry attempts (0-185, default: 5).
MaxEventAgeInSeconds (integer) --
Maximum age of an event in seconds before it is discarded (60-86400, default: 300).
RetryStrategy (string) --
Strategy for determining which exceptions are retried. Default: ALL.
dict
On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.
Arn (string) --
The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.
dict
Log configuration for a subscriber.
Level (string) --
Minimum log level. Records below this level are not emitted. Defaults to OFF.
IncludePayload (string) --
Whether the customer event payload is embedded in log records. Defaults to ON_ERROR_ONLY.
dict
Response Syntax
{
'SubscriberArn': 'string',
'Name': 'string',
'EventBusArn': 'string',
'Type': 'FIFO'|'UNORDERED',
'StartingPosition': 'LATEST'|'POINT_IN_TIME',
'PointInTimeConfiguration': {
'PointType': 'HORIZON'|'TIMESTAMP',
'StartingPoint': datetime(2015, 1, 1),
'EndPoint': datetime(2015, 1, 1)
},
'State': 'RUNNING'|'STOPPED',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
SubscriberArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
Name (string) --
Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
Type (string) --
Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.
StartingPosition (string) --
Starting position for a subscriber.
PointInTimeConfiguration (dict) --
Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.
PointType (string) --
Whether to start from the horizon or a specific timestamp.
StartingPoint (datetime) --
Timestamp to start from. Required when PointType is TIMESTAMP.
EndPoint (datetime) --
Timestamp to stop at. Optional.
State (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.
LastModifiedTime (datetime) --
The time the subscriber was last modified.
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.
See also: AWS API Documentation
Request Syntax
client.create_event_bus(
Name='string',
Description='string',
EncryptionConfiguration={
'KmsKeyIdentifier': 'string'
},
StorageConfiguration={
'RetentionPeriodInDays': 123
},
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
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.
string
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
dict
Encryption configuration for an event bus.
KmsKeyIdentifier (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.
dict
Event storage configuration for an event bus.
RetentionPeriodInDays (integer) --
Number of days events are retained on the event bus.
dict
Tags attached to a resource, as key-value pairs.
(string) --
(string) --
string
Unique, case-sensitive identifier that ensures the idempotency of the request. The SDK generates one automatically when the field is omitted.
This field is autopopulated if not provided.
dict
Response Syntax
{
'EventBusArn': 'string',
'Name': 'string',
'Description': 'string',
'EncryptionConfiguration': {
'KmsKeyIdentifier': 'string'
},
'StorageConfiguration': {
'RetentionPeriodInDays': 123,
'RetentionWindowStartTime': datetime(2015, 1, 1)
},
'State': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ACTIVE'|'DELETE_FAILED',
'StateReason': 'string',
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
Name (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.
Description (string) --
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
EncryptionConfiguration (dict) --
Encryption configuration for an event bus.
KmsKeyIdentifier (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.
StorageConfiguration (dict) --
Event storage configuration of an event bus, as returned on reads.
RetentionPeriodInDays (integer) --
Number of days events are retained on the event bus.
RetentionWindowStartTime (datetime) --
The earliest point in time from which stored events are available. Events older than this have expired from retention.
State (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 (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.
CreationTime (datetime) --
The time the event bus was created.
Removes tags from an event bus, subscriber, or event source.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
ARN for an EventBridge resource that supports tagging: event buses, subscribers, and event sources.
list
[REQUIRED]
List of tag keys.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Adds or replaces tags on an event bus, subscriber, or event source.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
ARN for an EventBridge resource that supports tagging: event buses, subscribers, and event sources.
dict
[REQUIRED]
Tags attached to a resource, as key-value pairs.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.update_event_bus(
EventBusArn='string',
Description='string',
EncryptionConfiguration={
'KmsKeyIdentifier': 'string'
},
StorageConfiguration={
'RetentionPeriodInDays': 123
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
string
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
dict
Encryption configuration for an event bus.
KmsKeyIdentifier (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.
dict
Event storage configuration for an event bus.
RetentionPeriodInDays (integer) --
Number of days events are retained on the event bus.
dict
Response Syntax
{
'EventBusArn': 'string',
'Name': 'string',
'Description': 'string',
'EncryptionConfiguration': {
'KmsKeyIdentifier': 'string'
},
'StorageConfiguration': {
'RetentionPeriodInDays': 123,
'RetentionWindowStartTime': datetime(2015, 1, 1)
},
'State': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ACTIVE'|'DELETE_FAILED',
'StateReason': 'string',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
Name (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.
Description (string) --
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
EncryptionConfiguration (dict) --
Encryption configuration for an event bus.
KmsKeyIdentifier (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.
StorageConfiguration (dict) --
Event storage configuration of an event bus, as returned on reads.
RetentionPeriodInDays (integer) --
Number of days events are retained on the event bus.
RetentionWindowStartTime (datetime) --
The earliest point in time from which stored events are available. Events older than this have expired from retention.
State (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 (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.
LastModifiedTime (datetime) --
The time the event bus was last modified.
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.
See also: AWS API Documentation
Request Syntax
client.revoke_resource(
Arn='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{
'Arn': 'string'
}
Response Structure
(dict) --
Arn (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.
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.
See also: AWS API Documentation
Request Syntax
client.list_event_buses(
NamePrefix='string',
EventBusAccountId='string',
NextToken='string',
MaxResults=123
)
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.
string
AWS Account Id.
string
Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.
integer
Maximum number of results to return in one page of a List operation.
dict
Response Syntax
{
'EventBuses': [
{
'Name': 'string',
'EventBusArn': 'string',
'Description': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'State': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ACTIVE'|'DELETE_FAILED',
'StateReason': 'string',
'EventBusAccountId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EventBuses (list) --
List of event bus summaries.
(dict) --
Summary of an event bus, as returned by ListEventBuses.
Name (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.
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
Description (string) --
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
CreationTime (datetime) --
The time the event bus was created.
LastModifiedTime (datetime) --
The time the event bus was last modified.
State (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 (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.
EventBusAccountId (string) --
AWS Account Id.
NextToken (string) --
Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.
Lists the resource policies attached to an event bus as summaries (policy name and revision ID). Use GetResourcePolicy to retrieve a policy document.
See also: AWS API Documentation
Request Syntax
client.list_resource_policies(
ResourceArn='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
string
Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.
integer
Maximum number of results to return in one page of a List operation.
dict
Response Syntax
{
'PolicySummaries': [
{
'PolicyName': 'string',
'RevisionId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Summaries only (policy name and revision ID). Use GetResourcePolicy to retrieve a policy document.
PolicySummaries (list) --
List of resource policy summaries.
(dict) --
Summary of a policy attached to a resource: its name and revision ID.
PolicyName (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 (string) --
Revision ID of a resource policy. A new revision ID is generated on every successful write.
NextToken (string) --
Opaque pagination token returned by a List operation. Pass it back in the next request to retrieve the next page of results.
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.
See also: AWS API Documentation
Request Syntax
client.put_resource_policy(
ResourceArn='string',
PolicyDocument='string',
PolicyName='string',
ExpectedRevisionId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
string
[REQUIRED]
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.
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.
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.
dict
Response Syntax
{
'ResourceArn': 'string',
'PolicyName': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
ResourceArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
PolicyName (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 (string) --
Absent when the write removed the policy; a removal produces no new revision.
Returns the full configuration and state of a subscriber.
See also: AWS API Documentation
Request Syntax
client.describe_subscriber(
SubscriberArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
dict
Response Syntax
{
'SubscriberArn': 'string',
'Name': 'string',
'EventBusArn': 'string',
'InvokeConfiguration': {
'RoleArn': 'string',
'LambdaParameters': {
'InvocationType': 'EVENT'|'REQUEST_RESPONSE',
'Qualifier': 'string',
'DurableExecutionName': 'string',
'TenantId': 'string',
'InvocationTimeoutSeconds': 'string'
},
'SqsParameters': {
'MessageGroupId': 'string',
'MessageDeduplicationId': 'string',
'DelaySeconds': 'string',
'MessageAttributes': {
'string': {
'DataType': 'string',
'StringValue': 'string',
'BinaryValue': 'string'
}
},
'MessageSystemAttributes': {
'string': {
'DataType': 'string',
'StringValue': 'string',
'BinaryValue': 'string'
}
}
},
'SnsParameters': {
'MessageGroupId': 'string',
'MessageDeduplicationId': 'string',
'Subject': 'string',
'MessageStructure': 'string',
'MessageAttributes': {
'string': {
'DataType': 'string',
'StringValue': 'string',
'BinaryValue': 'string'
}
}
},
'KinesisParameters': {
'PartitionKey': 'string',
'ExplicitHashKey': 'string'
},
'StepFunctionsParameters': {
'InvocationType': 'EVENT'|'REQUEST_RESPONSE',
'Name': 'string',
'TraceHeader': 'string',
'InvocationTimeoutSeconds': 'string'
},
'HttpParameters': {
'PathParameterValues': [
'string',
],
'HeaderParameters': {
'string': 'string'
},
'QueryStringParameters': {
'string': 'string'
},
'InvocationTimeoutSeconds': 'string'
},
'UniversalTargetParameters': {
'Input': 'string',
'InvocationTimeoutSeconds': 'string'
},
'EventBusV2Parameters': {
'Metadata': {
'string': 'string'
},
'SystemMetadata': {
'EventGroupId': 'string',
'DeduplicationId': 'string'
},
'DeduplicationConfiguration': {
'DeduplicationType': 'CONTENT_BASED'
}
},
'TargetArn': 'string'
},
'Description': 'string',
'FilterConfiguration': {
'Language': 'EVENT_BRIDGE_PATTERN',
'Filters': [
{
'Pattern': 'string',
'Scope': 'DATA'|'METADATA'|'SYSTEM_METADATA'
},
]
},
'Type': 'FIFO'|'UNORDERED',
'StartingPosition': 'LATEST'|'POINT_IN_TIME',
'PointInTimeConfiguration': {
'PointType': 'HORIZON'|'TIMESTAMP',
'StartingPoint': datetime(2015, 1, 1),
'EndPoint': datetime(2015, 1, 1)
},
'BatchConfiguration': {
'MaxBatchSize': 123,
'MaxBatchWindowInSeconds': 123
},
'Transformer': {
'Type': 'RAW'|'WITH_METADATA'|'JSONATA',
'JsonataConfiguration': {
'Expression': 'string'
}
},
'RetryPolicy': {
'MaxRetryAttempts': 123,
'MaxEventAgeInSeconds': 123,
'RetryStrategy': 'ALL'
},
'OnFailureConfiguration': {
'Arn': 'string'
},
'LogConfiguration': {
'Level': 'OFF'|'ERROR'|'INFO',
'IncludePayload': 'FULL'|'ON_ERROR_ONLY'
},
'State': 'RUNNING'|'STOPPED',
'Revoked': True|False,
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
SubscriberArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
Name (string) --
Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
InvokeConfiguration (dict) --
Configuration for how the subscriber invokes its target.
RoleArn (string) --
IAM role the service assumes to invoke the target. Must belong to the calling account.
LambdaParameters (dict) --
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 %}").
InvocationType (string) --
Lambda invocation type. EVENT invokes the function asynchronously; REQUEST_RESPONSE waits for its result.
Qualifier (string) --
Lambda qualifier: $LATEST, $LATEST.PUBLISHED, a numeric version, or an alias. Accepts a JSONata expression.
DurableExecutionName (string) --
Durable execution name. Accepts a JSONata expression.
TenantId (string) --
Tenant identifier. Accepts a JSONata expression.
InvocationTimeoutSeconds (string) --
Timeout in seconds for each invocation of the target. String-typed so the value may be a JSONata expression.
SqsParameters (dict) --
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 %}").
MessageGroupId (string) --
Message group ID for FIFO queues. Accepts JSONata expression.
MessageDeduplicationId (string) --
Message deduplication ID for FIFO queues. Accepts JSONata expression.
DelaySeconds (string) --
Delay in seconds before the message becomes visible, standard queues only. Accepts JSONata expression.
MessageAttributes (dict) --
Custom message attributes (name/type/value).
(string) --
Message attribute name. The ceiling is wide enough to hold a JSONata expression, because a name may be a literal or an expression resolved once per delivered event.
(dict) --
A custom SQS message attribute (data type plus string or binary value).
DataType (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 (string) --
String attribute value. A JSONata expression resolves once per delivered event.
BinaryValue (string) --
Base64-encoded literal binary attribute value.
MessageSystemAttributes (dict) --
System message attributes (e.g., AWSTraceHeader).
(string) --
Message attribute name. The ceiling is wide enough to hold a JSONata expression, because a name may be a literal or an expression resolved once per delivered event.
(dict) --
A custom SQS message attribute (data type plus string or binary value).
DataType (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 (string) --
String attribute value. A JSONata expression resolves once per delivered event.
BinaryValue (string) --
Base64-encoded literal binary attribute value.
SnsParameters (dict) --
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 %}").
MessageGroupId (string) --
Message group ID for FIFO topics. Accepts JSONata expression.
MessageDeduplicationId (string) --
Message deduplication ID for FIFO topics. Accepts JSONata expression.
Subject (string) --
Subject line for email protocol subscriptions. Accepts JSONata expression.
MessageStructure (string) --
Per-protocol message formatting mode, forwarded to SNS Publish unchanged. Accepts JSONata expression.
MessageAttributes (dict) --
Custom message attributes for SNS filtering.
(string) --
Message attribute name. The ceiling is wide enough to hold a JSONata expression, because a name may be a literal or an expression resolved once per delivered event.
(dict) --
A custom SNS message attribute (data type plus string or binary value).
DataType (string) --
Attribute data type. Requiredness and the accepted vocabulary belong to SNS, which rejects an attribute without a data type on delivery.
StringValue (string) --
String attribute value. A JSONata expression resolves once per delivered event.
BinaryValue (string) --
Base64-encoded literal binary attribute value.
KinesisParameters (dict) --
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 %}").
PartitionKey (string) --
Required by PutRecords even when an explicit hash key is supplied. Accepts JSONata expression.
ExplicitHashKey (string) --
Explicit hash key forwarded to PutRecords unchanged. Accepts JSONata expression.
StepFunctionsParameters (dict) --
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 %}").
InvocationType (string) --
Selects StartExecution (EVENT) or StartSyncExecution (REQUEST_RESPONSE) at delivery.
Name (string) --
Name for the execution. Must be unique per account/region/state machine. Accepts JSONata expression.
TraceHeader (string) --
X-Ray trace header for distributed tracing. Accepts JSONata expression.
InvocationTimeoutSeconds (string) --
Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.
HttpParameters (dict) --
HTTP invocation parameters for subscribers (API Gateway / API Destination). Values are forwarded to the HTTP endpoint.
PathParameterValues (list) --
Values substituted, in order, for the path-parameter placeholders in an HTTP target's endpoint path.
(string) --
HeaderParameters (dict) --
Map of HTTP header names to values, sent with the request to an HTTP target.
(string) --
(string) --
QueryStringParameters (dict) --
Map of query-string parameter names to values, appended to the request to an HTTP target.
(string) --
(string) --
InvocationTimeoutSeconds (string) --
Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.
UniversalTargetParameters (dict) --
Parameters for USI (Universal Service Integration) targets. Used when TargetArn is in the format arn:aws:events:::aws-sdk:{service}:{apiAction}
Input (string) --
JSON string or JSONata expression that produces the API request. Supports {% ... %} JSONata expressions for dynamic values from the event.
InvocationTimeoutSeconds (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.
EventBusV2Parameters (dict) --
Parameters for forwarding events to another EventBridge event bus.
Metadata (dict) --
Customer-defined metadata forwarded with each event.
(string) --
(string) --
SystemMetadata (dict) --
Customer-controllable system metadata attached to each forwarded event.
EventGroupId (string) --
Event group ID for FIFO ordering on the downstream bus. Accepts a literal or a JSONata expression.
DeduplicationId (string) --
Deduplication ID for FIFO deduplication on the downstream bus. Accepts a literal or a JSONata expression.
DeduplicationConfiguration (dict) --
Deduplication settings applied to the forwarded events on the downstream bus.
DeduplicationType (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.
TargetArn (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.
Description (string) --
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
FilterConfiguration (dict) --
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.
Language (string) --
Defaults to EVENT_BRIDGE_PATTERN when not specified.
Filters (list) --
List of filters. An event must match every filter to be delivered.
(dict) --
A single filter entry within a FilterConfiguration.
Pattern (string) --
An event pattern, as a JSON string, that selects which events match.
Scope (string) --
Scope of a filter pattern within a FilterConfiguration.
Type (string) --
Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.
StartingPosition (string) --
Starting position for a subscriber.
PointInTimeConfiguration (dict) --
Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.
PointType (string) --
Whether to start from the horizon or a specific timestamp.
StartingPoint (datetime) --
Timestamp to start from. Required when PointType is TIMESTAMP.
EndPoint (datetime) --
Timestamp to stop at. Optional.
BatchConfiguration (dict) --
Batching configuration for a subscriber.
MaxBatchSize (integer) --
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 (integer) --
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.
Transformer (dict) --
Absent for universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input.
Type (string) --
Transform type.
JsonataConfiguration (dict) --
JSONata expression configuration. Required when Type is JSONATA.
Expression (string) --
JSONata expression to transform the event. Must be wrapped in {% %} delimiters.
RetryPolicy (dict) --
Retry policy for a subscriber.
MaxRetryAttempts (integer) --
Maximum number of retry attempts (0-185, default: 5).
MaxEventAgeInSeconds (integer) --
Maximum age of an event in seconds before it is discarded (60-86400, default: 300).
RetryStrategy (string) --
Strategy for determining which exceptions are retried. Default: ALL.
OnFailureConfiguration (dict) --
On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.
Arn (string) --
The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.
LogConfiguration (dict) --
Log configuration for a subscriber.
Level (string) --
Minimum log level. Records below this level are not emitted. Defaults to OFF.
IncludePayload (string) --
Whether the customer event payload is embedded in log records. Defaults to ON_ERROR_ONLY.
State (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.
Revoked (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.
CreationTime (datetime) --
The time the subscriber was created.
LastModifiedTime (datetime) --
The time the subscriber was last modified.
Publishes events to an event bus.
See also: AWS API Documentation
Request Syntax
client.put_events(
EventBusArn='string',
Entries=[
{
'Source': 'string',
'DetailType': 'string',
'Detail': 'string',
'Resources': [
'string',
],
'Time': datetime(2015, 1, 1),
'SystemMetadata': {
'EventGroupId': 'string',
'DeduplicationId': 'string'
}
},
],
DeduplicationConfiguration={
'DeduplicationType': 'CONTENT_BASED'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
list
[REQUIRED]
List of event entries to publish. Must contain at least one entry.
(dict) --
A single event entry in a PutEvents request.
Source (string) -- [REQUIRED]
The source of the event. The aws. value prefix is service-reserved and cannot be used as a value.
DetailType (string) -- [REQUIRED]
Free-form detail-type classifying an event within its source.
Detail (string) --
The event payload, as a valid JSON string.
Resources (list) --
ARNs of resources the event concerns. Included in the event delivered to subscribers.
(string) --
Time (datetime) --
The time the event occurred. Defaults to the time the service receives the event when omitted.
SystemMetadata (dict) --
System metadata for PutEvents entries. ContentType is not applicable (always application/eventbridge+json, set server-side).
EventGroupId (string) --
Event group ID for FIFO ordering.
DeduplicationId (string) --
Deduplication ID for FIFO deduplication.
dict
Request-level deduplication settings, applied to every entry in the batch.
DeduplicationType (string) -- [REQUIRED]
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.
dict
Response Syntax
{
'FailedEntryCount': 123,
'Entries': [
{
'EventId': 'string',
'SequenceNumber': 'string',
'SuccessCode': 'PUBLISHED'|'DEDUPLICATED',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
FailedEntryCount (integer) --
The number of entries in the batch that failed to be published.
Entries (list) --
List of per-entry publish results, in the same order as the request entries.
(dict) --
Result entry for a published event. The position of each entry in the response list aligns 1:1 with the corresponding request entry.
EventId (string) --
Unique event ID assigned by the service.
SequenceNumber (string) --
Sequence number assigned to the message for ordering within the message group.
SuccessCode (string) --
Indicates the outcome for a successfully processed publish entry.
ErrorCode (string) --
Error code identifying why a publish batch entry failed.
ErrorMessage (string) --
Human-readable explanation of why a publish batch entry failed.
Deletes a subscriber. Events are no longer delivered to its target.
See also: AWS API Documentation
Request Syntax
client.delete_subscriber(
SubscriberArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes an EventSource. Forwarding from its origin stops.
See also: AWS API Documentation
Request Syntax
client.delete_event_source(
EventSourceArn='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes the named resource policy attached to an event bus.
See also: AWS API Documentation
Request Syntax
client.delete_resource_policy(
ResourceArn='string',
PolicyName='string',
ExpectedRevisionId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
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.
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.
dict
Response Syntax
{
'RevisionId': 'string'
}
Response Structure
(dict) --
RevisionId (string) --
Revision ID of the policy that was deleted. Absent when no policy was deleted.
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.
See also: AWS API Documentation
Request Syntax
client.create_subscriber(
Name='string',
EventBusArn='string',
InvokeConfiguration={
'RoleArn': 'string',
'LambdaParameters': {
'InvocationType': 'EVENT'|'REQUEST_RESPONSE',
'Qualifier': 'string',
'DurableExecutionName': 'string',
'TenantId': 'string',
'InvocationTimeoutSeconds': 'string'
},
'SqsParameters': {
'MessageGroupId': 'string',
'MessageDeduplicationId': 'string',
'DelaySeconds': 'string',
'MessageAttributes': {
'string': {
'DataType': 'string',
'StringValue': 'string',
'BinaryValue': 'string'
}
},
'MessageSystemAttributes': {
'string': {
'DataType': 'string',
'StringValue': 'string',
'BinaryValue': 'string'
}
}
},
'SnsParameters': {
'MessageGroupId': 'string',
'MessageDeduplicationId': 'string',
'Subject': 'string',
'MessageStructure': 'string',
'MessageAttributes': {
'string': {
'DataType': 'string',
'StringValue': 'string',
'BinaryValue': 'string'
}
}
},
'KinesisParameters': {
'PartitionKey': 'string',
'ExplicitHashKey': 'string'
},
'StepFunctionsParameters': {
'InvocationType': 'EVENT'|'REQUEST_RESPONSE',
'Name': 'string',
'TraceHeader': 'string',
'InvocationTimeoutSeconds': 'string'
},
'HttpParameters': {
'PathParameterValues': [
'string',
],
'HeaderParameters': {
'string': 'string'
},
'QueryStringParameters': {
'string': 'string'
},
'InvocationTimeoutSeconds': 'string'
},
'UniversalTargetParameters': {
'Input': 'string',
'InvocationTimeoutSeconds': 'string'
},
'EventBusV2Parameters': {
'Metadata': {
'string': 'string'
},
'SystemMetadata': {
'EventGroupId': 'string',
'DeduplicationId': 'string'
},
'DeduplicationConfiguration': {
'DeduplicationType': 'CONTENT_BASED'
}
},
'TargetArn': 'string'
},
Description='string',
FilterConfiguration={
'Language': 'EVENT_BRIDGE_PATTERN',
'Filters': [
{
'Pattern': 'string',
'Scope': 'DATA'|'METADATA'|'SYSTEM_METADATA'
},
]
},
Type='FIFO'|'UNORDERED',
StartingPosition='LATEST'|'POINT_IN_TIME',
PointInTimeConfiguration={
'PointType': 'HORIZON'|'TIMESTAMP',
'StartingPoint': datetime(2015, 1, 1),
'EndPoint': datetime(2015, 1, 1)
},
BatchConfiguration={
'MaxBatchSize': 123,
'MaxBatchWindowInSeconds': 123
},
Transformer={
'Type': 'RAW'|'WITH_METADATA'|'JSONATA',
'JsonataConfiguration': {
'Expression': 'string'
}
},
RetryPolicy={
'MaxRetryAttempts': 123,
'MaxEventAgeInSeconds': 123,
'RetryStrategy': 'ALL'
},
OnFailureConfiguration={
'Arn': 'string'
},
LogConfiguration={
'Level': 'OFF'|'ERROR'|'INFO',
'IncludePayload': 'FULL'|'ON_ERROR_ONLY'
},
State='RUNNING'|'STOPPED',
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
dict
[REQUIRED]
Configuration for how the subscriber invokes its target.
RoleArn (string) -- [REQUIRED]
IAM role the service assumes to invoke the target. Must belong to the calling account.
LambdaParameters (dict) --
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 %}").
InvocationType (string) --
Lambda invocation type. EVENT invokes the function asynchronously; REQUEST_RESPONSE waits for its result.
Qualifier (string) --
Lambda qualifier: $LATEST, $LATEST.PUBLISHED, a numeric version, or an alias. Accepts a JSONata expression.
DurableExecutionName (string) --
Durable execution name. Accepts a JSONata expression.
TenantId (string) --
Tenant identifier. Accepts a JSONata expression.
InvocationTimeoutSeconds (string) --
Timeout in seconds for each invocation of the target. String-typed so the value may be a JSONata expression.
SqsParameters (dict) --
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 %}").
MessageGroupId (string) --
Message group ID for FIFO queues. Accepts JSONata expression.
MessageDeduplicationId (string) --
Message deduplication ID for FIFO queues. Accepts JSONata expression.
DelaySeconds (string) --
Delay in seconds before the message becomes visible, standard queues only. Accepts JSONata expression.
MessageAttributes (dict) --
Custom message attributes (name/type/value).
(string) --
Message attribute name. The ceiling is wide enough to hold a JSONata expression, because a name may be a literal or an expression resolved once per delivered event.
(dict) --
A custom SQS message attribute (data type plus string or binary value).
DataType (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 (string) --
String attribute value. A JSONata expression resolves once per delivered event.
BinaryValue (string) --
Base64-encoded literal binary attribute value.
MessageSystemAttributes (dict) --
System message attributes (e.g., AWSTraceHeader).
(string) --
Message attribute name. The ceiling is wide enough to hold a JSONata expression, because a name may be a literal or an expression resolved once per delivered event.
(dict) --
A custom SQS message attribute (data type plus string or binary value).
DataType (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 (string) --
String attribute value. A JSONata expression resolves once per delivered event.
BinaryValue (string) --
Base64-encoded literal binary attribute value.
SnsParameters (dict) --
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 %}").
MessageGroupId (string) --
Message group ID for FIFO topics. Accepts JSONata expression.
MessageDeduplicationId (string) --
Message deduplication ID for FIFO topics. Accepts JSONata expression.
Subject (string) --
Subject line for email protocol subscriptions. Accepts JSONata expression.
MessageStructure (string) --
Per-protocol message formatting mode, forwarded to SNS Publish unchanged. Accepts JSONata expression.
MessageAttributes (dict) --
Custom message attributes for SNS filtering.
(string) --
Message attribute name. The ceiling is wide enough to hold a JSONata expression, because a name may be a literal or an expression resolved once per delivered event.
(dict) --
A custom SNS message attribute (data type plus string or binary value).
DataType (string) --
Attribute data type. Requiredness and the accepted vocabulary belong to SNS, which rejects an attribute without a data type on delivery.
StringValue (string) --
String attribute value. A JSONata expression resolves once per delivered event.
BinaryValue (string) --
Base64-encoded literal binary attribute value.
KinesisParameters (dict) --
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 %}").
PartitionKey (string) --
Required by PutRecords even when an explicit hash key is supplied. Accepts JSONata expression.
ExplicitHashKey (string) --
Explicit hash key forwarded to PutRecords unchanged. Accepts JSONata expression.
StepFunctionsParameters (dict) --
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 %}").
InvocationType (string) --
Selects StartExecution (EVENT) or StartSyncExecution (REQUEST_RESPONSE) at delivery.
Name (string) --
Name for the execution. Must be unique per account/region/state machine. Accepts JSONata expression.
TraceHeader (string) --
X-Ray trace header for distributed tracing. Accepts JSONata expression.
InvocationTimeoutSeconds (string) --
Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.
HttpParameters (dict) --
HTTP invocation parameters for subscribers (API Gateway / API Destination). Values are forwarded to the HTTP endpoint.
PathParameterValues (list) --
Values substituted, in order, for the path-parameter placeholders in an HTTP target's endpoint path.
(string) --
HeaderParameters (dict) --
Map of HTTP header names to values, sent with the request to an HTTP target.
(string) --
(string) --
QueryStringParameters (dict) --
Map of query-string parameter names to values, appended to the request to an HTTP target.
(string) --
(string) --
InvocationTimeoutSeconds (string) --
Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.
UniversalTargetParameters (dict) --
Parameters for USI (Universal Service Integration) targets. Used when TargetArn is in the format arn:aws:events:::aws-sdk:{service}:{apiAction}
Input (string) -- [REQUIRED]
JSON string or JSONata expression that produces the API request. Supports {% ... %} JSONata expressions for dynamic values from the event.
InvocationTimeoutSeconds (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.
EventBusV2Parameters (dict) --
Parameters for forwarding events to another EventBridge event bus.
Metadata (dict) --
Customer-defined metadata forwarded with each event.
(string) --
(string) --
SystemMetadata (dict) --
Customer-controllable system metadata attached to each forwarded event.
EventGroupId (string) --
Event group ID for FIFO ordering on the downstream bus. Accepts a literal or a JSONata expression.
DeduplicationId (string) --
Deduplication ID for FIFO deduplication on the downstream bus. Accepts a literal or a JSONata expression.
DeduplicationConfiguration (dict) --
Deduplication settings applied to the forwarded events on the downstream bus.
DeduplicationType (string) -- [REQUIRED]
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.
TargetArn (string) -- [REQUIRED]
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.
string
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
dict
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.
Language (string) --
Defaults to EVENT_BRIDGE_PATTERN when not specified.
Filters (list) --
List of filters. An event must match every filter to be delivered.
(dict) --
A single filter entry within a FilterConfiguration.
Pattern (string) -- [REQUIRED]
An event pattern, as a JSON string, that selects which events match.
Scope (string) -- [REQUIRED]
Scope of a filter pattern within a FilterConfiguration.
string
Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.
string
Starting position for a subscriber.
dict
Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.
PointType (string) -- [REQUIRED]
Whether to start from the horizon or a specific timestamp.
StartingPoint (datetime) --
Timestamp to start from. Required when PointType is TIMESTAMP.
EndPoint (datetime) --
Timestamp to stop at. Optional.
dict
Batching configuration for a subscriber.
MaxBatchSize (integer) --
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 (integer) --
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.
dict
Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.
Type (string) --
Transform type.
JsonataConfiguration (dict) --
JSONata expression configuration. Required when Type is JSONATA.
Expression (string) -- [REQUIRED]
JSONata expression to transform the event. Must be wrapped in {% %} delimiters.
dict
Retry policy for a subscriber.
MaxRetryAttempts (integer) --
Maximum number of retry attempts (0-185, default: 5).
MaxEventAgeInSeconds (integer) --
Maximum age of an event in seconds before it is discarded (60-86400, default: 300).
RetryStrategy (string) --
Strategy for determining which exceptions are retried. Default: ALL.
dict
On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.
Arn (string) --
The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.
dict
Log configuration for a subscriber.
Level (string) --
Minimum log level. Records below this level are not emitted. Defaults to OFF.
IncludePayload (string) --
Whether the customer event payload is embedded in log records. Defaults to ON_ERROR_ONLY.
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.
dict
Tags attached to a resource, as key-value pairs.
(string) --
(string) --
string
Unique, case-sensitive identifier that ensures the idempotency of the request. The SDK generates one automatically when the field is omitted.
This field is autopopulated if not provided.
dict
Response Syntax
{
'SubscriberArn': 'string',
'Name': 'string',
'EventBusArn': 'string',
'Type': 'FIFO'|'UNORDERED',
'StartingPosition': 'LATEST'|'POINT_IN_TIME',
'PointInTimeConfiguration': {
'PointType': 'HORIZON'|'TIMESTAMP',
'StartingPoint': datetime(2015, 1, 1),
'EndPoint': datetime(2015, 1, 1)
},
'State': 'RUNNING'|'STOPPED',
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
SubscriberArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
Name (string) --
Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.
EventBusArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
Type (string) --
Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.
StartingPosition (string) --
Starting position for a subscriber.
PointInTimeConfiguration (dict) --
Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.
PointType (string) --
Whether to start from the horizon or a specific timestamp.
StartingPoint (datetime) --
Timestamp to start from. Required when PointType is TIMESTAMP.
EndPoint (datetime) --
Timestamp to stop at. Optional.
State (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.
CreationTime (datetime) --
The time the subscriber was created.
Publishes pre-shaped events to an event bus.
See also: AWS API Documentation
Request Syntax
client.put_raw_events(
EventBusArn='string',
Entries=[
{
'Data': b'bytes',
'Metadata': {
'string': 'string'
},
'SystemMetadata': {
'ContentType': 'string',
'DeduplicationId': 'string',
'EventGroupId': 'string'
}
},
],
SchemaRegistryConfiguration={
'RegistryUri': 'string',
'ConfluentPublicRegistryConfiguration': {
'ConnectionArn': 'string'
}
},
DeduplicationConfiguration={
'DeduplicationType': 'CONTENT_BASED'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
list
[REQUIRED]
List of event entries to publish. Must contain at least one entry.
(dict) --
A single event entry in a raw publish request.
Data (bytes) -- [REQUIRED]
The event data as a base64-encoded blob. Supports binary formats.
Metadata (dict) --
Metadata key-value pairs you define. Keys must be 1-128 characters and must not contain "/".
(string) --
Customer-defined metadata field name. Must be 1-128 characters and must not contain "/".
(string) --
Customer-defined metadata field value.
SystemMetadata (dict) -- [REQUIRED]
Structured system metadata with defined properties.
ContentType (string) -- [REQUIRED]
Content type of the event data (e.g., "application/cloudevents+json").
DeduplicationId (string) --
Deduplication ID for FIFO deduplication.
EventGroupId (string) --
Event group ID for FIFO ordering.
dict
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.
RegistryUri (string) -- [REQUIRED]
Glue Schema Registry ARN, or Confluent Cloud HTTPS URL.
ConfluentPublicRegistryConfiguration (dict) --
Required when RegistryUri is an HTTPS URL. Provides Connection-based auth for Confluent Cloud.
ConnectionArn (string) -- [REQUIRED]
EventBridge Connection ARN that provides API Key or OAuth credentials for the registry.
dict
Request-level deduplication settings, applied to every entry in the batch.
DeduplicationType (string) -- [REQUIRED]
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.
dict
Response Syntax
{
'FailedEntryCount': 123,
'Entries': [
{
'EventId': 'string',
'SequenceNumber': 'string',
'SuccessCode': 'PUBLISHED'|'DEDUPLICATED',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
FailedEntryCount (integer) --
The number of entries in the batch that failed to be published.
Entries (list) --
List of per-entry publish results, in the same order as the request entries.
(dict) --
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.
EventId (string) --
Unique event ID assigned by the service. Present on successful entries.
SequenceNumber (string) --
Sequence number for ordering within the event group.
SuccessCode (string) --
Indicates how the entry was processed. Present only on successful entries.
ErrorCode (string) --
Error code if the entry failed.
ErrorMessage (string) --
Error message if the entry failed.