2026/11/19 - Amazon EventBridgeV2 - 1 new 7 updated api methods
Changes This release adds Webhook event sources, which receive events from third-party providers over HTTPS and authenticate them with a static token, HTTP Basic authentication, or an HMAC signature, and Amazon MSK subscribers, which deliver events to a topic in an Amazon MSK and MSK Serverless cluster.
Sets a new credential on a webhook EventSource. If you supply Credential, EventBridge uses that value. Otherwise, EventBridge generates one. For HTTP Basic authentication, only the password changes. The username does not change. EventBridge never returns the credential. To read a generated value, call secretsmanager:GetSecretValue on the secret that SecretArn identifies.
You can rotate the credential of an EventSource in the ACTIVE, UPDATING, or UPDATE_FAILED state. For a revoked EventSource or an EventSource in any other state, EventBridge returns InvalidStateException. EventBridge also returns InvalidStateException if the secret of the EventSource is scheduled for deletion or has been deleted.
If you rotate the credential of one EventSource too many times in 24 hours, EventBridge returns LimitExceededException. Retry later. The limit becomes available again automatically.
If AWS Secrets Manager throttles the call, EventBridge returns ThrottlingException. Retry later.
To use this operation, you must have the following permissions in your IAM policy:
secretsmanager:PutSecretValue on the secret of the EventSource
secretsmanager:GetSecretValue on the secret of the EventSource, for HTTP Basic authentication only
kms:GenerateDataKey and kms:Decrypt on the AWS KMS key that encrypts the secret
The resource policy of the secret must not deny the secretsmanager actions.
EventBridge accepts the new credential when this call returns. In rare cases, the new credential takes up to 2 minutes to reach every EventBridge endpoint.
EventBridge also accepts the previous credential for 15 minutes after the rotation. The window ends at the CreatedDate of the AWSCURRENT secret version plus 15 minutes. Only the credential that the most recent rotation replaced stays valid. If you rotate again within 15 minutes, the older credential stops working immediately.
A retry with the same ClientToken within 8 hours returns the same result and does not rotate again. A retry of a rotation that supplied a value can arrive after a later rotation completed. In that case, the retried value becomes the current credential, and the credential it replaces does not stay valid.
See also: AWS API Documentation
Request Syntax
client.rotate_webhook_credentials(
EventSourceArn='string',
Credential={
'StaticTokenSecretValue': 'string',
'BasicHttpPassword': 'string',
'HmacSecretValue': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
The ARN of the webhook EventSource.
dict
The new credential. Set the member that matches the authentication type of the EventSource. If you set a member that does not match the authentication type, EventBridge returns InvalidInputException. If you omit Credential, EventBridge generates a value.
StaticTokenSecretValue (string) --
The new token for static token authentication.
BasicHttpPassword (string) --
The new password for HTTP Basic authentication. The username does not change.
HmacSecretValue (string) --
The new HMAC secret, in the SecretEncoding of the EventSource. With BASE64, EventBridge removes a leading "whsec_". The key must be 16 to 512 bytes; with BASE64 SecretEncoding, this is measured after decoding.
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
{
'SecretArn': 'string'
}
Response Structure
(dict) --
SecretArn (string) --
The ARN of the AWS Secrets Manager secret that holds the credential. It doesn't change when the credential is rotated.
{'Configuration': {'WebhookEventsConfiguration': {'AuthConfiguration': {'BasicHttpAuthConfiguration': {'Password': 'string',
'Username': 'string'},
'HmacAuthConfiguration': {'Algorithm': 'SHA256 '
'| '
'SHA1',
'Delimiter': 'string',
'Encoding': 'HEX '
'| '
'BASE64',
'MessageIdHttpHeader': 'string',
'SecretEncoding': 'RAW '
'| '
'BASE64',
'SecretValue': 'string',
'SignatureHttpHeader': 'string',
'SignaturePrefix': 'string',
'SignedMessageComposition': 'BODY '
'| '
'TIMESTAMP_DOT_BODY '
'| '
'MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY',
'TimestampHttpHeader': 'string',
'TimestampPrefix': 'string',
'TimestampToleranceInSeconds': 'integer'},
'StaticTokenAuthConfiguration': {'SecretValue': 'string',
'TokenHttpHeader': 'string'}},
'DeduplicationConfiguration': {'DeduplicationType': 'CONTENT_BASED'},
'KmsKeyIdentifier': 'string',
'LogConfiguration': {'IncludePayload': 'FULL '
'| '
'ON_ERROR_ONLY',
'Level': 'OFF '
'| '
'ERROR '
'| '
'INFO'},
'MetadataHttpHeaders': ['string'],
'RoleArn': 'string'}}}
Response {'EventSourceDetails': {'WebhookDetails': {'SecretArn': 'string',
'WebhookUrl': 'string'}}}
Creates an EventSource, which forwards events from an origin (an AWS service, a partner, or a third-party webhook provider) to an event bus. The event bus must be in the ACTIVE state. This operation is idempotent: retries that use the same ClientToken return the same result.
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'
}
},
'WebhookEventsConfiguration': {
'AuthConfiguration': {
'StaticTokenAuthConfiguration': {
'TokenHttpHeader': 'string',
'SecretValue': 'string'
},
'BasicHttpAuthConfiguration': {
'Username': 'string',
'Password': 'string'
},
'HmacAuthConfiguration': {
'Algorithm': 'SHA256'|'SHA1',
'Encoding': 'HEX'|'BASE64',
'SignatureHttpHeader': 'string',
'SignaturePrefix': 'string',
'Delimiter': 'string',
'TimestampHttpHeader': 'string',
'TimestampPrefix': 'string',
'TimestampToleranceInSeconds': 123,
'MessageIdHttpHeader': 'string',
'SignedMessageComposition': 'BODY'|'TIMESTAMP_DOT_BODY'|'MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY',
'SecretValue': 'string',
'SecretEncoding': 'RAW'|'BASE64'
}
},
'KmsKeyIdentifier': 'string',
'RoleArn': 'string',
'MetadataHttpHeaders': [
'string',
],
'DeduplicationConfiguration': {
'DeduplicationType': 'CONTENT_BASED'
},
'LogConfiguration': {
'Level': 'OFF'|'ERROR'|'INFO',
'IncludePayload': 'FULL'|'ON_ERROR_ONLY'
}
}
},
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/<type>/<name>/<id>), 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:<region>::event-source/aws.partner/<name>.
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.
WebhookEventsConfiguration (dict) --
Configuration for receiving events that a third-party provider sends to an HTTPS webhook URL.
AuthConfiguration (dict) -- [REQUIRED]
How the provider authenticates its requests. Exactly one authentication type must be set, and it can't be changed after the EventSource is created.
StaticTokenAuthConfiguration (dict) --
The provider sends a static token in an HTTP header.
TokenHttpHeader (string) -- [REQUIRED]
The name of the header that carries the secret, for example X-Webhook-Secret. Reserved names are rejected: the names EventBridge's edge writes, such as Host and the X-Forwarded-* family, and the hop-by-hop and framing names an HTTP intermediary may rewrite, such as Connection and Content-Length. Authorization is allowed.
SecretValue (string) --
The token the provider sends in the header. If you omit it, EventBridge generates one. EventBridge stores the token only in AWS Secrets Manager and never returns it, including from DescribeEventSource. EventBridge compares it against the entire header value, so a provider that sends Authorization: Bearer <token> needs SecretValue to include the "Bearer " prefix.
BasicHttpAuthConfiguration (dict) --
The provider uses HTTP Basic authentication.
Username (string) --
The username.
Password (string) --
The password.
HmacAuthConfiguration (dict) --
The provider signs each request with an HMAC of the secret.
Algorithm (string) -- [REQUIRED]
The hash algorithm the provider uses to compute the signature.
Encoding (string) -- [REQUIRED]
How the provider encodes the signature in the header.
SignatureHttpHeader (string) -- [REQUIRED]
The name of the header that carries the signature, for example X-Hub-Signature-256. When TimestampHttpHeader names the same header, Delimiter, SignaturePrefix and TimestampPrefix are all required. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.
SignaturePrefix (string) --
The text that precedes the signature in the header value, for example sha256=. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.
Delimiter (string) --
The separator between parts of the signature header value, for example a comma for a header value of t=1727816400,v1=<signature>, or a space when the header carries several signatures. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.
TimestampHttpHeader (string) --
The name of the header that carries the request timestamp. Required when SignedMessageComposition is TIMESTAMP_DOT_BODY or MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY, or when TimestampToleranceInSeconds is set. Not allowed when SignedMessageComposition is BODY, because BODY does not sign the timestamp. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.
TimestampPrefix (string) --
The text that precedes the timestamp in the header value, for example t=. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.
TimestampToleranceInSeconds (integer) --
The maximum difference, in seconds, allowed between the request timestamp and the time EventBridge receives the request. Requests outside this window are rejected. The default is 300 seconds. Requires TimestampHttpHeader. Not allowed when SignedMessageComposition is BODY, because BODY does not sign the timestamp.
MessageIdHttpHeader (string) --
The name of the header that carries the message ID. Required when SignedMessageComposition is MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY. Requests whose message ID contains a period (.) are rejected. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.
SignedMessageComposition (string) -- [REQUIRED]
How the provider assembles the message it signs from the request.
BODY - The request body alone. BODY provides no replay protection.
TIMESTAMP_DOT_BODY - <timestamp>.<body>. Requires TimestampHttpHeader.
MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY - <messageId>.<timestamp>.<body>, as in the Standard Webhooks specification. Requires TimestampHttpHeader and MessageIdHttpHeader.
SecretValue (string) --
The signing key shared with the provider. If you omit it, EventBridge generates one. EventBridge stores the key only in AWS Secrets Manager and never returns it, including from DescribeEventSource. The key must be 16 to 512 bytes; with BASE64 SecretEncoding, this is measured after decoding.
SecretEncoding (string) --
How the secret is encoded. RAW uses the secret's characters as the signing key. BASE64 decodes the secret first, as providers that follow the Standard Webhooks specification require. The default is RAW.
KmsKeyIdentifier (string) --
Optional. The AWS KMS key that encrypts the EventSource's secret in AWS Secrets Manager. Omit it to encrypt the secret with the AWS managed key aws/secretsmanager. A key you supply must be an enabled customer managed key in your account and Region. Changing it re-encrypts the secret under the new key. The previous key can still decrypt the stored versions until the credential is next rotated.
RoleArn (string) -- [REQUIRED]
IAM role the service assumes to put the webhook's events on the event bus. Must belong to the calling account.
MetadataHttpHeaders (list) --
The HTTP request headers to add to each event's metadata, up to 20. Header names are case-insensitive and can't repeat. Each header is added under its lowercase name. Omit the list to add no headers. Headers that carry credentials or that describe the network path, and the header that carries the static token, can't be listed.
(string) --
The name of an HTTP request header to add to event metadata. Must be a valid header name as defined in RFC 7230.
DeduplicationConfiguration (dict) --
Optional. Deduplicates this EventSource's events on the event bus. Omit it to deduplicate nothing.
DeduplicationType (string) -- [REQUIRED]
How duplicate events are detected.
LogConfiguration (dict) --
Optional. Controls the log records EventBridge delivers for this EventSource's webhook requests. Omit it to deliver no logs. Logs are delivered to the destinations you configure with Amazon CloudWatch Logs vended log delivery.
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
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',
'EventSourceDetails': {
'WebhookDetails': {
'WebhookUrl': 'string',
'SecretArn': 'string'
}
},
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventSourceArn (string) --
EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events, webhook for webhook 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/<type>/<name>/<id>), 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.
EventSourceDetails (dict) --
Values EventBridge generated for this EventSource type, such as a webhook's URL and the ARN of its secret. Absent for EventSource types that have no generated values.
WebhookDetails (dict) --
Values generated for a webhook EventSource.
WebhookUrl (string) --
The HTTPS URL to configure in the provider. The URL doesn't change for the life of the EventSource.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret, in your account, that holds the secret.
CreationTime (datetime) --
The time the EventSource was created.
{'InvokeConfiguration': {'MskParameters': {'Acks': 'ALL | LEADER',
'ClientId': 'string',
'Compression': 'NONE | GZIP | '
'SNAPPY | LZ4 | ZSTD',
'Connectivity': 'PUBLIC | PRIVATE',
'Headers': [{'Key': 'string',
'Value': 'string'}],
'PartitionKey': 'string',
'TopicName': 'string'}}}
Response {'SubscriberDetails': {'MskDetails': {'ConnectivityState': 'PROVISIONING | '
'PROVISION_FAILED | '
'ACTIVE',
'StateReason': 'string',
'VpcConnectionArn': 'string'}}}
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. A subscriber that targets an Amazon MSK cluster provisions its connectivity asynchronously after this call returns and begins delivering when its ConnectivityState reaches ACTIVE (see the MskSubscriberActive waiter).
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'
}
},
'MskParameters': {
'TopicName': 'string',
'Compression': 'NONE'|'GZIP'|'SNAPPY'|'LZ4'|'ZSTD',
'Acks': 'ALL'|'LEADER',
'PartitionKey': 'string',
'Headers': [
{
'Key': 'string',
'Value': 'string'
},
],
'ClientId': 'string',
'Connectivity': 'PUBLIC'|'PRIVATE'
},
'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). Must be a literal integer; JSONata expressions are not supported for this field. String-typed to match the other targets' timeout fields. Defaults to 30s 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.
MskParameters (dict) --
MSK (Apache Kafka) invocation parameters for subscribers targeting an Amazon MSK cluster.
TopicName (string) -- [REQUIRED]
Name of the Kafka topic events are produced to. Accepts a literal or a JSONata expression resolved once per delivered event.
Compression (string) --
Producer compression codec applied to the record batch. Defaults to NONE.
Acks (string) --
Producer acknowledgement mode. Defaults to ALL.
PartitionKey (string) --
Kafka record key. Accepts a literal or a JSONata expression (e.g. "{% $events.data.customerId %}") resolved once per delivered event; the resolved value selects the destination partition. If you omit it, the producer selects the partition; on an ordered (FIFO) subscriber, EventBridge instead uses the event group ID as the record key to preserve ordering.
Headers (list) --
Kafka record headers attached to each produced record.
(dict) --
A single Kafka record header. Both Key and Value accept a literal or a JSONata expression (e.g. "{% $events.metadata.source %}") resolved once per delivered event.
Key (string) -- [REQUIRED]
The header key. Accepts a literal or a JSONata expression.
Value (string) --
The header value. Accepts a literal or a JSONata expression.
ClientId (string) --
Producer client.id passed to the Kafka broker. Identifies the producer in broker-side logs, metrics, and quota enforcement. A literal, not a JSONata expression: it is a connection-level setting resolved once when the producer is created, not per event. If you do not set it, EventBridge uses the subscriber ARN.
Connectivity (string) -- [REQUIRED]
How the service connects to the cluster. A cluster can have public access and multi-VPC private connectivity turned on at the same time, so the subscriber names the one to use. That path must be turned on, with IAM access control, on the cluster.
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
Transformer configuration for a subscriber.
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),
'SubscriberDetails': {
'MskDetails': {
'ConnectivityState': 'PROVISIONING'|'PROVISION_FAILED'|'ACTIVE',
'StateReason': 'string',
'VpcConnectionArn': 'string'
}
}
}
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.
SubscriberDetails (dict) --
Values EventBridge manages for a subscriber that depend on its target type. Only the member for the subscriber's target type is set. Returned in responses only; the customer never supplies these values.
MskDetails (dict) --
Values EventBridge manages for a subscriber that targets an Amazon MSK cluster.
ConnectivityState (string) --
Provisioning state of the connectivity EventBridge sets up to the cluster. Distinct from the subscriber's State, which the customer controls.
StateReason (string) --
Why provisioning failed. Present only when ConnectivityState is PROVISION_FAILED.
VpcConnectionArn (string) --
ARN of the VPC connection EventBridge uses to reach the cluster. Present only for PRIVATE connectivity, once the connection exists. It is the connection the cluster owner sees through the MSK ListClientVpcConnections API.
{'Configuration': {'WebhookEventsConfiguration': {'AuthConfiguration': {'BasicHttpAuthConfiguration': {'Password': 'string',
'Username': 'string'},
'HmacAuthConfiguration': {'Algorithm': 'SHA256 '
'| '
'SHA1',
'Delimiter': 'string',
'Encoding': 'HEX '
'| '
'BASE64',
'MessageIdHttpHeader': 'string',
'SecretEncoding': 'RAW '
'| '
'BASE64',
'SecretValue': 'string',
'SignatureHttpHeader': 'string',
'SignaturePrefix': 'string',
'SignedMessageComposition': 'BODY '
'| '
'TIMESTAMP_DOT_BODY '
'| '
'MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY',
'TimestampHttpHeader': 'string',
'TimestampPrefix': 'string',
'TimestampToleranceInSeconds': 'integer'},
'StaticTokenAuthConfiguration': {'SecretValue': 'string',
'TokenHttpHeader': 'string'}},
'DeduplicationConfiguration': {'DeduplicationType': 'CONTENT_BASED'},
'KmsKeyIdentifier': 'string',
'LogConfiguration': {'IncludePayload': 'FULL '
'| '
'ON_ERROR_ONLY',
'Level': 'OFF '
'| '
'ERROR '
'| '
'INFO'},
'MetadataHttpHeaders': ['string'],
'RoleArn': 'string'}},
'EventSourceDetails': {'WebhookDetails': {'SecretArn': 'string',
'WebhookUrl': 'string'}}}
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/<type>/<name>/<id>. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events, webhook for webhook 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'
}
},
'WebhookEventsConfiguration': {
'AuthConfiguration': {
'StaticTokenAuthConfiguration': {
'TokenHttpHeader': 'string',
'SecretValue': 'string'
},
'BasicHttpAuthConfiguration': {
'Username': 'string',
'Password': 'string'
},
'HmacAuthConfiguration': {
'Algorithm': 'SHA256'|'SHA1',
'Encoding': 'HEX'|'BASE64',
'SignatureHttpHeader': 'string',
'SignaturePrefix': 'string',
'Delimiter': 'string',
'TimestampHttpHeader': 'string',
'TimestampPrefix': 'string',
'TimestampToleranceInSeconds': 123,
'MessageIdHttpHeader': 'string',
'SignedMessageComposition': 'BODY'|'TIMESTAMP_DOT_BODY'|'MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY',
'SecretValue': 'string',
'SecretEncoding': 'RAW'|'BASE64'
}
},
'KmsKeyIdentifier': 'string',
'RoleArn': 'string',
'MetadataHttpHeaders': [
'string',
],
'DeduplicationConfiguration': {
'DeduplicationType': 'CONTENT_BASED'
},
'LogConfiguration': {
'Level': 'OFF'|'ERROR'|'INFO',
'IncludePayload': 'FULL'|'ON_ERROR_ONLY'
}
}
},
'Description': 'string',
'State': 'CREATING'|'ACTIVE'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'Revoked': True|False,
'EventSourceDetails': {
'WebhookDetails': {
'WebhookUrl': 'string',
'SecretArn': 'string'
}
},
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventSourceArn (string) --
EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events, webhook for webhook 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/<type>/<name>/<id>), 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:<region>::event-source/aws.partner/<name>.
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.
WebhookEventsConfiguration (dict) --
Configuration for receiving events that a third-party provider sends to an HTTPS webhook URL.
AuthConfiguration (dict) --
How the provider authenticates its requests. Exactly one authentication type must be set, and it can't be changed after the EventSource is created.
StaticTokenAuthConfiguration (dict) --
The provider sends a static token in an HTTP header.
TokenHttpHeader (string) --
The name of the header that carries the secret, for example X-Webhook-Secret. Reserved names are rejected: the names EventBridge's edge writes, such as Host and the X-Forwarded-* family, and the hop-by-hop and framing names an HTTP intermediary may rewrite, such as Connection and Content-Length. Authorization is allowed.
SecretValue (string) --
The token the provider sends in the header. If you omit it, EventBridge generates one. EventBridge stores the token only in AWS Secrets Manager and never returns it, including from DescribeEventSource. EventBridge compares it against the entire header value, so a provider that sends Authorization: Bearer <token> needs SecretValue to include the "Bearer " prefix.
BasicHttpAuthConfiguration (dict) --
The provider uses HTTP Basic authentication.
Username (string) --
The username.
Password (string) --
The password.
HmacAuthConfiguration (dict) --
The provider signs each request with an HMAC of the secret.
Algorithm (string) --
The hash algorithm the provider uses to compute the signature.
Encoding (string) --
How the provider encodes the signature in the header.
SignatureHttpHeader (string) --
The name of the header that carries the signature, for example X-Hub-Signature-256. When TimestampHttpHeader names the same header, Delimiter, SignaturePrefix and TimestampPrefix are all required. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.
SignaturePrefix (string) --
The text that precedes the signature in the header value, for example sha256=. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.
Delimiter (string) --
The separator between parts of the signature header value, for example a comma for a header value of t=1727816400,v1=<signature>, or a space when the header carries several signatures. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.
TimestampHttpHeader (string) --
The name of the header that carries the request timestamp. Required when SignedMessageComposition is TIMESTAMP_DOT_BODY or MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY, or when TimestampToleranceInSeconds is set. Not allowed when SignedMessageComposition is BODY, because BODY does not sign the timestamp. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.
TimestampPrefix (string) --
The text that precedes the timestamp in the header value, for example t=. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.
TimestampToleranceInSeconds (integer) --
The maximum difference, in seconds, allowed between the request timestamp and the time EventBridge receives the request. Requests outside this window are rejected. The default is 300 seconds. Requires TimestampHttpHeader. Not allowed when SignedMessageComposition is BODY, because BODY does not sign the timestamp.
MessageIdHttpHeader (string) --
The name of the header that carries the message ID. Required when SignedMessageComposition is MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY. Requests whose message ID contains a period (.) are rejected. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.
SignedMessageComposition (string) --
How the provider assembles the message it signs from the request.
BODY - The request body alone. BODY provides no replay protection.
TIMESTAMP_DOT_BODY - <timestamp>.<body>. Requires TimestampHttpHeader.
MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY - <messageId>.<timestamp>.<body>, as in the Standard Webhooks specification. Requires TimestampHttpHeader and MessageIdHttpHeader.
SecretValue (string) --
The signing key shared with the provider. If you omit it, EventBridge generates one. EventBridge stores the key only in AWS Secrets Manager and never returns it, including from DescribeEventSource. The key must be 16 to 512 bytes; with BASE64 SecretEncoding, this is measured after decoding.
SecretEncoding (string) --
How the secret is encoded. RAW uses the secret's characters as the signing key. BASE64 decodes the secret first, as providers that follow the Standard Webhooks specification require. The default is RAW.
KmsKeyIdentifier (string) --
Optional. The AWS KMS key that encrypts the EventSource's secret in AWS Secrets Manager. Omit it to encrypt the secret with the AWS managed key aws/secretsmanager. A key you supply must be an enabled customer managed key in your account and Region. Changing it re-encrypts the secret under the new key. The previous key can still decrypt the stored versions until the credential is next rotated.
RoleArn (string) --
IAM role the service assumes to put the webhook's events on the event bus. Must belong to the calling account.
MetadataHttpHeaders (list) --
The HTTP request headers to add to each event's metadata, up to 20. Header names are case-insensitive and can't repeat. Each header is added under its lowercase name. Omit the list to add no headers. Headers that carry credentials or that describe the network path, and the header that carries the static token, can't be listed.
(string) --
The name of an HTTP request header to add to event metadata. Must be a valid header name as defined in RFC 7230.
DeduplicationConfiguration (dict) --
Optional. Deduplicates this EventSource's events on the event bus. Omit it to deduplicate nothing.
DeduplicationType (string) --
How duplicate events are detected.
LogConfiguration (dict) --
Optional. Controls the log records EventBridge delivers for this EventSource's webhook requests. Omit it to deliver no logs. Logs are delivered to the destinations you configure with Amazon CloudWatch Logs vended log delivery.
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.
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.
EventSourceDetails (dict) --
Values EventBridge generated for this EventSource type, such as a webhook's URL and the ARN of its secret. Absent for EventSource types that have no generated values.
WebhookDetails (dict) --
Values generated for a webhook EventSource.
WebhookUrl (string) --
The HTTPS URL to configure in the provider. The URL doesn't change for the life of the EventSource.
SecretArn (string) --
The ARN of the AWS Secrets Manager secret, in your account, that holds the secret.
CreationTime (datetime) --
The time the EventSource was created.
LastModifiedTime (datetime) --
The time the EventSource was last modified.
{'InvokeConfiguration': {'MskParameters': {'Acks': 'ALL | LEADER',
'ClientId': 'string',
'Compression': 'NONE | GZIP | '
'SNAPPY | LZ4 | ZSTD',
'Connectivity': 'PUBLIC | PRIVATE',
'Headers': [{'Key': 'string',
'Value': 'string'}],
'PartitionKey': 'string',
'TopicName': 'string'}},
'SubscriberDetails': {'MskDetails': {'ConnectivityState': 'PROVISIONING | '
'PROVISION_FAILED | '
'ACTIVE',
'StateReason': 'string',
'VpcConnectionArn': 'string'}}}
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'
}
},
'MskParameters': {
'TopicName': 'string',
'Compression': 'NONE'|'GZIP'|'SNAPPY'|'LZ4'|'ZSTD',
'Acks': 'ALL'|'LEADER',
'PartitionKey': 'string',
'Headers': [
{
'Key': 'string',
'Value': 'string'
},
],
'ClientId': 'string',
'Connectivity': 'PUBLIC'|'PRIVATE'
},
'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),
'SubscriberDetails': {
'MskDetails': {
'ConnectivityState': 'PROVISIONING'|'PROVISION_FAILED'|'ACTIVE',
'StateReason': 'string',
'VpcConnectionArn': 'string'
}
}
}
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). Must be a literal integer; JSONata expressions are not supported for this field. String-typed to match the other targets' timeout fields. Defaults to 30s 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.
MskParameters (dict) --
MSK (Apache Kafka) invocation parameters for subscribers targeting an Amazon MSK cluster.
TopicName (string) --
Name of the Kafka topic events are produced to. Accepts a literal or a JSONata expression resolved once per delivered event.
Compression (string) --
Producer compression codec applied to the record batch. Defaults to NONE.
Acks (string) --
Producer acknowledgement mode. Defaults to ALL.
PartitionKey (string) --
Kafka record key. Accepts a literal or a JSONata expression (e.g. "{% $events.data.customerId %}") resolved once per delivered event; the resolved value selects the destination partition. If you omit it, the producer selects the partition; on an ordered (FIFO) subscriber, EventBridge instead uses the event group ID as the record key to preserve ordering.
Headers (list) --
Kafka record headers attached to each produced record.
(dict) --
A single Kafka record header. Both Key and Value accept a literal or a JSONata expression (e.g. "{% $events.metadata.source %}") resolved once per delivered event.
Key (string) --
The header key. Accepts a literal or a JSONata expression.
Value (string) --
The header value. Accepts a literal or a JSONata expression.
ClientId (string) --
Producer client.id passed to the Kafka broker. Identifies the producer in broker-side logs, metrics, and quota enforcement. A literal, not a JSONata expression: it is a connection-level setting resolved once when the producer is created, not per event. If you do not set it, EventBridge uses the subscriber ARN.
Connectivity (string) --
How the service connects to the cluster. A cluster can have public access and multi-VPC private connectivity turned on at the same time, so the subscriber names the one to use. That path must be turned on, with IAM access control, on the cluster.
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) --
Transformer configuration for a subscriber.
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.
SubscriberDetails (dict) --
Values EventBridge manages for a subscriber that depend on its target type. Only the member for the subscriber's target type is set. Returned in responses only; the customer never supplies these values.
MskDetails (dict) --
Values EventBridge manages for a subscriber that targets an Amazon MSK cluster.
ConnectivityState (string) --
Provisioning state of the connectivity EventBridge sets up to the cluster. Distinct from the subscriber's State, which the customer controls.
StateReason (string) --
Why provisioning failed. Present only when ConnectivityState is PROVISION_FAILED.
VpcConnectionArn (string) --
ARN of the VPC connection EventBridge uses to reach the cluster. Present only for PRIVATE connectivity, once the connection exists. It is the connection the cluster owner sees through the MSK ListClientVpcConnections API.
{'EventSources': {'Type': {'WEBHOOK_EVENTS'}}}
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/<type>/<name>/<id>), 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'|'WEBHOOK_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/<type>/<name>/<id>. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events, webhook for webhook 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/<type>/<name>/<id>), 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.
AWS_SERVICE_EVENTS - Events from an AWS service.
PARTNER_EVENTS - Events from a partner event source.
WEBHOOK_EVENTS - Events that a third-party provider sends to a webhook URL.
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.
{'Configuration': {'WebhookEventsConfiguration': {'AuthConfiguration': {'BasicHttpAuthConfiguration': {'Password': 'string',
'Username': 'string'},
'HmacAuthConfiguration': {'Algorithm': 'SHA256 '
'| '
'SHA1',
'Delimiter': 'string',
'Encoding': 'HEX '
'| '
'BASE64',
'MessageIdHttpHeader': 'string',
'SecretEncoding': 'RAW '
'| '
'BASE64',
'SecretValue': 'string',
'SignatureHttpHeader': 'string',
'SignaturePrefix': 'string',
'SignedMessageComposition': 'BODY '
'| '
'TIMESTAMP_DOT_BODY '
'| '
'MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY',
'TimestampHttpHeader': 'string',
'TimestampPrefix': 'string',
'TimestampToleranceInSeconds': 'integer'},
'StaticTokenAuthConfiguration': {'SecretValue': 'string',
'TokenHttpHeader': 'string'}},
'DeduplicationConfiguration': {'DeduplicationType': 'CONTENT_BASED'},
'KmsKeyIdentifier': 'string',
'LogConfiguration': {'IncludePayload': 'FULL '
'| '
'ON_ERROR_ONLY',
'Level': 'OFF '
'| '
'ERROR '
'| '
'INFO'},
'MetadataHttpHeaders': ['string'],
'RoleArn': 'string'}}}
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'
}
},
'WebhookEventsConfiguration': {
'AuthConfiguration': {
'StaticTokenAuthConfiguration': {
'TokenHttpHeader': 'string',
'SecretValue': 'string'
},
'BasicHttpAuthConfiguration': {
'Username': 'string',
'Password': 'string'
},
'HmacAuthConfiguration': {
'Algorithm': 'SHA256'|'SHA1',
'Encoding': 'HEX'|'BASE64',
'SignatureHttpHeader': 'string',
'SignaturePrefix': 'string',
'Delimiter': 'string',
'TimestampHttpHeader': 'string',
'TimestampPrefix': 'string',
'TimestampToleranceInSeconds': 123,
'MessageIdHttpHeader': 'string',
'SignedMessageComposition': 'BODY'|'TIMESTAMP_DOT_BODY'|'MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY',
'SecretValue': 'string',
'SecretEncoding': 'RAW'|'BASE64'
}
},
'KmsKeyIdentifier': 'string',
'RoleArn': 'string',
'MetadataHttpHeaders': [
'string',
],
'DeduplicationConfiguration': {
'DeduplicationType': 'CONTENT_BASED'
},
'LogConfiguration': {
'Level': 'OFF'|'ERROR'|'INFO',
'IncludePayload': 'FULL'|'ON_ERROR_ONLY'
}
}
},
Description='string'
)
string
[REQUIRED]
EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events, webhook for webhook 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:<region>::event-source/aws.partner/<name>.
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.
WebhookEventsConfiguration (dict) --
Configuration for receiving events that a third-party provider sends to an HTTPS webhook URL.
AuthConfiguration (dict) -- [REQUIRED]
How the provider authenticates its requests. Exactly one authentication type must be set, and it can't be changed after the EventSource is created.
StaticTokenAuthConfiguration (dict) --
The provider sends a static token in an HTTP header.
TokenHttpHeader (string) -- [REQUIRED]
The name of the header that carries the secret, for example X-Webhook-Secret. Reserved names are rejected: the names EventBridge's edge writes, such as Host and the X-Forwarded-* family, and the hop-by-hop and framing names an HTTP intermediary may rewrite, such as Connection and Content-Length. Authorization is allowed.
SecretValue (string) --
The token the provider sends in the header. If you omit it, EventBridge generates one. EventBridge stores the token only in AWS Secrets Manager and never returns it, including from DescribeEventSource. EventBridge compares it against the entire header value, so a provider that sends Authorization: Bearer <token> needs SecretValue to include the "Bearer " prefix.
BasicHttpAuthConfiguration (dict) --
The provider uses HTTP Basic authentication.
Username (string) --
The username.
Password (string) --
The password.
HmacAuthConfiguration (dict) --
The provider signs each request with an HMAC of the secret.
Algorithm (string) -- [REQUIRED]
The hash algorithm the provider uses to compute the signature.
Encoding (string) -- [REQUIRED]
How the provider encodes the signature in the header.
SignatureHttpHeader (string) -- [REQUIRED]
The name of the header that carries the signature, for example X-Hub-Signature-256. When TimestampHttpHeader names the same header, Delimiter, SignaturePrefix and TimestampPrefix are all required. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.
SignaturePrefix (string) --
The text that precedes the signature in the header value, for example sha256=. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.
Delimiter (string) --
The separator between parts of the signature header value, for example a comma for a header value of t=1727816400,v1=<signature>, or a space when the header carries several signatures. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.
TimestampHttpHeader (string) --
The name of the header that carries the request timestamp. Required when SignedMessageComposition is TIMESTAMP_DOT_BODY or MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY, or when TimestampToleranceInSeconds is set. Not allowed when SignedMessageComposition is BODY, because BODY does not sign the timestamp. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.
TimestampPrefix (string) --
The text that precedes the timestamp in the header value, for example t=. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.
TimestampToleranceInSeconds (integer) --
The maximum difference, in seconds, allowed between the request timestamp and the time EventBridge receives the request. Requests outside this window are rejected. The default is 300 seconds. Requires TimestampHttpHeader. Not allowed when SignedMessageComposition is BODY, because BODY does not sign the timestamp.
MessageIdHttpHeader (string) --
The name of the header that carries the message ID. Required when SignedMessageComposition is MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY. Requests whose message ID contains a period (.) are rejected. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.
SignedMessageComposition (string) -- [REQUIRED]
How the provider assembles the message it signs from the request.
BODY - The request body alone. BODY provides no replay protection.
TIMESTAMP_DOT_BODY - <timestamp>.<body>. Requires TimestampHttpHeader.
MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY - <messageId>.<timestamp>.<body>, as in the Standard Webhooks specification. Requires TimestampHttpHeader and MessageIdHttpHeader.
SecretValue (string) --
The signing key shared with the provider. If you omit it, EventBridge generates one. EventBridge stores the key only in AWS Secrets Manager and never returns it, including from DescribeEventSource. The key must be 16 to 512 bytes; with BASE64 SecretEncoding, this is measured after decoding.
SecretEncoding (string) --
How the secret is encoded. RAW uses the secret's characters as the signing key. BASE64 decodes the secret first, as providers that follow the Standard Webhooks specification require. The default is RAW.
KmsKeyIdentifier (string) --
Optional. The AWS KMS key that encrypts the EventSource's secret in AWS Secrets Manager. Omit it to encrypt the secret with the AWS managed key aws/secretsmanager. A key you supply must be an enabled customer managed key in your account and Region. Changing it re-encrypts the secret under the new key. The previous key can still decrypt the stored versions until the credential is next rotated.
RoleArn (string) -- [REQUIRED]
IAM role the service assumes to put the webhook's events on the event bus. Must belong to the calling account.
MetadataHttpHeaders (list) --
The HTTP request headers to add to each event's metadata, up to 20. Header names are case-insensitive and can't repeat. Each header is added under its lowercase name. Omit the list to add no headers. Headers that carry credentials or that describe the network path, and the header that carries the static token, can't be listed.
(string) --
The name of an HTTP request header to add to event metadata. Must be a valid header name as defined in RFC 7230.
DeduplicationConfiguration (dict) --
Optional. Deduplicates this EventSource's events on the event bus. Omit it to deduplicate nothing.
DeduplicationType (string) -- [REQUIRED]
How duplicate events are detected.
LogConfiguration (dict) --
Optional. Controls the log records EventBridge delivers for this EventSource's webhook requests. Omit it to deliver no logs. Logs are delivered to the destinations you configure with Amazon CloudWatch Logs vended log delivery.
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
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/<type>/<name>/<id>. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events, webhook for webhook 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/<type>/<name>/<id>), 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.
{'InvokeConfiguration': {'MskParameters': {'Acks': 'ALL | LEADER',
'ClientId': 'string',
'Compression': 'NONE | GZIP | '
'SNAPPY | LZ4 | ZSTD',
'Connectivity': 'PUBLIC | PRIVATE',
'Headers': [{'Key': 'string',
'Value': 'string'}],
'PartitionKey': 'string',
'TopicName': 'string'}}}
Response {'SubscriberDetails': {'MskDetails': {'ConnectivityState': 'PROVISIONING | '
'PROVISION_FAILED | '
'ACTIVE',
'StateReason': 'string',
'VpcConnectionArn': 'string'}}}
Updates a subscriber. Fields omitted from the request are left unchanged. Changing an Amazon MSK subscriber's connectivity can re-provision it; when it does, the subscriber resumes delivering once its ConnectivityState returns to ACTIVE (see the MskSubscriberActive waiter).
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'
}
},
'MskParameters': {
'TopicName': 'string',
'Compression': 'NONE'|'GZIP'|'SNAPPY'|'LZ4'|'ZSTD',
'Acks': 'ALL'|'LEADER',
'PartitionKey': 'string',
'Headers': [
{
'Key': 'string',
'Value': 'string'
},
],
'ClientId': 'string',
'Connectivity': 'PUBLIC'|'PRIVATE'
}
},
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). Must be a literal integer; JSONata expressions are not supported for this field. String-typed to match the other targets' timeout fields. Defaults to 30s 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.
MskParameters (dict) --
MSK (Apache Kafka) invocation parameters for subscribers targeting an Amazon MSK cluster.
TopicName (string) -- [REQUIRED]
Name of the Kafka topic events are produced to. Accepts a literal or a JSONata expression resolved once per delivered event.
Compression (string) --
Producer compression codec applied to the record batch. Defaults to NONE.
Acks (string) --
Producer acknowledgement mode. Defaults to ALL.
PartitionKey (string) --
Kafka record key. Accepts a literal or a JSONata expression (e.g. "{% $events.data.customerId %}") resolved once per delivered event; the resolved value selects the destination partition. If you omit it, the producer selects the partition; on an ordered (FIFO) subscriber, EventBridge instead uses the event group ID as the record key to preserve ordering.
Headers (list) --
Kafka record headers attached to each produced record.
(dict) --
A single Kafka record header. Both Key and Value accept a literal or a JSONata expression (e.g. "{% $events.metadata.source %}") resolved once per delivered event.
Key (string) -- [REQUIRED]
The header key. Accepts a literal or a JSONata expression.
Value (string) --
The header value. Accepts a literal or a JSONata expression.
ClientId (string) --
Producer client.id passed to the Kafka broker. Identifies the producer in broker-side logs, metrics, and quota enforcement. A literal, not a JSONata expression: it is a connection-level setting resolved once when the producer is created, not per event. If you do not set it, EventBridge uses the subscriber ARN.
Connectivity (string) -- [REQUIRED]
How the service connects to the cluster. A cluster can have public access and multi-VPC private connectivity turned on at the same time, so the subscriber names the one to use. That path must be turned on, with IAM access control, on the cluster.
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
Transformer configuration for a subscriber.
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),
'SubscriberDetails': {
'MskDetails': {
'ConnectivityState': 'PROVISIONING'|'PROVISION_FAILED'|'ACTIVE',
'StateReason': 'string',
'VpcConnectionArn': 'string'
}
}
}
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.
SubscriberDetails (dict) --
Values EventBridge manages for a subscriber that depend on its target type. Only the member for the subscriber's target type is set. Returned in responses only; the customer never supplies these values.
MskDetails (dict) --
Values EventBridge manages for a subscriber that targets an Amazon MSK cluster.
ConnectivityState (string) --
Provisioning state of the connectivity EventBridge sets up to the cluster. Distinct from the subscriber's State, which the customer controls.
StateReason (string) --
Why provisioning failed. Present only when ConnectivityState is PROVISION_FAILED.
VpcConnectionArn (string) --
ARN of the VPC connection EventBridge uses to reach the cluster. Present only for PRIVATE connectivity, once the connection exists. It is the connection the cluster owner sees through the MSK ListClientVpcConnections API.