Table of Contents
A low-level client representing Amazon EventBridge
Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:
For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide .
import boto3
client = boto3.client('events')
These are the available methods:
Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
See also: AWS API Documentation
Request Syntax
response = client.activate_event_source(
Name='string'
)
[REQUIRED]
The name of the partner event source to activate.
Exceptions
Check if an operation can be paginated.
Cancels the specified replay.
See also: AWS API Documentation
Request Syntax
response = client.cancel_replay(
ReplayName='string'
)
[REQUIRED]
The name of the replay to cancel.
{
'ReplayArn': 'string',
'State': 'STARTING'|'RUNNING'|'CANCELLING'|'COMPLETED'|'CANCELLED'|'FAILED',
'StateReason': 'string'
}
Response Structure
The ARN of the replay to cancel.
The current state of the replay.
The reason that the replay is in the current state.
Exceptions
Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
See also: AWS API Documentation
Request Syntax
response = client.create_api_destination(
Name='string',
Description='string',
ConnectionArn='string',
InvocationEndpoint='string',
HttpMethod='POST'|'GET'|'HEAD'|'OPTIONS'|'PUT'|'PATCH'|'DELETE',
InvocationRateLimitPerSecond=123
)
[REQUIRED]
The name for the API destination to create.
[REQUIRED]
The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.
[REQUIRED]
The URL to the HTTP invocation endpoint for the API destination.
[REQUIRED]
The method to use for the request to the HTTP invocation endpoint.
dict
Response Syntax
{
'ApiDestinationArn': 'string',
'ApiDestinationState': 'ACTIVE'|'INACTIVE',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ApiDestinationArn (string) --
The ARN of the API destination that was created by the request.
ApiDestinationState (string) --
The state of the API destination that was created by the request.
CreationTime (datetime) --
A time stamp indicating the time that the API destination was created.
LastModifiedTime (datetime) --
A time stamp indicating the time that the API destination was last modified.
Exceptions
Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.
See also: AWS API Documentation
Request Syntax
response = client.create_archive(
ArchiveName='string',
EventSourceArn='string',
Description='string',
EventPattern='string',
RetentionDays=123
)
[REQUIRED]
The name for the archive to create.
[REQUIRED]
The ARN of the event bus that sends events to the archive.
dict
Response Syntax
{
'ArchiveArn': 'string',
'State': 'ENABLED'|'DISABLED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
'StateReason': 'string',
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ArchiveArn (string) --
The ARN of the archive that was created.
State (string) --
The state of the archive that was created.
StateReason (string) --
The reason that the archive is in the state.
CreationTime (datetime) --
The time at which the archive was created.
Exceptions
Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
See also: AWS API Documentation
Request Syntax
response = client.create_connection(
Name='string',
Description='string',
AuthorizationType='BASIC'|'OAUTH_CLIENT_CREDENTIALS'|'API_KEY',
AuthParameters={
'BasicAuthParameters': {
'Username': 'string',
'Password': 'string'
},
'OAuthParameters': {
'ClientParameters': {
'ClientID': 'string',
'ClientSecret': 'string'
},
'AuthorizationEndpoint': 'string',
'HttpMethod': 'GET'|'POST'|'PUT',
'OAuthHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
}
},
'ApiKeyAuthParameters': {
'ApiKeyName': 'string',
'ApiKeyValue': 'string'
},
'InvocationHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
}
}
)
[REQUIRED]
The name for the connection to create.
[REQUIRED]
The type of authorization to use for the connection.
[REQUIRED]
A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
A CreateConnectionBasicAuthRequestParameters object that contains the Basic authorization parameters to use for the connection.
The user name to use for Basic authorization.
The password associated with the user name to use for Basic authorization.
A CreateConnectionOAuthRequestParameters object that contains the OAuth authorization parameters to use for the connection.
A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.
The client ID to use for OAuth authorization for the connection.
The client secret associated with the client ID to use for OAuth authorization for the connection.
The URL to the authorization endpoint when OAuth is specified as the authorization type.
The method to use for the authorization request.
A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.
Contains additional header parameters for the connection.
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is a secret.
Contains additional query string parameters for the connection.
Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.
The key for a query string parameter.
The value associated with the key for the query string parameter.
Specifies whether the value is secret.
Contains additional body string parameters for the connection.
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is secret.
A CreateConnectionApiKeyAuthRequestParameters object that contains the API key authorization parameters to use for the connection.
The name of the API key to use for authorization.
The value for the API key to use for authorization.
A ConnectionHttpParameters object that contains the API key authorization parameters to use for the connection. Note that if you include additional parameters for the target of a rule via HttpParameters , including query strings, the parameters added for the connection take precedence.
Contains additional header parameters for the connection.
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is a secret.
Contains additional query string parameters for the connection.
Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.
The key for a query string parameter.
The value associated with the key for the query string parameter.
Specifies whether the value is secret.
Contains additional body string parameters for the connection.
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is secret.
dict
Response Syntax
{
'ConnectionArn': 'string',
'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ConnectionArn (string) --
The ARN of the connection that was created by the request.
ConnectionState (string) --
The state of the connection that was created by the request.
CreationTime (datetime) --
A time stamp for the time that the connection was created.
LastModifiedTime (datetime) --
A time stamp for the time that the connection was last updated.
Exceptions
Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.
See also: AWS API Documentation
Request Syntax
response = client.create_event_bus(
Name='string',
EventSourceName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the new event bus.
Event bus names cannot contain the / character. You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.
If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.
Tags to associate with the event bus.
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
The value for the specified tag key.
dict
Response Syntax
{
'EventBusArn': 'string'
}
Response Structure
(dict) --
EventBusArn (string) --
The ARN of the new event bus.
Exceptions
Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers.
Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types.
A partner event source creates events based on resources within the SaaS partner's service or application.
An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets.
Partner event source names follow this format:
`` partner_name /event_namespace /event_name ``
partner_name is determined during partner registration and identifies the partner to Amazon Web Services customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.
See also: AWS API Documentation
Request Syntax
response = client.create_partner_event_source(
Name='string',
Account='string'
)
[REQUIRED]
The name of the partner event source. This name must be unique and must be in the format `` partner_name /event_namespace /event_name `` . The Amazon Web Services account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.
[REQUIRED]
The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.
dict
Response Syntax
{
'EventSourceArn': 'string'
}
Response Structure
(dict) --
EventSourceArn (string) --
The ARN of the partner event source.
Exceptions
You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted.
When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted.
To activate a deactivated partner event source, use ActivateEventSource .
See also: AWS API Documentation
Request Syntax
response = client.deactivate_event_source(
Name='string'
)
[REQUIRED]
The name of the partner event source to deactivate.
Exceptions
Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection.
See also: AWS API Documentation
Request Syntax
response = client.deauthorize_connection(
Name='string'
)
[REQUIRED]
The name of the connection to remove authorization from.
{
'ConnectionArn': 'string',
'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastAuthorizedTime': datetime(2015, 1, 1)
}
Response Structure
The ARN of the connection that authorization was removed from.
The state of the connection.
A time stamp for the time that the connection was created.
A time stamp for the time that the connection was last updated.
A time stamp for the time that the connection was last authorized.
Exceptions
Deletes the specified API destination.
See also: AWS API Documentation
Request Syntax
response = client.delete_api_destination(
Name='string'
)
[REQUIRED]
The name of the destination to delete.
{}
Response Structure
Exceptions
Deletes the specified archive.
See also: AWS API Documentation
Request Syntax
response = client.delete_archive(
ArchiveName='string'
)
[REQUIRED]
The name of the archive to delete.
{}
Response Structure
Exceptions
Deletes a connection.
See also: AWS API Documentation
Request Syntax
response = client.delete_connection(
Name='string'
)
[REQUIRED]
The name of the connection to delete.
{
'ConnectionArn': 'string',
'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastAuthorizedTime': datetime(2015, 1, 1)
}
Response Structure
The ARN of the connection that was deleted.
The state of the connection before it was deleted.
A time stamp for the time that the connection was created.
A time stamp for the time that the connection was last modified before it was deleted.
A time stamp for the time that the connection was last authorized before it wa deleted.
Exceptions
Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_bus(
Name='string'
)
[REQUIRED]
The name of the event bus to delete.
Exceptions
This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers.
When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.
See also: AWS API Documentation
Request Syntax
response = client.delete_partner_event_source(
Name='string',
Account='string'
)
[REQUIRED]
The name of the event source to delete.
[REQUIRED]
The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.
None
Exceptions
Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets .
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned.
Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.
See also: AWS API Documentation
Request Syntax
response = client.delete_rule(
Name='string',
EventBusName='string',
Force=True|False
)
[REQUIRED]
The name of the rule.
None
Exceptions
Retrieves details about an API destination.
See also: AWS API Documentation
Request Syntax
response = client.describe_api_destination(
Name='string'
)
[REQUIRED]
The name of the API destination to retrieve.
{
'ApiDestinationArn': 'string',
'Name': 'string',
'Description': 'string',
'ApiDestinationState': 'ACTIVE'|'INACTIVE',
'ConnectionArn': 'string',
'InvocationEndpoint': 'string',
'HttpMethod': 'POST'|'GET'|'HEAD'|'OPTIONS'|'PUT'|'PATCH'|'DELETE',
'InvocationRateLimitPerSecond': 123,
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
The ARN of the API destination retrieved.
The name of the API destination retrieved.
The description for the API destination retrieved.
The state of the API destination retrieved.
The ARN of the connection specified for the API destination retrieved.
The URL to use to connect to the HTTP endpoint.
The method to use to connect to the HTTP endpoint.
The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
A time stamp for the time that the API destination was created.
A time stamp for the time that the API destination was last modified.
Exceptions
Retrieves details about an archive.
See also: AWS API Documentation
Request Syntax
response = client.describe_archive(
ArchiveName='string'
)
[REQUIRED]
The name of the archive to retrieve.
{
'ArchiveArn': 'string',
'ArchiveName': 'string',
'EventSourceArn': 'string',
'Description': 'string',
'EventPattern': 'string',
'State': 'ENABLED'|'DISABLED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
'StateReason': 'string',
'RetentionDays': 123,
'SizeBytes': 123,
'EventCount': 123,
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
The ARN of the archive.
The name of the archive.
The ARN of the event source associated with the archive.
The description of the archive.
The event pattern used to filter events sent to the archive.
The state of the archive.
The reason that the archive is in the state.
The number of days to retain events for in the archive.
The size of the archive in bytes.
The number of events in the archive.
The time at which the archive was created.
Exceptions
Retrieves details about a connection.
See also: AWS API Documentation
Request Syntax
response = client.describe_connection(
Name='string'
)
[REQUIRED]
The name of the connection to retrieve.
{
'ConnectionArn': 'string',
'Name': 'string',
'Description': 'string',
'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING',
'StateReason': 'string',
'AuthorizationType': 'BASIC'|'OAUTH_CLIENT_CREDENTIALS'|'API_KEY',
'SecretArn': 'string',
'AuthParameters': {
'BasicAuthParameters': {
'Username': 'string'
},
'OAuthParameters': {
'ClientParameters': {
'ClientID': 'string'
},
'AuthorizationEndpoint': 'string',
'HttpMethod': 'GET'|'POST'|'PUT',
'OAuthHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
}
},
'ApiKeyAuthParameters': {
'ApiKeyName': 'string'
},
'InvocationHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
}
},
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastAuthorizedTime': datetime(2015, 1, 1)
}
Response Structure
The ARN of the connection retrieved.
The name of the connection retrieved.
The description for the connection retrieved.
The state of the connection retrieved.
The reason that the connection is in the current connection state.
The type of authorization specified for the connection.
The ARN of the secret created from the authorization parameters specified for the connection.
The parameters to use for authorization for the connection.
The authorization parameters for Basic authorization.
The user name to use for Basic authorization.
The OAuth parameters to use for authorization.
A ConnectionOAuthClientResponseParameters object that contains details about the client parameters returned when OAuth is specified as the authorization type.
The client ID associated with the response to the connection request.
The URL to the HTTP endpoint that authorized the request.
The method used to connect to the HTTP endpoint.
The additional HTTP parameters used for the OAuth authorization request.
Contains additional header parameters for the connection.
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is a secret.
Contains additional query string parameters for the connection.
Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.
The key for a query string parameter.
The value associated with the key for the query string parameter.
Specifies whether the value is secret.
Contains additional body string parameters for the connection.
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is secret.
The API Key parameters to use for authorization.
The name of the header to use for the APIKeyValue used for authorization.
Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
Contains additional header parameters for the connection.
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is a secret.
Contains additional query string parameters for the connection.
Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.
The key for a query string parameter.
The value associated with the key for the query string parameter.
Specifies whether the value is secret.
Contains additional body string parameters for the connection.
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is secret.
A time stamp for the time that the connection was created.
A time stamp for the time that the connection was last modified.
A time stamp for the time that the connection was last authorized.
Exceptions
Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.
To enable your account to receive events from other accounts on its default event bus, use PutPermission .
For more information about partner event buses, see CreateEventBus .
See also: AWS API Documentation
Request Syntax
response = client.describe_event_bus(
Name='string'
)
{
'Name': 'string',
'Arn': 'string',
'Policy': 'string'
}
Response Structure
The name of the event bus. Currently, this is always default .
The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
The policy that enables the external account to send events to your account.
Exceptions
This operation lists details about a partner event source that is shared with your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_source(
Name='string'
)
[REQUIRED]
The name of the partner event source to display the details of.
{
'Arn': 'string',
'CreatedBy': 'string',
'CreationTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'Name': 'string',
'State': 'PENDING'|'ACTIVE'|'DELETED'
}
Response Structure
The ARN of the partner event source.
The name of the SaaS partner that created the event source.
The date and time that the event source was created.
The date and time that the event source will expire if you do not create a matching event bus.
The name of the partner event source.
The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.
Exceptions
An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.
See also: AWS API Documentation
Request Syntax
response = client.describe_partner_event_source(
Name='string'
)
[REQUIRED]
The name of the event source to display.
{
'Arn': 'string',
'Name': 'string'
}
Response Structure
The ARN of the event source.
The name of the event source.
Exceptions
Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.
See also: AWS API Documentation
Request Syntax
response = client.describe_replay(
ReplayName='string'
)
[REQUIRED]
The name of the replay to retrieve.
{
'ReplayName': 'string',
'ReplayArn': 'string',
'Description': 'string',
'State': 'STARTING'|'RUNNING'|'CANCELLING'|'COMPLETED'|'CANCELLED'|'FAILED',
'StateReason': 'string',
'EventSourceArn': 'string',
'Destination': {
'Arn': 'string',
'FilterArns': [
'string',
]
},
'EventStartTime': datetime(2015, 1, 1),
'EventEndTime': datetime(2015, 1, 1),
'EventLastReplayedTime': datetime(2015, 1, 1),
'ReplayStartTime': datetime(2015, 1, 1),
'ReplayEndTime': datetime(2015, 1, 1)
}
Response Structure
The name of the replay.
The ARN of the replay.
The description of the replay.
The current state of the replay.
The reason that the replay is in the current state.
The ARN of the archive events were replayed from.
A ReplayDestination object that contains details about the replay.
The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive.
A list of ARNs for rules to replay events to.
The time stamp of the first event that was last replayed from the archive.
The time stamp for the last event that was replayed from the archive.
The time that the event was last replayed.
A time stamp for the time that the replay started.
A time stamp for the time that the replay stopped.
Exceptions
Describes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule .
See also: AWS API Documentation
Request Syntax
response = client.describe_rule(
Name='string',
EventBusName='string'
)
[REQUIRED]
The name of the rule.
dict
Response Syntax
{
'Name': 'string',
'Arn': 'string',
'EventPattern': 'string',
'ScheduleExpression': 'string',
'State': 'ENABLED'|'DISABLED',
'Description': 'string',
'RoleArn': 'string',
'ManagedBy': 'string',
'EventBusName': 'string',
'CreatedBy': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the rule.
Arn (string) --
The Amazon Resource Name (ARN) of the rule.
EventPattern (string) --
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
ScheduleExpression (string) --
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
State (string) --
Specifies whether the rule is enabled or disabled.
Description (string) --
The description of the rule.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
ManagedBy (string) --
If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
EventBusName (string) --
The name of the event bus associated with the rule.
CreatedBy (string) --
The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.
Exceptions
Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.
When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.
See also: AWS API Documentation
Request Syntax
response = client.disable_rule(
Name='string',
EventBusName='string'
)
[REQUIRED]
The name of the rule.
None
Exceptions
Enables the specified rule. If the rule does not exist, the operation fails.
When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.
See also: AWS API Documentation
Request Syntax
response = client.enable_rule(
Name='string',
EventBusName='string'
)
[REQUIRED]
The name of the rule.
None
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Retrieves a list of API destination in the account in the current Region.
See also: AWS API Documentation
Request Syntax
response = client.list_api_destinations(
NamePrefix='string',
ConnectionArn='string',
NextToken='string',
Limit=123
)
dict
Response Syntax
{
'ApiDestinations': [
{
'ApiDestinationArn': 'string',
'Name': 'string',
'ApiDestinationState': 'ACTIVE'|'INACTIVE',
'ConnectionArn': 'string',
'InvocationEndpoint': 'string',
'HttpMethod': 'POST'|'GET'|'HEAD'|'OPTIONS'|'PUT'|'PATCH'|'DELETE',
'InvocationRateLimitPerSecond': 123,
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApiDestinations (list) --
An array of ApiDestination objects that include information about an API destination.
(dict) --
Contains details about an API destination.
ApiDestinationArn (string) --
The ARN of the API destination.
Name (string) --
The name of the API destination.
ApiDestinationState (string) --
The state of the API destination.
ConnectionArn (string) --
The ARN of the connection specified for the API destination.
InvocationEndpoint (string) --
The URL to the endpoint for the API destination.
HttpMethod (string) --
The method to use to connect to the HTTP endpoint.
InvocationRateLimitPerSecond (integer) --
The maximum number of invocations per second to send to the HTTP endpoint.
CreationTime (datetime) --
A time stamp for the time that the API destination was created.
LastModifiedTime (datetime) --
A time stamp for the time that the API destination was last modified.
NextToken (string) --
A token you can use in a subsequent request to retrieve the next set of results.
Exceptions
Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.
See also: AWS API Documentation
Request Syntax
response = client.list_archives(
NamePrefix='string',
EventSourceArn='string',
State='ENABLED'|'DISABLED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
NextToken='string',
Limit=123
)
dict
Response Syntax
{
'Archives': [
{
'ArchiveName': 'string',
'EventSourceArn': 'string',
'State': 'ENABLED'|'DISABLED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
'StateReason': 'string',
'RetentionDays': 123,
'SizeBytes': 123,
'EventCount': 123,
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Archives (list) --
An array of Archive objects that include details about an archive.
(dict) --
An Archive object that contains details about an archive.
ArchiveName (string) --
The name of the archive.
EventSourceArn (string) --
The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.
State (string) --
The current state of the archive.
StateReason (string) --
A description for the reason that the archive is in the current state.
RetentionDays (integer) --
The number of days to retain events in the archive before they are deleted.
SizeBytes (integer) --
The size of the archive, in bytes.
EventCount (integer) --
The number of events in the archive.
CreationTime (datetime) --
The time stamp for the time that the archive was created.
NextToken (string) --
The token returned by a previous call to retrieve the next set of results.
Exceptions
Retrieves a list of connections from the account.
See also: AWS API Documentation
Request Syntax
response = client.list_connections(
NamePrefix='string',
ConnectionState='CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING',
NextToken='string',
Limit=123
)
dict
Response Syntax
{
'Connections': [
{
'ConnectionArn': 'string',
'Name': 'string',
'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING',
'StateReason': 'string',
'AuthorizationType': 'BASIC'|'OAUTH_CLIENT_CREDENTIALS'|'API_KEY',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastAuthorizedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Connections (list) --
An array of connections objects that include details about the connections.
(dict) --
Contains information about a connection.
ConnectionArn (string) --
The ARN of the connection.
Name (string) --
The name of the connection.
ConnectionState (string) --
The state of the connection.
StateReason (string) --
The reason that the connection is in the connection state.
AuthorizationType (string) --
The authorization type specified for the connection.
CreationTime (datetime) --
A time stamp for the time that the connection was created.
LastModifiedTime (datetime) --
A time stamp for the time that the connection was last modified.
LastAuthorizedTime (datetime) --
A time stamp for the time that the connection was last authorized.
NextToken (string) --
A token you can use in a subsequent request to retrieve the next set of results.
Exceptions
Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
See also: AWS API Documentation
Request Syntax
response = client.list_event_buses(
NamePrefix='string',
NextToken='string',
Limit=123
)
dict
Response Syntax
{
'EventBuses': [
{
'Name': 'string',
'Arn': 'string',
'Policy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EventBuses (list) --
This list of event buses.
(dict) --
An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives events from Amazon Web Services services. A custom event bus can receive events from your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.
Name (string) --
The name of the event bus.
Arn (string) --
The ARN of the event bus.
Policy (string) --
The permissions policy of the event bus, describing which other Amazon Web Services accounts can write events to this event bus.
NextToken (string) --
A token you can use in a subsequent operation to retrieve the next set of results.
Exceptions
You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus .
See also: AWS API Documentation
Request Syntax
response = client.list_event_sources(
NamePrefix='string',
NextToken='string',
Limit=123
)
dict
Response Syntax
{
'EventSources': [
{
'Arn': 'string',
'CreatedBy': 'string',
'CreationTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'Name': 'string',
'State': 'PENDING'|'ACTIVE'|'DELETED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EventSources (list) --
The list of event sources.
(dict) --
A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.
Arn (string) --
The ARN of the event source.
CreatedBy (string) --
The name of the partner that created the event source.
CreationTime (datetime) --
The date and time the event source was created.
ExpirationTime (datetime) --
The date and time that the event source will expire, if the Amazon Web Services account doesn't create a matching event bus for it.
Name (string) --
The name of the event source.
State (string) --
The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.
NextToken (string) --
A token you can use in a subsequent operation to retrieve the next set of results.
Exceptions
An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.
See also: AWS API Documentation
Request Syntax
response = client.list_partner_event_source_accounts(
EventSourceName='string',
NextToken='string',
Limit=123
)
[REQUIRED]
The name of the partner event source to display account information about.
dict
Response Syntax
{
'PartnerEventSourceAccounts': [
{
'Account': 'string',
'CreationTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'State': 'PENDING'|'ACTIVE'|'DELETED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PartnerEventSourceAccounts (list) --
The list of partner event sources returned by the operation.
(dict) --
The Amazon Web Services account that a partner event source has been offered to.
Account (string) --
The Amazon Web Services account ID that the partner event source was offered to.
CreationTime (datetime) --
The date and time the event source was created.
ExpirationTime (datetime) --
The date and time that the event source will expire, if the Amazon Web Services account doesn't create a matching event bus for it.
State (string) --
The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.
NextToken (string) --
A token you can use in a subsequent operation to retrieve the next set of results.
Exceptions
An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers.
See also: AWS API Documentation
Request Syntax
response = client.list_partner_event_sources(
NamePrefix='string',
NextToken='string',
Limit=123
)
[REQUIRED]
If you specify this, the results are limited to only those partner event sources that start with the string you specify.
dict
Response Syntax
{
'PartnerEventSources': [
{
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PartnerEventSources (list) --
The list of partner event sources returned by the operation.
(dict) --
A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.
Arn (string) --
The ARN of the partner event source.
Name (string) --
The name of the partner event source.
NextToken (string) --
A token you can use in a subsequent operation to retrieve the next set of results.
Exceptions
Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.
See also: AWS API Documentation
Request Syntax
response = client.list_replays(
NamePrefix='string',
State='STARTING'|'RUNNING'|'CANCELLING'|'COMPLETED'|'CANCELLED'|'FAILED',
EventSourceArn='string',
NextToken='string',
Limit=123
)
dict
Response Syntax
{
'Replays': [
{
'ReplayName': 'string',
'EventSourceArn': 'string',
'State': 'STARTING'|'RUNNING'|'CANCELLING'|'COMPLETED'|'CANCELLED'|'FAILED',
'StateReason': 'string',
'EventStartTime': datetime(2015, 1, 1),
'EventEndTime': datetime(2015, 1, 1),
'EventLastReplayedTime': datetime(2015, 1, 1),
'ReplayStartTime': datetime(2015, 1, 1),
'ReplayEndTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Replays (list) --
An array of Replay objects that contain information about the replay.
(dict) --
A Replay object that contains details about a replay.
ReplayName (string) --
The name of the replay.
EventSourceArn (string) --
The ARN of the archive to replay event from.
State (string) --
The current state of the replay.
StateReason (string) --
A description of why the replay is in the current state.
EventStartTime (datetime) --
A time stamp for the time to start replaying events. This is determined by the time in the event as described in Time .
EventEndTime (datetime) --
A time stamp for the time to start replaying events. Any event with a creation time prior to the EventEndTime specified is replayed.
EventLastReplayedTime (datetime) --
A time stamp for the time that the last event was replayed.
ReplayStartTime (datetime) --
A time stamp for the time that the replay started.
ReplayEndTime (datetime) --
A time stamp for the time that the replay completed.
NextToken (string) --
The token returned by a previous call to retrieve the next set of results.
Exceptions
Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.
See also: AWS API Documentation
Request Syntax
response = client.list_rule_names_by_target(
TargetArn='string',
EventBusName='string',
NextToken='string',
Limit=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target resource.
dict
Response Syntax
{
'RuleNames': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
RuleNames (list) --
The names of the rules that can invoke the given target.
NextToken (string) --
Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
Exceptions
Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.
ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule .
See also: AWS API Documentation
Request Syntax
response = client.list_rules(
NamePrefix='string',
EventBusName='string',
NextToken='string',
Limit=123
)
dict
Response Syntax
{
'Rules': [
{
'Name': 'string',
'Arn': 'string',
'EventPattern': 'string',
'State': 'ENABLED'|'DISABLED',
'Description': 'string',
'ScheduleExpression': 'string',
'RoleArn': 'string',
'ManagedBy': 'string',
'EventBusName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Rules (list) --
The rules that match the specified criteria.
(dict) --
Contains information about a rule in Amazon EventBridge.
Name (string) --
The name of the rule.
Arn (string) --
The Amazon Resource Name (ARN) of the rule.
EventPattern (string) --
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
State (string) --
The state of the rule.
Description (string) --
The description of the rule.
ScheduleExpression (string) --
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule .
RoleArn (string) --
The Amazon Resource Name (ARN) of the role that is used for target invocation.
If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.
ManagedBy (string) --
If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.
EventBusName (string) --
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
NextToken (string) --
Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
Exceptions
Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The ARN of the EventBridge resource for which you want to view tags.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The list of tag keys and values associated with the resource you specified
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
The value for the specified tag key.
Exceptions
Lists the targets assigned to the specified rule.
See also: AWS API Documentation
Request Syntax
response = client.list_targets_by_rule(
Rule='string',
EventBusName='string',
NextToken='string',
Limit=123
)
[REQUIRED]
The name of the rule.
dict
Response Syntax
{
'Targets': [
{
'Id': 'string',
'Arn': 'string',
'RoleArn': 'string',
'Input': 'string',
'InputPath': 'string',
'InputTransformer': {
'InputPathsMap': {
'string': 'string'
},
'InputTemplate': 'string'
},
'KinesisParameters': {
'PartitionKeyPath': 'string'
},
'RunCommandParameters': {
'RunCommandTargets': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
},
'EcsParameters': {
'TaskDefinitionArn': 'string',
'TaskCount': 123,
'LaunchType': 'EC2'|'FARGATE'|'EXTERNAL',
'NetworkConfiguration': {
'awsvpcConfiguration': {
'Subnets': [
'string',
],
'SecurityGroups': [
'string',
],
'AssignPublicIp': 'ENABLED'|'DISABLED'
}
},
'PlatformVersion': 'string',
'Group': 'string',
'CapacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'EnableECSManagedTags': True|False,
'EnableExecuteCommand': True|False,
'PlacementConstraints': [
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
'PlacementStrategy': [
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
],
'PropagateTags': 'TASK_DEFINITION',
'ReferenceId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'BatchParameters': {
'JobDefinition': 'string',
'JobName': 'string',
'ArrayProperties': {
'Size': 123
},
'RetryStrategy': {
'Attempts': 123
}
},
'SqsParameters': {
'MessageGroupId': 'string'
},
'HttpParameters': {
'PathParameterValues': [
'string',
],
'HeaderParameters': {
'string': 'string'
},
'QueryStringParameters': {
'string': 'string'
}
},
'RedshiftDataParameters': {
'SecretManagerArn': 'string',
'Database': 'string',
'DbUser': 'string',
'Sql': 'string',
'StatementName': 'string',
'WithEvent': True|False
},
'SageMakerPipelineParameters': {
'PipelineParameterList': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'DeadLetterConfig': {
'Arn': 'string'
},
'RetryPolicy': {
'MaximumRetryAttempts': 123,
'MaximumEventAgeInSeconds': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Targets (list) --
The targets assigned to the rule.
(dict) --
Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets .
If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide .
Id (string) --
The ID of the target. We recommend using a memorable and unique string.
Arn (string) --
The Amazon Resource Name (ARN) of the target.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
Input (string) --
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
InputPath (string) --
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath .
InputTransformer (dict) --
Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
InputPathsMap (dict) --
Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.
InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.
The keys cannot start with "Amazon Web Services."
InputTemplate (string) --
Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value > The InputTemplate must be valid JSON.
If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:
The following example shows the syntax for using InputPathsMap and InputTemplate .
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state <status>"
}
To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state \"<status>\""
}
The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'
}
KinesisParameters (dict) --
The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.
PartitionKeyPath (string) --
The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .
RunCommandParameters (dict) --
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
RunCommandTargets (list) --
Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
(dict) --
Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values.
Key (string) --
Can be either tag: tag-key or InstanceIds .
Values (list) --
If Key is tag: tag-key , Values is a list of tag values. If Key is InstanceIds , Values is a list of Amazon EC2 instance IDs.
EcsParameters (dict) --
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide .
TaskDefinitionArn (string) --
The ARN of the task definition to use if the event target is an Amazon ECS task.
TaskCount (integer) --
The number of tasks to create based on TaskDefinition . The default is 1.
LaunchType (string) --
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
NetworkConfiguration (dict) --
Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.
awsvpcConfiguration (dict) --
Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
Subnets (list) --
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
SecurityGroups (list) --
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
AssignPublicIp (string) --
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE .
PlatformVersion (string) --
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0 .
This structure is used only if LaunchType is FARGATE . For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
Group (string) --
Specifies an ECS task group for the task. The maximum length is 255 characters.
CapacityProviderStrategy (list) --
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
(dict) --
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
capacityProvider (string) --
The short name of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
EnableECSManagedTags (boolean) --
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
EnableExecuteCommand (boolean) --
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
PlacementConstraints (list) --
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
(dict) --
An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
type (string) --
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
expression (string) --
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance . To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
PlacementStrategy (list) --
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
(dict) --
The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.
type (string) --
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field (string) --
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
PropagateTags (string) --
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
ReferenceId (string) --
The reference ID to use for the task.
Tags (list) --
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
(dict) --
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
Key (string) --
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
Value (string) --
The value for the specified tag key.
BatchParameters (dict) --
If the event target is an Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the Batch User Guide .
JobDefinition (string) --
The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.
JobName (string) --
The name to use for this execution of the job, if the target is an Batch job.
ArrayProperties (dict) --
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
Size (integer) --
The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
RetryStrategy (dict) --
The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
Attempts (integer) --
The number of times to attempt to retry, if the job fails. Valid values are 1–10.
SqsParameters (dict) --
Contains the message group ID to use when the target is a FIFO queue.
If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
MessageGroupId (string) --
The FIFO message group ID to use as the target.
HttpParameters (dict) --
Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
PathParameterValues (list) --
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
HeaderParameters (dict) --
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
QueryStringParameters (dict) --
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
RedshiftDataParameters (dict) --
Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
SecretManagerArn (string) --
The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
Database (string) --
The name of the database. Required when authenticating using temporary credentials.
DbUser (string) --
The database user name. Required when authenticating using temporary credentials.
Sql (string) --
The SQL statement text to run.
StatementName (string) --
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
WithEvent (boolean) --
Indicates whether to send an event back to EventBridge after the SQL statement runs.
SageMakerPipelineParameters (dict) --
Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
PipelineParameterList (list) --
List of Parameter names and values for SageMaker Model Building Pipeline execution.
(dict) --
Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.
Name (string) --
Name of parameter to start execution of a SageMaker Model Building Pipeline.
Value (string) --
Value of parameter to start execution of a SageMaker Model Building Pipeline.
DeadLetterConfig (dict) --
The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
Arn (string) --
The ARN of the SQS queue specified as the target for the dead-letter queue.
RetryPolicy (dict) --
The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.
MaximumRetryAttempts (integer) --
The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.
MaximumEventAgeInSeconds (integer) --
The maximum amount of time, in seconds, to continue to make retry attempts.
NextToken (string) --
Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
Exceptions
Sends custom events to Amazon EventBridge so that they can be matched to rules.
See also: AWS API Documentation
Request Syntax
response = client.put_events(
Entries=[
{
'Time': datetime(2015, 1, 1),
'Source': 'string',
'Resources': [
'string',
],
'DetailType': 'string',
'Detail': 'string',
'EventBusName': 'string',
'TraceHeader': 'string'
},
]
)
[REQUIRED]
The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.
Represents an event to be submitted.
The time stamp of the event, per RFC3339 . If no time stamp is provided, the time stamp of the PutEvents call is used.
The source of the event.
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
Free-form string used to decide what fields to expect in the event detail.
A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.
An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.
To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
{
'FailedEntryCount': 123,
'Entries': [
{
'EventId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
The number of failed entries.
The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.
Represents an event that failed to be submitted.
The ID of the event.
The error code that indicates why the event submission failed.
The error message that explains why the event submission failed.
Exceptions
This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
See also: AWS API Documentation
Request Syntax
response = client.put_partner_events(
Entries=[
{
'Time': datetime(2015, 1, 1),
'Source': 'string',
'Resources': [
'string',
],
'DetailType': 'string',
'Detail': 'string'
},
]
)
[REQUIRED]
The list of events to write to the event bus.
The details about an event generated by an SaaS partner.
The date and time of the event.
The event source that is generating the entry.
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
A free-form string used to decide what fields to expect in the event detail.
A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
{
'FailedEntryCount': 123,
'Entries': [
{
'EventId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
The number of events from this operation that could not be written to the partner event bus.
The list of events from this operation that were successfully written to the partner event bus.
Represents an event that a partner tried to generate, but failed.
The ID of the event.
The error code that indicates why the event submission failed.
The error message that explains why the event submission failed.
Exceptions
Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus . Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.
For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.
To enable multiple Amazon Web Services accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services organization ID in Condition , to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide .
The permission policy on the event bus cannot exceed 10 KB in size.
See also: AWS API Documentation
Request Syntax
response = client.put_permission(
EventBusName='string',
Action='string',
Principal='string',
StatementId='string',
Condition={
'Type': 'string',
'Key': 'string',
'Value': 'string'
},
Policy='string'
)
The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.
If you specify "*" without specifying Condition , avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide .
If you specify Condition with an Amazon Web Services organization ID, and specify "*" as the value for Principal , you grant permission to all the accounts in the named organization.
The Condition is a JSON string which must contain Type , Key , and Value fields.
Specifies the type of condition. Currently the only supported value is StringEquals .
Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID .
Specifies the value for the key. Currently, this must be the ID of the organization.
None
Exceptions
Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule .
A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus .
If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule , the old values for those arguments are not kept. Instead, they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.
A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.
When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.
If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource .
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets .
See also: AWS API Documentation
Request Syntax
response = client.put_rule(
Name='string',
ScheduleExpression='string',
EventPattern='string',
State='ENABLED'|'DISABLED',
Description='string',
RoleArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
EventBusName='string'
)
[REQUIRED]
The name of the rule that you are creating or updating.
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.
The list of key-value pairs to associate with the rule.
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
The value for the specified tag key.
dict
Response Syntax
{
'RuleArn': 'string'
}
Response Structure
(dict) --
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
Exceptions
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for Events:
Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are EC2 CreateSnapshot API call , EC2 RebootInstances API call , EC2 StopInstances API call , and EC2 TerminateInstances API call .
For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets . For more information, see Authentication and Access Control in the Amazon EventBridge User Guide .
If another Amazon Web Services account is in the same region and has granted you permission (using PutPermission ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing .
Note
Input , InputPath , and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services account.
If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide .
For more information about enabling cross-account events, see PutPermission .
Input , InputPath , and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
When you specify InputPath or InputTransformer , you must use JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
See also: AWS API Documentation
Request Syntax
response = client.put_targets(
Rule='string',
EventBusName='string',
Targets=[
{
'Id': 'string',
'Arn': 'string',
'RoleArn': 'string',
'Input': 'string',
'InputPath': 'string',
'InputTransformer': {
'InputPathsMap': {
'string': 'string'
},
'InputTemplate': 'string'
},
'KinesisParameters': {
'PartitionKeyPath': 'string'
},
'RunCommandParameters': {
'RunCommandTargets': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
},
'EcsParameters': {
'TaskDefinitionArn': 'string',
'TaskCount': 123,
'LaunchType': 'EC2'|'FARGATE'|'EXTERNAL',
'NetworkConfiguration': {
'awsvpcConfiguration': {
'Subnets': [
'string',
],
'SecurityGroups': [
'string',
],
'AssignPublicIp': 'ENABLED'|'DISABLED'
}
},
'PlatformVersion': 'string',
'Group': 'string',
'CapacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'EnableECSManagedTags': True|False,
'EnableExecuteCommand': True|False,
'PlacementConstraints': [
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
'PlacementStrategy': [
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
],
'PropagateTags': 'TASK_DEFINITION',
'ReferenceId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'BatchParameters': {
'JobDefinition': 'string',
'JobName': 'string',
'ArrayProperties': {
'Size': 123
},
'RetryStrategy': {
'Attempts': 123
}
},
'SqsParameters': {
'MessageGroupId': 'string'
},
'HttpParameters': {
'PathParameterValues': [
'string',
],
'HeaderParameters': {
'string': 'string'
},
'QueryStringParameters': {
'string': 'string'
}
},
'RedshiftDataParameters': {
'SecretManagerArn': 'string',
'Database': 'string',
'DbUser': 'string',
'Sql': 'string',
'StatementName': 'string',
'WithEvent': True|False
},
'SageMakerPipelineParameters': {
'PipelineParameterList': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'DeadLetterConfig': {
'Arn': 'string'
},
'RetryPolicy': {
'MaximumRetryAttempts': 123,
'MaximumEventAgeInSeconds': 123
}
},
]
)
[REQUIRED]
The name of the rule.
[REQUIRED]
The targets to update or add to the rule.
Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets .
If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide .
The ID of the target. We recommend using a memorable and unique string.
The Amazon Resource Name (ARN) of the target.
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath .
Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.
InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.
The keys cannot start with "Amazon Web Services."
Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value > The InputTemplate must be valid JSON.
If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:
The following example shows the syntax for using InputPathsMap and InputTemplate .
"InputTransformer":{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state <status>"
}
To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:
"InputTransformer":{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state \"<status>\""
}
The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following example:
"InputTransformer":{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'
}
The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.
The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values.
Can be either tag: tag-key or InstanceIds .
If Key is tag: tag-key , Values is a list of tag values. If Key is InstanceIds , Values is a list of Amazon EC2 instance IDs.
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide .
The ARN of the task definition to use if the event target is an Amazon ECS task.
The number of tasks to create based on TaskDefinition . The default is 1.
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.
Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE .
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0 .
This structure is used only if LaunchType is FARGATE . For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
Specifies an ECS task group for the task. The maximum length is 255 characters.
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
The short name of the capacity provider.
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance . To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
The reference ID to use for the task.
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
The value for the specified tag key.
If the event target is an Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the Batch User Guide .
The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.
The name to use for this execution of the job, if the target is an Batch job.
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
The number of times to attempt to retry, if the job fails. Valid values are 1–10.
Contains the message group ID to use when the target is a FIFO queue.
If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
The FIFO message group ID to use as the target.
Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
The name of the database. Required when authenticating using temporary credentials.
The database user name. Required when authenticating using temporary credentials.
The SQL statement text to run.
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
Indicates whether to send an event back to EventBridge after the SQL statement runs.
Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
List of Parameter names and values for SageMaker Model Building Pipeline execution.
Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.
Name of parameter to start execution of a SageMaker Model Building Pipeline.
Value of parameter to start execution of a SageMaker Model Building Pipeline.
The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
The ARN of the SQS queue specified as the target for the dead-letter queue.
The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.
The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.
The maximum amount of time, in seconds, to continue to make retry attempts.
dict
Response Syntax
{
'FailedEntryCount': 123,
'FailedEntries': [
{
'TargetId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
FailedEntryCount (integer) --
The number of failed entries.
FailedEntries (list) --
The failed target entries.
(dict) --
Represents a target that failed to be added to a rule.
TargetId (string) --
The ID of the target.
ErrorCode (string) --
The error code that indicates why the target addition failed. If the value is ConcurrentModificationException , too many requests were made at the same time.
ErrorMessage (string) --
The error message that explains why the target addition failed.
Exceptions
Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission . You can find the StatementId by using DescribeEventBus .
See also: AWS API Documentation
Request Syntax
response = client.remove_permission(
StatementId='string',
RemoveAllPermissions=True|False,
EventBusName='string'
)
None
Exceptions
Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
See also: AWS API Documentation
Request Syntax
response = client.remove_targets(
Rule='string',
EventBusName='string',
Ids=[
'string',
],
Force=True|False
)
[REQUIRED]
The name of the rule.
[REQUIRED]
The IDs of the targets to remove from the rule.
dict
Response Syntax
{
'FailedEntryCount': 123,
'FailedEntries': [
{
'TargetId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
FailedEntryCount (integer) --
The number of failed entries.
FailedEntries (list) --
The failed target entries.
(dict) --
Represents a target that failed to be removed from a rule.
TargetId (string) --
The ID of the target.
ErrorCode (string) --
The error code that indicates why the target removal failed. If the value is ConcurrentModificationException , too many requests were made at the same time.
ErrorMessage (string) --
The error message that explains why the target removal failed.
Exceptions
Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.
See also: AWS API Documentation
Request Syntax
response = client.start_replay(
ReplayName='string',
Description='string',
EventSourceArn='string',
EventStartTime=datetime(2015, 1, 1),
EventEndTime=datetime(2015, 1, 1),
Destination={
'Arn': 'string',
'FilterArns': [
'string',
]
}
)
[REQUIRED]
The name of the replay to start.
[REQUIRED]
The ARN of the archive to replay events from.
[REQUIRED]
A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.
[REQUIRED]
A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.
[REQUIRED]
A ReplayDestination object that includes details about the destination for the replay.
The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive.
A list of ARNs for rules to replay events to.
dict
Response Syntax
{
'ReplayArn': 'string',
'State': 'STARTING'|'RUNNING'|'CANCELLING'|'COMPLETED'|'CANCELLED'|'FAILED',
'StateReason': 'string',
'ReplayStartTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ReplayArn (string) --
The ARN of the replay.
State (string) --
The state of the replay.
StateReason (string) --
The reason that the replay is in the state.
ReplayStartTime (datetime) --
The time at which the replay started.
Exceptions
Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN of the EventBridge resource that you're adding tags to.
[REQUIRED]
The list of key-value pairs to associate with the resource.
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
The value for the specified tag key.
dict
Response Syntax
{}
Response Structure
Exceptions
Tests whether the specified event pattern matches the provided event.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
See also: AWS API Documentation
Request Syntax
response = client.test_event_pattern(
EventPattern='string',
Event='string'
)
[REQUIRED]
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
[REQUIRED]
The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in Amazon Web Services Events , and the following fields are mandatory:
dict
Response Syntax
{
'Result': True|False
}
Response Structure
(dict) --
Result (boolean) --
Indicates whether the event matches the event pattern.
Exceptions
Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the EventBridge resource from which you are removing tags.
[REQUIRED]
The list of tag keys to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates an API destination.
See also: AWS API Documentation
Request Syntax
response = client.update_api_destination(
Name='string',
Description='string',
ConnectionArn='string',
InvocationEndpoint='string',
HttpMethod='POST'|'GET'|'HEAD'|'OPTIONS'|'PUT'|'PATCH'|'DELETE',
InvocationRateLimitPerSecond=123
)
[REQUIRED]
The name of the API destination to update.
dict
Response Syntax
{
'ApiDestinationArn': 'string',
'ApiDestinationState': 'ACTIVE'|'INACTIVE',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ApiDestinationArn (string) --
The ARN of the API destination that was updated.
ApiDestinationState (string) --
The state of the API destination that was updated.
CreationTime (datetime) --
A time stamp for the time that the API destination was created.
LastModifiedTime (datetime) --
A time stamp for the time that the API destination was last modified.
Exceptions
Updates the specified archive.
See also: AWS API Documentation
Request Syntax
response = client.update_archive(
ArchiveName='string',
Description='string',
EventPattern='string',
RetentionDays=123
)
[REQUIRED]
The name of the archive to update.
dict
Response Syntax
{
'ArchiveArn': 'string',
'State': 'ENABLED'|'DISABLED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
'StateReason': 'string',
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ArchiveArn (string) --
The ARN of the archive.
State (string) --
The state of the archive.
StateReason (string) --
The reason that the archive is in the current state.
CreationTime (datetime) --
The time at which the archive was updated.
Exceptions
Updates settings for a connection.
See also: AWS API Documentation
Request Syntax
response = client.update_connection(
Name='string',
Description='string',
AuthorizationType='BASIC'|'OAUTH_CLIENT_CREDENTIALS'|'API_KEY',
AuthParameters={
'BasicAuthParameters': {
'Username': 'string',
'Password': 'string'
},
'OAuthParameters': {
'ClientParameters': {
'ClientID': 'string',
'ClientSecret': 'string'
},
'AuthorizationEndpoint': 'string',
'HttpMethod': 'GET'|'POST'|'PUT',
'OAuthHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
}
},
'ApiKeyAuthParameters': {
'ApiKeyName': 'string',
'ApiKeyValue': 'string'
},
'InvocationHttpParameters': {
'HeaderParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'QueryStringParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
],
'BodyParameters': [
{
'Key': 'string',
'Value': 'string',
'IsValueSecret': True|False
},
]
}
}
)
[REQUIRED]
The name of the connection to update.
The authorization parameters to use for the connection.
A UpdateConnectionBasicAuthRequestParameters object that contains the authorization parameters for Basic authorization.
The user name to use for Basic authorization.
The password associated with the user name to use for Basic authorization.
A UpdateConnectionOAuthRequestParameters object that contains the authorization parameters for OAuth authorization.
A UpdateConnectionOAuthClientRequestParameters object that contains the client parameters to use for the connection when OAuth is specified as the authorization type.
The client ID to use for OAuth authorization.
The client secret assciated with the client ID to use for OAuth authorization.
The URL to the authorization endpoint when OAuth is specified as the authorization type.
The method used to connect to the HTTP endpoint.
The additional HTTP parameters used for the OAuth authorization request.
Contains additional header parameters for the connection.
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is a secret.
Contains additional query string parameters for the connection.
Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.
The key for a query string parameter.
The value associated with the key for the query string parameter.
Specifies whether the value is secret.
Contains additional body string parameters for the connection.
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is secret.
A UpdateConnectionApiKeyAuthRequestParameters object that contains the authorization parameters for API key authorization.
The name of the API key to use for authorization.
The value associated with teh API key to use for authorization.
A ConnectionHttpParameters object that contains the additional parameters to use for the connection.
Contains additional header parameters for the connection.
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is a secret.
Contains additional query string parameters for the connection.
Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.
The key for a query string parameter.
The value associated with the key for the query string parameter.
Specifies whether the value is secret.
Contains additional body string parameters for the connection.
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
The key for the parameter.
The value associated with the key.
Specified whether the value is secret.
dict
Response Syntax
{
'ConnectionArn': 'string',
'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastAuthorizedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ConnectionArn (string) --
The ARN of the connection that was updated.
ConnectionState (string) --
The state of the connection that was updated.
CreationTime (datetime) --
A time stamp for the time that the connection was created.
LastModifiedTime (datetime) --
A time stamp for the time that the connection was last modified.
LastAuthorizedTime (datetime) --
A time stamp for the time that the connection was last authorized.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_rule_names_by_target')
Creates an iterator that will paginate through responses from EventBridge.Client.list_rule_names_by_target().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TargetArn='string',
EventBusName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target resource.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RuleNames': [
'string',
],
}
Response Structure
(dict) --
RuleNames (list) --
The names of the rules that can invoke the given target.
paginator = client.get_paginator('list_rules')
Creates an iterator that will paginate through responses from EventBridge.Client.list_rules().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
NamePrefix='string',
EventBusName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Rules': [
{
'Name': 'string',
'Arn': 'string',
'EventPattern': 'string',
'State': 'ENABLED'|'DISABLED',
'Description': 'string',
'ScheduleExpression': 'string',
'RoleArn': 'string',
'ManagedBy': 'string',
'EventBusName': 'string'
},
],
}
Response Structure
(dict) --
Rules (list) --
The rules that match the specified criteria.
(dict) --
Contains information about a rule in Amazon EventBridge.
Name (string) --
The name of the rule.
Arn (string) --
The Amazon Resource Name (ARN) of the rule.
EventPattern (string) --
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
State (string) --
The state of the rule.
Description (string) --
The description of the rule.
ScheduleExpression (string) --
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule .
RoleArn (string) --
The Amazon Resource Name (ARN) of the role that is used for target invocation.
If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.
ManagedBy (string) --
If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.
EventBusName (string) --
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
paginator = client.get_paginator('list_targets_by_rule')
Creates an iterator that will paginate through responses from EventBridge.Client.list_targets_by_rule().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Rule='string',
EventBusName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the rule.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Targets': [
{
'Id': 'string',
'Arn': 'string',
'RoleArn': 'string',
'Input': 'string',
'InputPath': 'string',
'InputTransformer': {
'InputPathsMap': {
'string': 'string'
},
'InputTemplate': 'string'
},
'KinesisParameters': {
'PartitionKeyPath': 'string'
},
'RunCommandParameters': {
'RunCommandTargets': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
},
'EcsParameters': {
'TaskDefinitionArn': 'string',
'TaskCount': 123,
'LaunchType': 'EC2'|'FARGATE'|'EXTERNAL',
'NetworkConfiguration': {
'awsvpcConfiguration': {
'Subnets': [
'string',
],
'SecurityGroups': [
'string',
],
'AssignPublicIp': 'ENABLED'|'DISABLED'
}
},
'PlatformVersion': 'string',
'Group': 'string',
'CapacityProviderStrategy': [
{
'capacityProvider': 'string',
'weight': 123,
'base': 123
},
],
'EnableECSManagedTags': True|False,
'EnableExecuteCommand': True|False,
'PlacementConstraints': [
{
'type': 'distinctInstance'|'memberOf',
'expression': 'string'
},
],
'PlacementStrategy': [
{
'type': 'random'|'spread'|'binpack',
'field': 'string'
},
],
'PropagateTags': 'TASK_DEFINITION',
'ReferenceId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'BatchParameters': {
'JobDefinition': 'string',
'JobName': 'string',
'ArrayProperties': {
'Size': 123
},
'RetryStrategy': {
'Attempts': 123
}
},
'SqsParameters': {
'MessageGroupId': 'string'
},
'HttpParameters': {
'PathParameterValues': [
'string',
],
'HeaderParameters': {
'string': 'string'
},
'QueryStringParameters': {
'string': 'string'
}
},
'RedshiftDataParameters': {
'SecretManagerArn': 'string',
'Database': 'string',
'DbUser': 'string',
'Sql': 'string',
'StatementName': 'string',
'WithEvent': True|False
},
'SageMakerPipelineParameters': {
'PipelineParameterList': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'DeadLetterConfig': {
'Arn': 'string'
},
'RetryPolicy': {
'MaximumRetryAttempts': 123,
'MaximumEventAgeInSeconds': 123
}
},
],
}
Response Structure
(dict) --
Targets (list) --
The targets assigned to the rule.
(dict) --
Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets .
If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide .
Id (string) --
The ID of the target. We recommend using a memorable and unique string.
Arn (string) --
The Amazon Resource Name (ARN) of the target.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
Input (string) --
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
InputPath (string) --
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath .
InputTransformer (dict) --
Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
InputPathsMap (dict) --
Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.
InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.
The keys cannot start with "Amazon Web Services."
InputTemplate (string) --
Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value > The InputTemplate must be valid JSON.
If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:
The following example shows the syntax for using InputPathsMap and InputTemplate .
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state <status>"
}
To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state \"<status>\""
}
The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'
}
KinesisParameters (dict) --
The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.
PartitionKeyPath (string) --
The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .
RunCommandParameters (dict) --
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
RunCommandTargets (list) --
Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
(dict) --
Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values.
Key (string) --
Can be either tag: tag-key or InstanceIds .
Values (list) --
If Key is tag: tag-key , Values is a list of tag values. If Key is InstanceIds , Values is a list of Amazon EC2 instance IDs.
EcsParameters (dict) --
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide .
TaskDefinitionArn (string) --
The ARN of the task definition to use if the event target is an Amazon ECS task.
TaskCount (integer) --
The number of tasks to create based on TaskDefinition . The default is 1.
LaunchType (string) --
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
NetworkConfiguration (dict) --
Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.
awsvpcConfiguration (dict) --
Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
Subnets (list) --
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
SecurityGroups (list) --
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
AssignPublicIp (string) --
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE .
PlatformVersion (string) --
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0 .
This structure is used only if LaunchType is FARGATE . For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
Group (string) --
Specifies an ECS task group for the task. The maximum length is 255 characters.
CapacityProviderStrategy (list) --
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
(dict) --
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
capacityProvider (string) --
The short name of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
EnableECSManagedTags (boolean) --
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
EnableExecuteCommand (boolean) --
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
PlacementConstraints (list) --
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
(dict) --
An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
type (string) --
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
expression (string) --
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance . To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
PlacementStrategy (list) --
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
(dict) --
The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.
type (string) --
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field (string) --
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
PropagateTags (string) --
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
ReferenceId (string) --
The reference ID to use for the task.
Tags (list) --
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
(dict) --
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
Key (string) --
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
Value (string) --
The value for the specified tag key.
BatchParameters (dict) --
If the event target is an Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the Batch User Guide .
JobDefinition (string) --
The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.
JobName (string) --
The name to use for this execution of the job, if the target is an Batch job.
ArrayProperties (dict) --
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
Size (integer) --
The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
RetryStrategy (dict) --
The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
Attempts (integer) --
The number of times to attempt to retry, if the job fails. Valid values are 1–10.
SqsParameters (dict) --
Contains the message group ID to use when the target is a FIFO queue.
If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
MessageGroupId (string) --
The FIFO message group ID to use as the target.
HttpParameters (dict) --
Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
PathParameterValues (list) --
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
HeaderParameters (dict) --
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
QueryStringParameters (dict) --
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
RedshiftDataParameters (dict) --
Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
SecretManagerArn (string) --
The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
Database (string) --
The name of the database. Required when authenticating using temporary credentials.
DbUser (string) --
The database user name. Required when authenticating using temporary credentials.
Sql (string) --
The SQL statement text to run.
StatementName (string) --
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
WithEvent (boolean) --
Indicates whether to send an event back to EventBridge after the SQL statement runs.
SageMakerPipelineParameters (dict) --
Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
PipelineParameterList (list) --
List of Parameter names and values for SageMaker Model Building Pipeline execution.
(dict) --
Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.
Name (string) --
Name of parameter to start execution of a SageMaker Model Building Pipeline.
Value (string) --
Value of parameter to start execution of a SageMaker Model Building Pipeline.
DeadLetterConfig (dict) --
The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
Arn (string) --
The ARN of the SQS queue specified as the target for the dead-letter queue.
RetryPolicy (dict) --
The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.
MaximumRetryAttempts (integer) --
The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.
MaximumEventAgeInSeconds (integer) --
The maximum amount of time, in seconds, to continue to make retry attempts.