EventBridge *********** Client ====== class EventBridge.Client 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: * Automatically invoke an Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state. * Direct specific API records from CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks. * Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume. 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: * activate_event_source * can_paginate * cancel_replay * close * create_api_destination * create_archive * create_connection * create_endpoint * create_event_bus * create_partner_event_source * deactivate_event_source * deauthorize_connection * delete_api_destination * delete_archive * delete_connection * delete_endpoint * delete_event_bus * delete_partner_event_source * delete_rule * describe_api_destination * describe_archive * describe_connection * describe_endpoint * describe_event_bus * describe_event_source * describe_partner_event_source * describe_replay * describe_rule * disable_rule * enable_rule * get_paginator * get_waiter * list_api_destinations * list_archives * list_connections * list_endpoints * list_event_buses * list_event_sources * list_partner_event_source_accounts * list_partner_event_sources * list_replays * list_rule_names_by_target * list_rules * list_tags_for_resource * list_targets_by_rule * put_events * put_partner_events * put_permission * put_rule * put_targets * remove_permission * remove_targets * start_replay * tag_resource * test_event_pattern * untag_resource * update_api_destination * update_archive * update_connection * update_endpoint * update_event_bus Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListRuleNamesByTarget * ListRules * ListTargetsByRule EventBridge / Paginator / ListRuleNamesByTarget ListRuleNamesByTarget ********************* class EventBridge.Paginator.ListRuleNamesByTarget paginator = client.get_paginator('list_rule_names_by_target') paginate(**kwargs) 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' } ) Parameters: * **TargetArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the target resource. * **EventBusName** (*string*) -- The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RuleNames': [ 'string', ], } **Response Structure** * *(dict) --* * **RuleNames** *(list) --* The names of the rules that can invoke the given target. * *(string) --* EventBridge / Paginator / ListTargetsByRule ListTargetsByRule ***************** class EventBridge.Paginator.ListTargetsByRule paginator = client.get_paginator('list_targets_by_rule') paginate(**kwargs) 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' } ) Parameters: * **Rule** (*string*) -- **[REQUIRED]** The name of 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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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, 'Sqls': [ 'string', ] }, 'SageMakerPipelineParameters': { 'PipelineParameterList': [ { 'Name': 'string', 'Value': 'string' }, ] }, 'DeadLetterConfig': { 'Arn': 'string' }, 'RetryPolicy': { 'MaximumRetryAttempts': 123, 'MaximumEventAgeInSeconds': 123 }, 'AppSyncParameters': { 'GraphQLOperation': '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 within the specified rule. Use this ID to reference the target when updating the rule. 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 may use JSON dot notation or 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." * *(string) --* * *(string) --* * **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*> If "InputTemplate" is a JSON object (surrounded by curly braces), the following restrictions apply: * The placeholder cannot be used as an object key. The following example shows the syntax for using "InputPathsMap" and "InputTemplate". ""InputTransformer":" "{" ""InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}," ""InputTemplate": " is in state "" "}" 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": " is in state \"\""" "}" 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": ,"myStatus": " is in state \"\""}'" "}" * **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. * *(string) --* * **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 with 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. * *(string) --* * **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. * *(string) --* * **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 endpoint or EventBridge ApiDestination. If you specify an API Gateway 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 API or EventBridge ApiDestination path wildcards ("*"). * *(string) --* * **HeaderParameters** *(dict) --* The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination. * *(string) --* * *(string) --* * **QueryStringParameters** *(dict) --* The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination. * *(string) --* * *(string) --* * **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. * **Sqls** *(list) --* One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back. * *(string) --* A single Redshift SQL * **SageMakerPipelineParameters** *(dict) --* Contains the SageMaker AI Model Building Pipeline parameters to start execution of a SageMaker AI Model Building Pipeline. If you specify a SageMaker AI 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 AI Model Building Pipeline execution. * *(dict) --* Name/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline. * **Name** *(string) --* Name of parameter to start execution of a SageMaker AI Model Building Pipeline. * **Value** *(string) --* Value of parameter to start execution of a SageMaker AI 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 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. * **AppSyncParameters** *(dict) --* Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API. * **GraphQLOperation** *(string) --* The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service. For more information, see Operations in the *AppSync User Guide*. EventBridge / Paginator / ListRules ListRules ********* class EventBridge.Paginator.ListRules paginator = client.get_paginator('list_rules') paginate(**kwargs) 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' } ) Parameters: * **NamePrefix** (*string*) -- The prefix matching the rule name. * **EventBusName** (*string*) -- The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Rules': [ { 'Name': 'string', 'Arn': 'string', 'EventPattern': 'string', 'State': 'ENABLED'|'DISABLED'|'ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS', '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. Valid values include: * "DISABLED": The rule is disabled. EventBridge does not match any events against the rule. * "ENABLED": The rule is enabled. EventBridge matches events against the rule, *except* for Amazon Web Services management events delivered through CloudTrail. * "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS": The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail. Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the *CloudTrail User Guide*, and Filtering management events from Amazon Web Services services in the *Amazon EventBridge User Guide* . This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses. * **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. EventBridge / Client / remove_targets remove_targets ************** EventBridge.Client.remove_targets(**kwargs) Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked. Note: A successful execution of "RemoveTargets" doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed. 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. The maximum number of entries per request is 10. See also: AWS API Documentation **Request Syntax** response = client.remove_targets( Rule='string', EventBusName='string', Ids=[ 'string', ], Force=True|False ) Parameters: * **Rule** (*string*) -- **[REQUIRED]** The name of 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. * **Ids** (*list*) -- **[REQUIRED]** The IDs of the targets to remove from the rule. * *(string) --* * **Force** (*boolean*) -- If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify "Force" as "True" to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using "DescribeRule" or "ListRules" and checking the "ManagedBy" field of the response. Return type: dict Returns: **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** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ManagedRuleException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / get_paginator get_paginator ************* EventBridge.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. EventBridge / Client / create_event_bus create_event_bus **************** EventBridge.Client.create_event_bus(**kwargs) 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', Description='string', KmsKeyIdentifier='string', DeadLetterConfig={ 'Arn': 'string' }, LogConfig={ 'IncludeDetail': 'NONE'|'FULL', 'Level': 'OFF'|'ERROR'|'INFO'|'TRACE' }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the new event bus. Custom event bus names can't contain the "/" character, but you can use the "/" character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to. 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. * **EventSourceName** (*string*) -- If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with. * **Description** (*string*) -- The event bus description. * **KmsKeyIdentifier** (*string*) -- The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus. For more information, see Identify and view keys in the *Key Management Service Developer Guide*. Note: Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if: * You call "CreateDiscoverer" on an event bus set to use a customer managed key for encryption. * You call "UpdatedEventBus" to set a customer managed key on an event bus with schema discovery enabled. To enable schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Encrypting events in the *Amazon EventBridge User Guide*. Warning: If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.For more information, see Encrypting archives in the *Amazon EventBridge User Guide*. * **DeadLetterConfig** (*dict*) -- Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). For more information, see Using dead-letter queues to process undelivered events in the *EventBridge User Guide*. * **Arn** *(string) --* The ARN of the SQS queue specified as the target for the dead-letter queue. * **LogConfig** (*dict*) -- The logging configuration settings for the event bus. For more information, see Configuring logs for event buses in the *EventBridge User Guide*. * **IncludeDetail** *(string) --* Whether EventBridge include detailed event information in the records it generates. Detailed data can be useful for troubleshooting and debugging. This information includes details of the event itself, as well as target details. For more information, see Including detail data in event bus logs in the *EventBridge User Guide*. * **Level** *(string) --* The level of logging detail to include. This applies to all log destinations for the event bus. For more information, see Specifying event bus log level in the *EventBridge User Guide*. * **Tags** (*list*) -- Tags to associate with the event bus. * *(dict) --* A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging. * **Key** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** The value for the specified tag key. Return type: dict Returns: **Response Syntax** { 'EventBusArn': 'string', 'Description': 'string', 'KmsKeyIdentifier': 'string', 'DeadLetterConfig': { 'Arn': 'string' }, 'LogConfig': { 'IncludeDetail': 'NONE'|'FULL', 'Level': 'OFF'|'ERROR'|'INFO'|'TRACE' } } **Response Structure** * *(dict) --* * **EventBusArn** *(string) --* The ARN of the new event bus. * **Description** *(string) --* The event bus description. * **KmsKeyIdentifier** *(string) --* The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified. For more information, see Data encryption in EventBridge in the *Amazon EventBridge User Guide*. * **DeadLetterConfig** *(dict) --* Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). For more information, see Using dead-letter queues to process undelivered events in the *EventBridge User Guide*. * **Arn** *(string) --* The ARN of the SQS queue specified as the target for the dead-letter queue. * **LogConfig** *(dict) --* The logging configuration settings for the event bus. For more information, see Configuring logs for event buses in the *EventBridge User Guide*. * **IncludeDetail** *(string) --* Whether EventBridge include detailed event information in the records it generates. Detailed data can be useful for troubleshooting and debugging. This information includes details of the event itself, as well as target details. For more information, see Including detail data in event bus logs in the *EventBridge User Guide*. * **Level** *(string) --* The level of logging detail to include. This applies to all log destinations for the event bus. For more information, see Specifying event bus log level in the *EventBridge User Guide*. **Exceptions** * "EventBridge.Client.exceptions.ResourceAlreadyExistsException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InvalidStateException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / describe_replay describe_replay *************** EventBridge.Client.describe_replay(**kwargs) 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' ) Parameters: **ReplayName** (*string*) -- **[REQUIRED]** The name of the replay to retrieve. Return type: dict Returns: **Response Syntax** { '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** * *(dict) --* * **ReplayName** *(string) --* The name of the replay. * **ReplayArn** *(string) --* The ARN of the replay. * **Description** *(string) --* The description of the replay. * **State** *(string) --* The current state of the replay. * **StateReason** *(string) --* The reason that the replay is in the current state. * **EventSourceArn** *(string) --* The ARN of the archive events were replayed from. * **Destination** *(dict) --* A "ReplayDestination" object that contains details about the replay. * **Arn** *(string) --* The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive. * **FilterArns** *(list) --* A list of ARNs for rules to replay events to. * *(string) --* * **EventStartTime** *(datetime) --* The time stamp of the first event that was last replayed from the archive. * **EventEndTime** *(datetime) --* The time stamp for the last event that was replayed from the archive. * **EventLastReplayedTime** *(datetime) --* The time that the event was last replayed. * **ReplayStartTime** *(datetime) --* A time stamp for the time that the replay started. * **ReplayEndTime** *(datetime) --* A time stamp for the time that the replay stopped. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / can_paginate can_paginate ************ EventBridge.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. EventBridge / Client / deactivate_event_source deactivate_event_source *********************** EventBridge.Client.deactivate_event_source(**kwargs) 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' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the partner event source to deactivate. Returns: None **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.InvalidStateException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / delete_archive delete_archive ************** EventBridge.Client.delete_archive(**kwargs) Deletes the specified archive. See also: AWS API Documentation **Request Syntax** response = client.delete_archive( ArchiveName='string' ) Parameters: **ArchiveName** (*string*) -- **[REQUIRED]** The name of the archive to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / delete_rule delete_rule *********** EventBridge.Client.delete_rule(**kwargs) 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 ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of 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. * **Force** (*boolean*) -- If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify "Force" as "True" to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using "DescribeRule" or "ListRules" and checking the "ManagedBy" field of the response. Returns: None **Exceptions** * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ManagedRuleException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ResourceNotFoundException" EventBridge / Client / describe_partner_event_source describe_partner_event_source ***************************** EventBridge.Client.describe_partner_event_source(**kwargs) 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' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the event source to display. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Name': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN of the event source. * **Name** *(string) --* The name of the event source. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / create_archive create_archive ************** EventBridge.Client.create_archive(**kwargs) 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. Warning: If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.For more information, see Encrypting archives in the *Amazon EventBridge User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_archive( ArchiveName='string', EventSourceArn='string', Description='string', EventPattern='string', RetentionDays=123, KmsKeyIdentifier='string' ) Parameters: * **ArchiveName** (*string*) -- **[REQUIRED]** The name for the archive to create. * **EventSourceArn** (*string*) -- **[REQUIRED]** The ARN of the event bus that sends events to the archive. * **Description** (*string*) -- A description for the archive. * **EventPattern** (*string*) -- An event pattern to use to filter events sent to the archive. * **RetentionDays** (*integer*) -- The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely * **KmsKeyIdentifier** (*string*) -- The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive. For more information, see Identify and view keys in the *Key Management Service Developer Guide*. Warning: If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.For more information, see Encrypting archives in the *Amazon EventBridge User Guide*. Return type: dict Returns: **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** * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ResourceAlreadyExistsException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.InvalidEventPatternException" EventBridge / Client / disable_rule disable_rule ************ EventBridge.Client.disable_rule(**kwargs) 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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of 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. Returns: None **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ManagedRuleException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / create_connection create_connection ***************** EventBridge.Client.create_connection(**kwargs) Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint. For more information, see Connections for endpoint targets in the *Amazon EventBridge User Guide*. 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 }, ] }, 'ConnectivityParameters': { 'ResourceParameters': { 'ResourceConfigurationArn': 'string' } } }, InvocationConnectivityParameters={ 'ResourceParameters': { 'ResourceConfigurationArn': 'string' } }, KmsKeyIdentifier='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name for the connection to create. * **Description** (*string*) -- A description for the connection to create. * **AuthorizationType** (*string*) -- **[REQUIRED]** The type of authorization to use for the connection. Note: OAUTH tokens are refreshed when a 401 or 407 response is returned. * **AuthParameters** (*dict*) -- **[REQUIRED]** The authorization parameters to use to authorize with the endpoint. You must include only authorization parameters for the "AuthorizationType" you specify. * **BasicAuthParameters** *(dict) --* The Basic authorization parameters to use for the connection. * **Username** *(string) --* **[REQUIRED]** The user name to use for Basic authorization. * **Password** *(string) --* **[REQUIRED]** The password associated with the user name to use for Basic authorization. * **OAuthParameters** *(dict) --* The OAuth authorization parameters to use for the connection. * **ClientParameters** *(dict) --* **[REQUIRED]** The client parameters for OAuth authorization. * **ClientID** *(string) --* **[REQUIRED]** The client ID to use for OAuth authorization for the connection. * **ClientSecret** *(string) --* **[REQUIRED]** The client secret associated with the client ID to use for OAuth authorization for the connection. * **AuthorizationEndpoint** *(string) --* **[REQUIRED]** The URL to the authorization endpoint when OAuth is specified as the authorization type. * **HttpMethod** *(string) --* **[REQUIRED]** The method to use for the authorization request. * **OAuthHttpParameters** *(dict) --* Details about the additional parameters to use for the connection. * **HeaderParameters** *(list) --* Any additional header parameters for the connection. * *(dict) --* Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is a secret. * **QueryStringParameters** *(list) --* Any additional query string parameters for the connection. * *(dict) --* Any 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. * **Key** *(string) --* The key for a query string parameter. * **Value** *(string) --* The value associated with the key for the query string parameter. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **BodyParameters** *(list) --* Any additional body string parameters for the connection. * *(dict) --* Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **ApiKeyAuthParameters** *(dict) --* The API key authorization parameters to use for the connection. * **ApiKeyName** *(string) --* **[REQUIRED]** The name of the API key to use for authorization. * **ApiKeyValue** *(string) --* **[REQUIRED]** The value for the API key to use for authorization. * **InvocationHttpParameters** *(dict) --* 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. * **HeaderParameters** *(list) --* Any additional header parameters for the connection. * *(dict) --* Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is a secret. * **QueryStringParameters** *(list) --* Any additional query string parameters for the connection. * *(dict) --* Any 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. * **Key** *(string) --* The key for a query string parameter. * **Value** *(string) --* The value associated with the key for the query string parameter. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **BodyParameters** *(list) --* Any additional body string parameters for the connection. * *(dict) --* Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **ConnectivityParameters** *(dict) --* If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint. For more information, see Authorization methods for connections in the *Amazon EventBridge User Guide* . * **ResourceParameters** *(dict) --* **[REQUIRED]** The parameters for EventBridge to use when invoking the resource endpoint. * **ResourceConfigurationArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. * **InvocationConnectivityParameters** (*dict*) -- For connections to private APIs, the parameters to use for invoking the API. For more information, see Connecting to private APIs in the *Amazon EventBridge User Guide* . * **ResourceParameters** *(dict) --* **[REQUIRED]** The parameters for EventBridge to use when invoking the resource endpoint. * **ResourceConfigurationArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. * **KmsKeyIdentifier** (*string*) -- The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection. For more information, see Identify and view keys in the *Key Management Service Developer Guide*. Return type: dict Returns: **Response Syntax** { 'ConnectionArn': 'string', 'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY', '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** * "EventBridge.Client.exceptions.ResourceAlreadyExistsException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.AccessDeniedException" * "EventBridge.Client.exceptions.ThrottlingException" EventBridge / Client / put_rule put_rule ******** EventBridge.Client.put_rule(**kwargs) 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. To create a rule that filters for management events from Amazon Web Services services, see Receiving read-only management events from Amazon Web Services services in the *EventBridge User Guide*. See also: AWS API Documentation **Request Syntax** response = client.put_rule( Name='string', ScheduleExpression='string', EventPattern='string', State='ENABLED'|'DISABLED'|'ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS', Description='string', RoleArn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], EventBusName='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the rule that you are creating or updating. * **ScheduleExpression** (*string*) -- The scheduling expression. For example, "cron(0 20 * * ? >>*<<)" or "rate(5 minutes)". * **EventPattern** (*string*) -- The event pattern. For more information, see Amazon EventBridge event patterns in the *Amazon EventBridge User Guide* . * **State** (*string*) -- The state of the rule. Valid values include: * "DISABLED": The rule is disabled. EventBridge does not match any events against the rule. * "ENABLED": The rule is enabled. EventBridge matches events against the rule, *except* for Amazon Web Services management events delivered through CloudTrail. * "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS": The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail. Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the *CloudTrail User Guide*, and Filtering management events from Amazon Web Services services in the *Amazon EventBridge User Guide* . This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses. * **Description** (*string*) -- A description of the rule. * **RoleArn** (*string*) -- 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. * **Tags** (*list*) -- The list of key-value pairs to associate with the rule. * *(dict) --* A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging. * **Key** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** The value for the specified tag key. * **EventBusName** (*string*) -- The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used. Return type: dict Returns: **Response Syntax** { 'RuleArn': 'string' } **Response Structure** * *(dict) --* * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the rule. **Exceptions** * "EventBridge.Client.exceptions.InvalidEventPatternException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ManagedRuleException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ResourceNotFoundException" EventBridge / Client / describe_event_source describe_event_source ********************* EventBridge.Client.describe_event_source(**kwargs) 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' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the partner event source to display the details of. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'CreatedBy': 'string', 'CreationTime': datetime(2015, 1, 1), 'ExpirationTime': datetime(2015, 1, 1), 'Name': 'string', 'State': 'PENDING'|'ACTIVE'|'DELETED' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN of the partner event source. * **CreatedBy** *(string) --* The name of the SaaS partner that created the event source. * **CreationTime** *(datetime) --* The date and time that the event source was created. * **ExpirationTime** *(datetime) --* The date and time that the event source will expire if you do not create a matching event bus. * **Name** *(string) --* The name of the partner 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. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / delete_partner_event_source delete_partner_event_source *************************** EventBridge.Client.delete_partner_event_source(**kwargs) 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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the event source to delete. * **Account** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for. Returns: None **Exceptions** * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / list_targets_by_rule list_targets_by_rule ******************** EventBridge.Client.list_targets_by_rule(**kwargs) Lists the targets assigned to the specified rule. The maximum number of results per page for requests is 100. See also: AWS API Documentation **Request Syntax** response = client.list_targets_by_rule( Rule='string', EventBusName='string', NextToken='string', Limit=123 ) Parameters: * **Rule** (*string*) -- **[REQUIRED]** The name of 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*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- The maximum number of results to return. Return type: dict Returns: **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, 'Sqls': [ 'string', ] }, 'SageMakerPipelineParameters': { 'PipelineParameterList': [ { 'Name': 'string', 'Value': 'string' }, ] }, 'DeadLetterConfig': { 'Arn': 'string' }, 'RetryPolicy': { 'MaximumRetryAttempts': 123, 'MaximumEventAgeInSeconds': 123 }, 'AppSyncParameters': { 'GraphQLOperation': 'string' } }, ], '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 within the specified rule. Use this ID to reference the target when updating the rule. 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 may use JSON dot notation or 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." * *(string) --* * *(string) --* * **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*> If "InputTemplate" is a JSON object (surrounded by curly braces), the following restrictions apply: * The placeholder cannot be used as an object key. The following example shows the syntax for using "InputPathsMap" and "InputTemplate". ""InputTransformer":" "{" ""InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}," ""InputTemplate": " is in state "" "}" 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": " is in state \"\""" "}" 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": ,"myStatus": " is in state \"\""}'" "}" * **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. * *(string) --* * **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 with 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. * *(string) --* * **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. * *(string) --* * **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 endpoint or EventBridge ApiDestination. If you specify an API Gateway 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 API or EventBridge ApiDestination path wildcards ("*"). * *(string) --* * **HeaderParameters** *(dict) --* The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination. * *(string) --* * *(string) --* * **QueryStringParameters** *(dict) --* The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination. * *(string) --* * *(string) --* * **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. * **Sqls** *(list) --* One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back. * *(string) --* A single Redshift SQL * **SageMakerPipelineParameters** *(dict) --* Contains the SageMaker AI Model Building Pipeline parameters to start execution of a SageMaker AI Model Building Pipeline. If you specify a SageMaker AI 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 AI Model Building Pipeline execution. * *(dict) --* Name/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline. * **Name** *(string) --* Name of parameter to start execution of a SageMaker AI Model Building Pipeline. * **Value** *(string) --* Value of parameter to start execution of a SageMaker AI 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 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. * **AppSyncParameters** *(dict) --* Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API. * **GraphQLOperation** *(string) --* The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service. For more information, see Operations in the *AppSync User Guide*. * **NextToken** *(string) --* A token indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / put_events put_events ********** EventBridge.Client.put_events(**kwargs) Sends custom events to Amazon EventBridge so that they can be matched to rules. You can batch multiple event entries into one request for efficiency. However, the total entry size must be less than 256KB. You can calculate the entry size before you send the events. For more information, see Calculating PutEvents event entry size in the *Amazon EventBridge User Guide* . PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807. Note: PutEvents will only process nested JSON up to 1000 levels deep. 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' }, ], EndpointId='string' ) Parameters: * **Entries** (*list*) -- **[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. * *(dict) --* Represents an event to be submitted. * **Time** *(datetime) --* The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used. * **Source** *(string) --* The source of the event. Note: "Detail", "DetailType", and "Source" are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which *none* of the entries have each of these properties, EventBridge fails the entire request. * **Resources** *(list) --* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present. * *(string) --* * **DetailType** *(string) --* Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail. Note: "Detail", "DetailType", and "Source" are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which *none* of the entries have each of these properties, EventBridge fails the entire request. * **Detail** *(string) --* A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects. Note: "Detail", "DetailType", and "Source" are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which *none* of the entries have each of these properties, EventBridge fails the entire request. * **EventBusName** *(string) --* 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. Note: If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the other Region based on the endpoint referenced by the "EndpointId". Specifying the event bus ARN is preferred. * **TraceHeader** *(string) --* An X-Ray trace 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. * **EndpointId** (*string*) -- The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is "abcde.veo". Warning: When using Java, you must include "auth-crt" on the class path. Return type: dict Returns: **Response Syntax** { 'FailedEntryCount': 123, 'Entries': [ { 'EventId': 'string', 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **FailedEntryCount** *(integer) --* The number of failed entries. * **Entries** *(list) --* 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. For each record, the index of the response element is the same as the index in the request array. * *(dict) --* Represents the results of an event submitted to an event bus. If the submission 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. For information about the errors that are common to all actions, see Common Errors. * **EventId** *(string) --* The ID of the event. * **ErrorCode** *(string) --* The error code that indicates why the event submission failed. Retryable errors include: * "InternalFailure" The request processing has failed because of an unknown error, exception or failure. * "ThrottlingException" The request was denied due to request throttling. Non-retryable errors include: * "AccessDeniedException" You do not have sufficient access to perform this action. * "InvalidAccountIdException" The account ID provided is not valid. * "InvalidArgument" A specified parameter is not valid. * "MalformedDetail" The JSON provided is not valid. * "RedactionFailure" Redacting the CloudTrail event failed. * "NotAuthorizedForSourceException" You do not have permissions to publish events with this source onto this event bus. * "NotAuthorizedForDetailTypeException" You do not have permissions to publish events with this detail type onto this event bus. * **ErrorMessage** *(string) --* The error message that explains why the event submission failed. **Exceptions** * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / list_tags_for_resource list_tags_for_resource ********************** EventBridge.Client.list_tags_for_resource(**kwargs) 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' ) Parameters: **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the EventBridge resource for which you want to view tags. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* The list of tag keys and values associated with the resource you specified * *(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. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / list_event_sources list_event_sources ****************** EventBridge.Client.list_event_sources(**kwargs) 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 ) Parameters: * **NamePrefix** (*string*) -- Specifying this limits the results to only those partner event sources with names that start with the specified prefix. * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results. Return type: dict Returns: **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 indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / update_archive update_archive ************** EventBridge.Client.update_archive(**kwargs) Updates the specified archive. See also: AWS API Documentation **Request Syntax** response = client.update_archive( ArchiveName='string', Description='string', EventPattern='string', RetentionDays=123, KmsKeyIdentifier='string' ) Parameters: * **ArchiveName** (*string*) -- **[REQUIRED]** The name of the archive to update. * **Description** (*string*) -- The description for the archive. * **EventPattern** (*string*) -- The event pattern to use to filter events sent to the archive. * **RetentionDays** (*integer*) -- The number of days to retain events in the archive. * **KmsKeyIdentifier** (*string*) -- The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive. For more information, see Identify and view keys in the *Key Management Service Developer Guide*. Warning: If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.For more information, see Encrypting archives in the *Amazon EventBridge User Guide*. Return type: dict Returns: **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** * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.InvalidEventPatternException" EventBridge / Client / untag_resource untag_resource ************** EventBridge.Client.untag_resource(**kwargs) Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge, rules and event buses can be tagged. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceARN='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the EventBridge resource from which you are removing tags. * **TagKeys** (*list*) -- **[REQUIRED]** The list of tag keys to remove from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ManagedRuleException" EventBridge / Client / list_api_destinations list_api_destinations ********************* EventBridge.Client.list_api_destinations(**kwargs) 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 ) Parameters: * **NamePrefix** (*string*) -- A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned. * **ConnectionArn** (*string*) -- The ARN of the connection specified for the API destination. * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- The maximum number of API destinations to include in the response. Return type: dict Returns: **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 that includes information about each 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 indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / delete_endpoint delete_endpoint *************** EventBridge.Client.delete_endpoint(**kwargs) Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the *Amazon EventBridge User Guide* . See also: AWS API Documentation **Request Syntax** response = client.delete_endpoint( Name='string' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the endpoint you want to delete. For example, ""Name ":"us-east-2-custom_bus_A-endpoint"".. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / list_archives list_archives ************* EventBridge.Client.list_archives(**kwargs) 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 ) Parameters: * **NamePrefix** (*string*) -- A name prefix to filter the archives returned. Only archives with name that match the prefix are returned. * **EventSourceArn** (*string*) -- The ARN of the event source associated with the archive. * **State** (*string*) -- The state of the archive. * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- The maximum number of results to return. Return type: dict Returns: **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) --* A token indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / describe_api_destination describe_api_destination ************************ EventBridge.Client.describe_api_destination(**kwargs) Retrieves details about an API destination. See also: AWS API Documentation **Request Syntax** response = client.describe_api_destination( Name='string' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the API destination to retrieve. Return type: dict Returns: **Response Syntax** { '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** * *(dict) --* * **ApiDestinationArn** *(string) --* The ARN of the API destination retrieved. * **Name** *(string) --* The name of the API destination retrieved. * **Description** *(string) --* The description for the API destination retrieved. * **ApiDestinationState** *(string) --* The state of the API destination retrieved. * **ConnectionArn** *(string) --* The ARN of the connection specified for the API destination retrieved. * **InvocationEndpoint** *(string) --* The URL to use to connect to the HTTP endpoint. * **HttpMethod** *(string) --* The method to use to connect to the HTTP endpoint. * **InvocationRateLimitPerSecond** *(integer) --* 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. * **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** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / get_waiter get_waiter ********** EventBridge.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" EventBridge / Client / enable_rule enable_rule *********** EventBridge.Client.enable_rule(**kwargs) 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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of 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. Returns: None **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ManagedRuleException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / list_rule_names_by_target list_rule_names_by_target ************************* EventBridge.Client.list_rule_names_by_target(**kwargs) 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. The maximum number of results per page for requests is 100. See also: AWS API Documentation **Request Syntax** response = client.list_rule_names_by_target( TargetArn='string', EventBusName='string', NextToken='string', Limit=123 ) Parameters: * **TargetArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the target resource. * **EventBusName** (*string*) -- The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used. * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- The maximum number of results to return. Return type: dict Returns: **Response Syntax** { 'RuleNames': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RuleNames** *(list) --* The names of the rules that can invoke the given target. * *(string) --* * **NextToken** *(string) --* A token indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ResourceNotFoundException" EventBridge / Client / delete_event_bus delete_event_bus **************** EventBridge.Client.delete_event_bus(**kwargs) 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' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the event bus to delete. Returns: None **Exceptions** * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ConcurrentModificationException" EventBridge / Client / list_replays list_replays ************ EventBridge.Client.list_replays(**kwargs) 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 ) Parameters: * **NamePrefix** (*string*) -- A name prefix to filter the replays returned. Only replays with name that match the prefix are returned. * **State** (*string*) -- The state of the replay. * **EventSourceArn** (*string*) -- The ARN of the archive from which the events are replayed. * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- The maximum number of replays to retrieve. Return type: dict Returns: **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) --* A token indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / list_partner_event_source_accounts list_partner_event_source_accounts ********************************** EventBridge.Client.list_partner_event_source_accounts(**kwargs) 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 ) Parameters: * **EventSourceName** (*string*) -- **[REQUIRED]** The name of the partner event source to display account information about. * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results. Return type: dict Returns: **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 indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / create_partner_event_source create_partner_event_source *************************** EventBridge.Client.create_partner_event_source(**kwargs) 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 *event_name* must be unique across all Amazon Web Services customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account. 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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the partner event source. This name must be unique and must be in the format >>``<>``<<. 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. * **Account** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source. Return type: dict Returns: **Response Syntax** { 'EventSourceArn': 'string' } **Response Structure** * *(dict) --* * **EventSourceArn** *(string) --* The ARN of the partner event source. **Exceptions** * "EventBridge.Client.exceptions.ResourceAlreadyExistsException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / list_partner_event_sources list_partner_event_sources ************************** EventBridge.Client.list_partner_event_sources(**kwargs) 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 ) Parameters: * **NamePrefix** (*string*) -- **[REQUIRED]** If you specify this, the results are limited to only those partner event sources that start with the string you specify. * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- pecifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results. Return type: dict Returns: **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 indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / describe_event_bus describe_event_bus ****************** EventBridge.Client.describe_event_bus(**kwargs) 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' ) Parameters: **Name** (*string*) -- The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed. Return type: dict Returns: **Response Syntax** { 'Name': 'string', 'Arn': 'string', 'Description': 'string', 'KmsKeyIdentifier': 'string', 'DeadLetterConfig': { 'Arn': 'string' }, 'Policy': 'string', 'LogConfig': { 'IncludeDetail': 'NONE'|'FULL', 'Level': 'OFF'|'ERROR'|'INFO'|'TRACE' }, 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **Name** *(string) --* The name of the event bus. Currently, this is always "default". * **Arn** *(string) --* The Amazon Resource Name (ARN) of the account permitted to write events to the current account. * **Description** *(string) --* The event bus description. * **KmsKeyIdentifier** *(string) --* The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified. For more information, see Data encryption in EventBridge in the *Amazon EventBridge User Guide*. * **DeadLetterConfig** *(dict) --* Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). For more information, see Using dead-letter queues to process undelivered events in the *EventBridge User Guide*. * **Arn** *(string) --* The ARN of the SQS queue specified as the target for the dead-letter queue. * **Policy** *(string) --* The policy that enables the external account to send events to your account. * **LogConfig** *(dict) --* The logging configuration settings for the event bus. For more information, see Configuring logs for event buses in the *EventBridge User Guide*. * **IncludeDetail** *(string) --* Whether EventBridge include detailed event information in the records it generates. Detailed data can be useful for troubleshooting and debugging. This information includes details of the event itself, as well as target details. For more information, see Including detail data in event bus logs in the *EventBridge User Guide*. * **Level** *(string) --* The level of logging detail to include. This applies to all log destinations for the event bus. For more information, see Specifying event bus log level in the *EventBridge User Guide*. * **CreationTime** *(datetime) --* The time the event bus was created. * **LastModifiedTime** *(datetime) --* The time the event bus was last modified. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / list_event_buses list_event_buses **************** EventBridge.Client.list_event_buses(**kwargs) 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 ) Parameters: * **NamePrefix** (*string*) -- Specifying this limits the results to only those event buses with names that start with the specified prefix. * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'EventBuses': [ { 'Name': 'string', 'Arn': 'string', 'Description': 'string', 'Policy': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **EventBuses** *(list) --* This list of event buses. * *(dict) --* An event bus receives events from a source, uses rules to evaluate them, applies any configured input transformation, and routes them to the appropriate target(s). 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. * **Description** *(string) --* The event bus description. * **Policy** *(string) --* The permissions policy of the event bus, describing which other Amazon Web Services accounts can write events to this event bus. * **CreationTime** *(datetime) --* The time the event bus was created. * **LastModifiedTime** *(datetime) --* The time the event bus was last modified. * **NextToken** *(string) --* A token indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / create_api_destination create_api_destination ********************** EventBridge.Client.create_api_destination(**kwargs) Creates an API destination, which is an HTTP invocation endpoint configured as a target for events. API destinations do not support private destinations, such as interface VPC endpoints. For more information, see API destinations in the *EventBridge User Guide*. 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 ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name for the API destination to create. * **Description** (*string*) -- A description for the API destination to create. * **ConnectionArn** (*string*) -- **[REQUIRED]** The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection. * **InvocationEndpoint** (*string*) -- **[REQUIRED]** The URL to the HTTP invocation endpoint for the API destination. * **HttpMethod** (*string*) -- **[REQUIRED]** The method to use for the request to the HTTP invocation endpoint. * **InvocationRateLimitPerSecond** (*integer*) -- The maximum number of requests per second to send to the HTTP invocation endpoint. Return type: dict Returns: **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** * "EventBridge.Client.exceptions.ResourceAlreadyExistsException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / list_endpoints list_endpoints ************** EventBridge.Client.list_endpoints(**kwargs) List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the *Amazon EventBridge User Guide* . See also: AWS API Documentation **Request Syntax** response = client.list_endpoints( NamePrefix='string', HomeRegion='string', NextToken='string', MaxResults=123 ) Parameters: * **NamePrefix** (*string*) -- A value that will return a subset of the endpoints associated with this account. For example, ""NamePrefix": "ABC"" will return all endpoints with "ABC" in the name. * **HomeRegion** (*string*) -- The primary Region of the endpoints associated with this account. For example ""HomeRegion": "us-east-1"". * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **MaxResults** (*integer*) -- The maximum number of results returned by the call. Return type: dict Returns: **Response Syntax** { 'Endpoints': [ { 'Name': 'string', 'Description': 'string', 'Arn': 'string', 'RoutingConfig': { 'FailoverConfig': { 'Primary': { 'HealthCheck': 'string' }, 'Secondary': { 'Route': 'string' } } }, 'ReplicationConfig': { 'State': 'ENABLED'|'DISABLED' }, 'EventBuses': [ { 'EventBusArn': 'string' }, ], 'RoleArn': 'string', 'EndpointId': 'string', 'EndpointUrl': 'string', 'State': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'StateReason': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Endpoints** *(list) --* The endpoints returned by the call. * *(dict) --* A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the *Amazon EventBridge User Guide* . * **Name** *(string) --* The name of the endpoint. * **Description** *(string) --* A description for the endpoint. * **Arn** *(string) --* The ARN of the endpoint. * **RoutingConfig** *(dict) --* The routing configuration of the endpoint. * **FailoverConfig** *(dict) --* The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered. * **Primary** *(dict) --* The main Region of the endpoint. * **HealthCheck** *(string) --* The ARN of the health check used by the endpoint to determine whether failover is triggered. * **Secondary** *(dict) --* The Region that events are routed to when failover is triggered or event replication is enabled. * **Route** *(string) --* Defines the secondary Region. * **ReplicationConfig** *(dict) --* Whether event replication was enabled or disabled for this endpoint. The default state is "ENABLED" which means you must supply a "RoleArn". If you don't have a "RoleArn" or you don't want event replication enabled, set the state to "DISABLED". * **State** *(string) --* The state of event replication. * **EventBuses** *(list) --* The event buses being used by the endpoint. * *(dict) --* The event buses the endpoint is associated with. * **EventBusArn** *(string) --* The ARN of the event bus the endpoint is associated with. * **RoleArn** *(string) --* The ARN of the role used by event replication for the endpoint. * **EndpointId** *(string) --* The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is "abcde.veo". * **EndpointUrl** *(string) --* The URL of the endpoint. * **State** *(string) --* The current state of the endpoint. * **StateReason** *(string) --* The reason the endpoint is in its current state. * **CreationTime** *(datetime) --* The time the endpoint was created. * **LastModifiedTime** *(datetime) --* The last time the endpoint was modified. * **NextToken** *(string) --* A token indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / put_permission put_permission ************** EventBridge.Client.put_permission(**kwargs) Running "PutPermission" permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified *event bus*. Amazon EventBridge 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' ) Parameters: * **EventBusName** (*string*) -- The name of the event bus associated with the rule. If you omit this, the default event bus is used. * **Action** (*string*) -- The action that you are enabling the other account to perform. * **Principal** (*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. * **StatementId** (*string*) -- An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this "StatementId" when you run RemovePermission. Note: Each "StatementId" must be unique. * **Condition** (*dict*) -- 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. * **Type** *(string) --* **[REQUIRED]** Specifies the type of condition. Currently the only supported value is "StringEquals". * **Key** *(string) --* **[REQUIRED]** Specifies the key for the condition. Currently the only supported key is "aws:PrincipalOrgID". * **Value** *(string) --* **[REQUIRED]** Specifies the value for the key. Currently, this must be the ID of the organization. * **Policy** (*string*) -- A JSON string that describes the permission policy statement. You can include a "Policy" parameter in the request instead of using the "StatementId", "Action", "Principal", or "Condition" parameters. Returns: None **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.PolicyLengthExceededException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / start_replay start_replay ************ EventBridge.Client.start_replay(**kwargs) 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', ] } ) Parameters: * **ReplayName** (*string*) -- **[REQUIRED]** The name of the replay to start. * **Description** (*string*) -- A description for the replay to start. * **EventSourceArn** (*string*) -- **[REQUIRED]** The ARN of the archive to replay events from. * **EventStartTime** (*datetime*) -- **[REQUIRED]** A time stamp for the time to start replaying events. Only events that occurred between the "EventStartTime" and "EventEndTime" are replayed. * **EventEndTime** (*datetime*) -- **[REQUIRED]** A time stamp for the time to stop replaying events. Only events that occurred between the "EventStartTime" and "EventEndTime" are replayed. * **Destination** (*dict*) -- **[REQUIRED]** A "ReplayDestination" object that includes details about the destination for the replay. * **Arn** *(string) --* **[REQUIRED]** The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive. * **FilterArns** *(list) --* A list of ARNs for rules to replay events to. * *(string) --* Return type: dict Returns: **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** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.ResourceAlreadyExistsException" * "EventBridge.Client.exceptions.InvalidEventPatternException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / remove_permission remove_permission ***************** EventBridge.Client.remove_permission(**kwargs) 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' ) Parameters: * **StatementId** (*string*) -- The statement ID corresponding to the account that is no longer allowed to put events to the default event bus. * **RemoveAllPermissions** (*boolean*) -- Specifies whether to remove all permissions. * **EventBusName** (*string*) -- The name of the event bus to revoke permissions for. If you omit this, the default event bus is used. Returns: None **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / cancel_replay cancel_replay ************* EventBridge.Client.cancel_replay(**kwargs) Cancels the specified replay. See also: AWS API Documentation **Request Syntax** response = client.cancel_replay( ReplayName='string' ) Parameters: **ReplayName** (*string*) -- **[REQUIRED]** The name of the replay to cancel. Return type: dict Returns: **Response Syntax** { 'ReplayArn': 'string', 'State': 'STARTING'|'RUNNING'|'CANCELLING'|'COMPLETED'|'CANCELLED'|'FAILED', 'StateReason': 'string' } **Response Structure** * *(dict) --* * **ReplayArn** *(string) --* The ARN of the replay to cancel. * **State** *(string) --* The current state of the replay. * **StateReason** *(string) --* The reason that the replay is in the current state. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.IllegalStatusException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / put_targets put_targets *********** EventBridge.Client.put_targets(**kwargs) 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. The maximum number of entries per request is 10. Note: Each rule can have up to five (5) targets associated with it at one time. For a list of services you can configure as targets for events, see EventBridge targets in the *Amazon EventBridge User Guide* . Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are: * "Amazon EBS CreateSnapshot API call" * "Amazon EC2 RebootInstances API call" * "Amazon EC2 StopInstances API call" * "Amazon 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 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*. Note: If you have an IAM role on a cross-account event bus target, a "PutTargets" call without a role on the same target (same "Id" and "Arn") will not remove the role. 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: * If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). * If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant. * If **InputPath** is specified in the form of JSONPath (for example, "$.detail"), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). * If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target. 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, 'Sqls': [ 'string', ] }, 'SageMakerPipelineParameters': { 'PipelineParameterList': [ { 'Name': 'string', 'Value': 'string' }, ] }, 'DeadLetterConfig': { 'Arn': 'string' }, 'RetryPolicy': { 'MaximumRetryAttempts': 123, 'MaximumEventAgeInSeconds': 123 }, 'AppSyncParameters': { 'GraphQLOperation': 'string' } }, ] ) Parameters: * **Rule** (*string*) -- **[REQUIRED]** The name of 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. * **Targets** (*list*) -- **[REQUIRED]** The targets to update or add 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) --* **[REQUIRED]** The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string. * **Arn** *(string) --* **[REQUIRED]** 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 may use JSON dot notation or 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." * *(string) --* * *(string) --* * **InputTemplate** *(string) --* **[REQUIRED]** 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*> If "InputTemplate" is a JSON object (surrounded by curly braces), the following restrictions apply: * The placeholder cannot be used as an object key. The following example shows the syntax for using "InputPathsMap" and "InputTemplate". ""InputTransformer":" "{" ""InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}," ""InputTemplate": " is in state "" "}" 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": " is in state \"\""" "}" 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": ,"myStatus": " is in state \"\""}'" "}" * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** Can be either "tag:" *tag-key* or "InstanceIds". * **Values** *(list) --* **[REQUIRED]** 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. * *(string) --* * **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) --* **[REQUIRED]** 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 with 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) --* **[REQUIRED]** Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets. * *(string) --* * **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. * *(string) --* * **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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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 endpoint or EventBridge ApiDestination. If you specify an API Gateway 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 API or EventBridge ApiDestination path wildcards ("*"). * *(string) --* * **HeaderParameters** *(dict) --* The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination. * *(string) --* * *(string) --* * **QueryStringParameters** *(dict) --* The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination. * *(string) --* * *(string) --* * **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) --* **[REQUIRED]** 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. * **Sqls** *(list) --* One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back. * *(string) --* A single Redshift SQL * **SageMakerPipelineParameters** *(dict) --* Contains the SageMaker AI Model Building Pipeline parameters to start execution of a SageMaker AI Model Building Pipeline. If you specify a SageMaker AI 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 AI Model Building Pipeline execution. * *(dict) --* Name/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline. * **Name** *(string) --* **[REQUIRED]** Name of parameter to start execution of a SageMaker AI Model Building Pipeline. * **Value** *(string) --* **[REQUIRED]** Value of parameter to start execution of a SageMaker AI 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 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. * **AppSyncParameters** *(dict) --* Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API. * **GraphQLOperation** *(string) --* The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service. For more information, see Operations in the *AppSync User Guide*. Return type: dict Returns: **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** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.ManagedRuleException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / test_event_pattern test_event_pattern ****************** EventBridge.Client.test_event_pattern(**kwargs) 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' ) Parameters: * **EventPattern** (*string*) -- **[REQUIRED]** The event pattern. For more information, see Events and Event Patterns in the *Amazon EventBridge User Guide* . * **Event** (*string*) -- **[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: * "id" * "account" * "source" * "time" * "region" * "resources" * "detail-type" Return type: dict Returns: **Response Syntax** { 'Result': True|False } **Response Structure** * *(dict) --* * **Result** *(boolean) --* Indicates whether the event matches the event pattern. **Exceptions** * "EventBridge.Client.exceptions.InvalidEventPatternException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / describe_connection describe_connection ******************* EventBridge.Client.describe_connection(**kwargs) Retrieves details about a connection. See also: AWS API Documentation **Request Syntax** response = client.describe_connection( Name='string' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the connection to retrieve. Return type: dict Returns: **Response Syntax** { 'ConnectionArn': 'string', 'Name': 'string', 'Description': 'string', 'InvocationConnectivityParameters': { 'ResourceParameters': { 'ResourceConfigurationArn': 'string', 'ResourceAssociationArn': 'string' } }, 'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY', 'StateReason': 'string', 'AuthorizationType': 'BASIC'|'OAUTH_CLIENT_CREDENTIALS'|'API_KEY', 'SecretArn': 'string', 'KmsKeyIdentifier': '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 }, ] }, 'ConnectivityParameters': { 'ResourceParameters': { 'ResourceConfigurationArn': 'string', 'ResourceAssociationArn': 'string' } } }, '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 retrieved. * **Name** *(string) --* The name of the connection retrieved. * **Description** *(string) --* The description for the connection retrieved. * **InvocationConnectivityParameters** *(dict) --* For connections to private APIs The parameters EventBridge uses to invoke the resource endpoint. For more information, see Connecting to private APIs in the *Amazon EventBridge User Guide* . * **ResourceParameters** *(dict) --* The parameters for EventBridge to use when invoking the resource endpoint. * **ResourceConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration for the private API. * **ResourceAssociationArn** *(string) --* For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. For more information, see Managing service network resource associations for connections in the *Amazon EventBridge User Guide* . * **ConnectionState** *(string) --* The state of the connection retrieved. * **StateReason** *(string) --* The reason that the connection is in the current connection state. * **AuthorizationType** *(string) --* The type of authorization specified for the connection. * **SecretArn** *(string) --* The ARN of the secret created from the authorization parameters specified for the connection. * **KmsKeyIdentifier** *(string) --* The identifier of the KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified. For more information, see Encrypting connections in the *Amazon EventBridge User Guide*. * **AuthParameters** *(dict) --* The parameters to use for authorization for the connection. * **BasicAuthParameters** *(dict) --* The authorization parameters for Basic authorization. * **Username** *(string) --* The user name to use for Basic authorization. * **OAuthParameters** *(dict) --* The OAuth parameters to use for authorization. * **ClientParameters** *(dict) --* Details about the client parameters returned when OAuth is specified as the authorization type. * **ClientID** *(string) --* The client ID associated with the response to the connection request. * **AuthorizationEndpoint** *(string) --* The URL to the HTTP endpoint that authorized the request. * **HttpMethod** *(string) --* The method used to connect to the HTTP endpoint. * **OAuthHttpParameters** *(dict) --* The additional HTTP parameters used for the OAuth authorization request. * **HeaderParameters** *(list) --* Any additional header parameters for the connection. * *(dict) --* Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is a secret. * **QueryStringParameters** *(list) --* Any additional query string parameters for the connection. * *(dict) --* Any 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. * **Key** *(string) --* The key for a query string parameter. * **Value** *(string) --* The value associated with the key for the query string parameter. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **BodyParameters** *(list) --* Any additional body string parameters for the connection. * *(dict) --* Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **ApiKeyAuthParameters** *(dict) --* The API Key parameters to use for authorization. * **ApiKeyName** *(string) --* The name of the header to use for the "APIKeyValue" used for authorization. * **InvocationHttpParameters** *(dict) --* Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. * **HeaderParameters** *(list) --* Any additional header parameters for the connection. * *(dict) --* Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is a secret. * **QueryStringParameters** *(list) --* Any additional query string parameters for the connection. * *(dict) --* Any 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. * **Key** *(string) --* The key for a query string parameter. * **Value** *(string) --* The value associated with the key for the query string parameter. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **BodyParameters** *(list) --* Any additional body string parameters for the connection. * *(dict) --* Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **ConnectivityParameters** *(dict) --* For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. For more information, see Authorization methods for connections in the *Amazon EventBridge User Guide* . * **ResourceParameters** *(dict) --* The parameters for EventBridge to use when invoking the resource endpoint. * **ResourceConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration for the private API. * **ResourceAssociationArn** *(string) --* For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. For more information, see Managing service network resource associations for connections in the *Amazon EventBridge User Guide* . * **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** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / close close ***** EventBridge.Client.close() Closes underlying endpoint connections. EventBridge / Client / deauthorize_connection deauthorize_connection ********************** EventBridge.Client.deauthorize_connection(**kwargs) 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' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the connection to remove authorization from. Return type: dict Returns: **Response Syntax** { 'ConnectionArn': 'string', 'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY', '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 authorization was removed from. * **ConnectionState** *(string) --* The state of 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 updated. * **LastAuthorizedTime** *(datetime) --* A time stamp for the time that the connection was last authorized. **Exceptions** * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / delete_api_destination delete_api_destination ********************** EventBridge.Client.delete_api_destination(**kwargs) Deletes the specified API destination. See also: AWS API Documentation **Request Syntax** response = client.delete_api_destination( Name='string' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the destination to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / put_partner_events put_partner_events ****************** EventBridge.Client.put_partner_events(**kwargs) 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. For information on calculating event batch size, see Calculating EventBridge PutEvents event entry size in the *EventBridge User Guide*. 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' }, ] ) Parameters: **Entries** (*list*) -- **[REQUIRED]** The list of events to write to the event bus. * *(dict) --* The details about an event generated by an SaaS partner. * **Time** *(datetime) --* The date and time of the event. * **Source** *(string) --* The event source that is generating the entry. Note: "Detail", "DetailType", and "Source" are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which *none* of the entries have each of these properties, EventBridge fails the entire request. * **Resources** *(list) --* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present. * *(string) --* * **DetailType** *(string) --* A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail. Note: "Detail", "DetailType", and "Source" are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which *none* of the entries have each of these properties, EventBridge fails the entire request. * **Detail** *(string) --* A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested sub-objects. Note: "Detail", "DetailType", and "Source" are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which *none* of the entries have each of these properties, EventBridge fails the entire request. Return type: dict Returns: **Response Syntax** { 'FailedEntryCount': 123, 'Entries': [ { 'EventId': 'string', 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **FailedEntryCount** *(integer) --* The number of events from this operation that could not be written to the partner event bus. * **Entries** *(list) --* The results for each event entry the partner submitted in this request. If the event was successfully submitted, 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. For each record, the index of the response element is the same as the index in the request array. * *(dict) --* The result of an event entry the partner submitted in this request. If the event was successfully submitted, 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. * **EventId** *(string) --* The ID of the event. * **ErrorCode** *(string) --* The error code that indicates why the event submission failed. * **ErrorMessage** *(string) --* The error message that explains why the event submission failed. **Exceptions** * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / delete_connection delete_connection ***************** EventBridge.Client.delete_connection(**kwargs) Deletes a connection. See also: AWS API Documentation **Request Syntax** response = client.delete_connection( Name='string' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the connection to delete. Return type: dict Returns: **Response Syntax** { 'ConnectionArn': 'string', 'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY', '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 deleted. * **ConnectionState** *(string) --* The state of the connection before it was deleted. * **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 before it was deleted. * **LastAuthorizedTime** *(datetime) --* A time stamp for the time that the connection was last authorized before it wa deleted. **Exceptions** * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / describe_rule describe_rule ************* EventBridge.Client.describe_rule(**kwargs) 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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of 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. Return type: dict Returns: **Response Syntax** { 'Name': 'string', 'Arn': 'string', 'EventPattern': 'string', 'ScheduleExpression': 'string', 'State': 'ENABLED'|'DISABLED'|'ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS', '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** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / update_api_destination update_api_destination ********************** EventBridge.Client.update_api_destination(**kwargs) 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 ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the API destination to update. * **Description** (*string*) -- The name of the API destination to update. * **ConnectionArn** (*string*) -- The ARN of the connection to use for the API destination. * **InvocationEndpoint** (*string*) -- The URL to the endpoint to use for the API destination. * **HttpMethod** (*string*) -- The method to use for the API destination. * **InvocationRateLimitPerSecond** (*integer*) -- The maximum number of invocations per second to send to the API destination. Return type: dict Returns: **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** * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.LimitExceededException" EventBridge / Client / describe_archive describe_archive **************** EventBridge.Client.describe_archive(**kwargs) Retrieves details about an archive. See also: AWS API Documentation **Request Syntax** response = client.describe_archive( ArchiveName='string' ) Parameters: **ArchiveName** (*string*) -- **[REQUIRED]** The name of the archive to retrieve. Return type: dict Returns: **Response Syntax** { 'ArchiveArn': 'string', 'ArchiveName': 'string', 'EventSourceArn': 'string', 'Description': 'string', 'EventPattern': 'string', 'State': 'ENABLED'|'DISABLED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED', 'StateReason': 'string', 'KmsKeyIdentifier': 'string', 'RetentionDays': 123, 'SizeBytes': 123, 'EventCount': 123, 'CreationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **ArchiveArn** *(string) --* The ARN of the archive. * **ArchiveName** *(string) --* The name of the archive. * **EventSourceArn** *(string) --* The ARN of the event source associated with the archive. * **Description** *(string) --* The description of the archive. * **EventPattern** *(string) --* The event pattern used to filter events sent to the archive. * **State** *(string) --* The state of the archive. * **StateReason** *(string) --* The reason that the archive is in the state. * **KmsKeyIdentifier** *(string) --* The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified. For more information, see Encrypting archives in the *Amazon EventBridge User Guide*. * **RetentionDays** *(integer) --* The number of days to retain events for in the archive. * **SizeBytes** *(integer) --* The size of the archive in bytes. * **EventCount** *(integer) --* The number of events in the archive. * **CreationTime** *(datetime) --* The time at which the archive was created. **Exceptions** * "EventBridge.Client.exceptions.ResourceAlreadyExistsException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / describe_endpoint describe_endpoint ***************** EventBridge.Client.describe_endpoint(**kwargs) Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the *Amazon EventBridge User Guide* . See also: AWS API Documentation **Request Syntax** response = client.describe_endpoint( Name='string', HomeRegion='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the endpoint you want to get information about. For example, ""Name":"us-east-2-custom_bus_A-endpoint"". * **HomeRegion** (*string*) -- The primary Region of the endpoint you want to get information about. For example ""HomeRegion": "us-east-1"". Return type: dict Returns: **Response Syntax** { 'Name': 'string', 'Description': 'string', 'Arn': 'string', 'RoutingConfig': { 'FailoverConfig': { 'Primary': { 'HealthCheck': 'string' }, 'Secondary': { 'Route': 'string' } } }, 'ReplicationConfig': { 'State': 'ENABLED'|'DISABLED' }, 'EventBuses': [ { 'EventBusArn': 'string' }, ], 'RoleArn': 'string', 'EndpointId': 'string', 'EndpointUrl': 'string', 'State': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'StateReason': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **Name** *(string) --* The name of the endpoint you asked for information about. * **Description** *(string) --* The description of the endpoint you asked for information about. * **Arn** *(string) --* The ARN of the endpoint you asked for information about. * **RoutingConfig** *(dict) --* The routing configuration of the endpoint you asked for information about. * **FailoverConfig** *(dict) --* The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered. * **Primary** *(dict) --* The main Region of the endpoint. * **HealthCheck** *(string) --* The ARN of the health check used by the endpoint to determine whether failover is triggered. * **Secondary** *(dict) --* The Region that events are routed to when failover is triggered or event replication is enabled. * **Route** *(string) --* Defines the secondary Region. * **ReplicationConfig** *(dict) --* Whether replication is enabled or disabled for the endpoint you asked for information about. * **State** *(string) --* The state of event replication. * **EventBuses** *(list) --* The event buses being used by the endpoint you asked for information about. * *(dict) --* The event buses the endpoint is associated with. * **EventBusArn** *(string) --* The ARN of the event bus the endpoint is associated with. * **RoleArn** *(string) --* The ARN of the role used by the endpoint you asked for information about. * **EndpointId** *(string) --* The ID of the endpoint you asked for information about. * **EndpointUrl** *(string) --* The URL of the endpoint you asked for information about. * **State** *(string) --* The current state of the endpoint you asked for information about. * **StateReason** *(string) --* The reason the endpoint you asked for information about is in its current state. * **CreationTime** *(datetime) --* The time the endpoint you asked for information about was created. * **LastModifiedTime** *(datetime) --* The last time the endpoint you asked for information about was modified. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / update_endpoint update_endpoint *************** EventBridge.Client.update_endpoint(**kwargs) Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the *Amazon EventBridge User Guide* . See also: AWS API Documentation **Request Syntax** response = client.update_endpoint( Name='string', Description='string', RoutingConfig={ 'FailoverConfig': { 'Primary': { 'HealthCheck': 'string' }, 'Secondary': { 'Route': 'string' } } }, ReplicationConfig={ 'State': 'ENABLED'|'DISABLED' }, EventBuses=[ { 'EventBusArn': 'string' }, ], RoleArn='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the endpoint you want to update. * **Description** (*string*) -- A description for the endpoint. * **RoutingConfig** (*dict*) -- Configure the routing policy, including the health check and secondary Region. * **FailoverConfig** *(dict) --* **[REQUIRED]** The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered. * **Primary** *(dict) --* **[REQUIRED]** The main Region of the endpoint. * **HealthCheck** *(string) --* **[REQUIRED]** The ARN of the health check used by the endpoint to determine whether failover is triggered. * **Secondary** *(dict) --* **[REQUIRED]** The Region that events are routed to when failover is triggered or event replication is enabled. * **Route** *(string) --* **[REQUIRED]** Defines the secondary Region. * **ReplicationConfig** (*dict*) -- Whether event replication was enabled or disabled by this request. * **State** *(string) --* The state of event replication. * **EventBuses** (*list*) -- Define event buses used for replication. * *(dict) --* The event buses the endpoint is associated with. * **EventBusArn** *(string) --* **[REQUIRED]** The ARN of the event bus the endpoint is associated with. * **RoleArn** (*string*) -- The ARN of the role used by event replication for this request. Return type: dict Returns: **Response Syntax** { 'Name': 'string', 'Arn': 'string', 'RoutingConfig': { 'FailoverConfig': { 'Primary': { 'HealthCheck': 'string' }, 'Secondary': { 'Route': 'string' } } }, 'ReplicationConfig': { 'State': 'ENABLED'|'DISABLED' }, 'EventBuses': [ { 'EventBusArn': 'string' }, ], 'RoleArn': 'string', 'EndpointId': 'string', 'EndpointUrl': 'string', 'State': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **Name** *(string) --* The name of the endpoint you updated in this request. * **Arn** *(string) --* The ARN of the endpoint you updated in this request. * **RoutingConfig** *(dict) --* The routing configuration you updated in this request. * **FailoverConfig** *(dict) --* The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered. * **Primary** *(dict) --* The main Region of the endpoint. * **HealthCheck** *(string) --* The ARN of the health check used by the endpoint to determine whether failover is triggered. * **Secondary** *(dict) --* The Region that events are routed to when failover is triggered or event replication is enabled. * **Route** *(string) --* Defines the secondary Region. * **ReplicationConfig** *(dict) --* Whether event replication was enabled or disabled for the endpoint you updated in this request. * **State** *(string) --* The state of event replication. * **EventBuses** *(list) --* The event buses used for replication for the endpoint you updated in this request. * *(dict) --* The event buses the endpoint is associated with. * **EventBusArn** *(string) --* The ARN of the event bus the endpoint is associated with. * **RoleArn** *(string) --* The ARN of the role used by event replication for the endpoint you updated in this request. * **EndpointId** *(string) --* The ID of the endpoint you updated in this request. * **EndpointUrl** *(string) --* The URL of the endpoint you updated in this request. * **State** *(string) --* The state of the endpoint you updated in this request. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / list_rules list_rules ********** EventBridge.Client.list_rules(**kwargs) Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. The maximum number of results per page for requests is 100. 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 ) Parameters: * **NamePrefix** (*string*) -- The prefix matching the rule name. * **EventBusName** (*string*) -- The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used. * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- The maximum number of results to return. Return type: dict Returns: **Response Syntax** { 'Rules': [ { 'Name': 'string', 'Arn': 'string', 'EventPattern': 'string', 'State': 'ENABLED'|'DISABLED'|'ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS', '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. Valid values include: * "DISABLED": The rule is disabled. EventBridge does not match any events against the rule. * "ENABLED": The rule is enabled. EventBridge matches events against the rule, *except* for Amazon Web Services management events delivered through CloudTrail. * "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS": The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail. Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the *CloudTrail User Guide*, and Filtering management events from Amazon Web Services services in the *Amazon EventBridge User Guide* . This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses. * **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) --* A token indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ResourceNotFoundException" EventBridge / Client / tag_resource tag_resource ************ EventBridge.Client.tag_resource(**kwargs) 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' }, ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the EventBridge resource that you're adding tags to. * **Tags** (*list*) -- **[REQUIRED]** The list of key-value pairs to associate with the resource. * *(dict) --* A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging. * **Key** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** The value for the specified tag key. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ManagedRuleException" EventBridge / Client / update_event_bus update_event_bus **************** EventBridge.Client.update_event_bus(**kwargs) Updates the specified event bus. See also: AWS API Documentation **Request Syntax** response = client.update_event_bus( Name='string', KmsKeyIdentifier='string', Description='string', DeadLetterConfig={ 'Arn': 'string' }, LogConfig={ 'IncludeDetail': 'NONE'|'FULL', 'Level': 'OFF'|'ERROR'|'INFO'|'TRACE' } ) Parameters: * **Name** (*string*) -- The name of the event bus. * **KmsKeyIdentifier** (*string*) -- The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus. For more information, see Identify and view keys in the *Key Management Service Developer Guide*. Note: Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if: * You call "CreateDiscoverer" on an event bus set to use a customer managed key for encryption. * You call "UpdatedEventBus" to set a customer managed key on an event bus with schema discovery enabled. To enable schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Encrypting events in the *Amazon EventBridge User Guide*. Warning: If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.For more information, see Encrypting archives in the *Amazon EventBridge User Guide*. * **Description** (*string*) -- The event bus description. * **DeadLetterConfig** (*dict*) -- Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). For more information, see Using dead-letter queues to process undelivered events in the *EventBridge User Guide*. * **Arn** *(string) --* The ARN of the SQS queue specified as the target for the dead-letter queue. * **LogConfig** (*dict*) -- The logging configuration settings for the event bus. For more information, see Configuring logs for event buses in the *EventBridge User Guide*. * **IncludeDetail** *(string) --* Whether EventBridge include detailed event information in the records it generates. Detailed data can be useful for troubleshooting and debugging. This information includes details of the event itself, as well as target details. For more information, see Including detail data in event bus logs in the *EventBridge User Guide*. * **Level** *(string) --* The level of logging detail to include. This applies to all log destinations for the event bus. For more information, see Specifying event bus log level in the *EventBridge User Guide*. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Name': 'string', 'KmsKeyIdentifier': 'string', 'Description': 'string', 'DeadLetterConfig': { 'Arn': 'string' }, 'LogConfig': { 'IncludeDetail': 'NONE'|'FULL', 'Level': 'OFF'|'ERROR'|'INFO'|'TRACE' } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The event bus Amazon Resource Name (ARN). * **Name** *(string) --* The event bus name. * **KmsKeyIdentifier** *(string) --* The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified. For more information, see Data encryption in EventBridge in the *Amazon EventBridge User Guide*. * **Description** *(string) --* The event bus description. * **DeadLetterConfig** *(dict) --* Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). For more information, see Using dead-letter queues to process undelivered events in the *EventBridge User Guide*. * **Arn** *(string) --* The ARN of the SQS queue specified as the target for the dead-letter queue. * **LogConfig** *(dict) --* The logging configuration settings for the event bus. For more information, see Configuring logs for event buses in the *EventBridge User Guide*. * **IncludeDetail** *(string) --* Whether EventBridge include detailed event information in the records it generates. Detailed data can be useful for troubleshooting and debugging. This information includes details of the event itself, as well as target details. For more information, see Including detail data in event bus logs in the *EventBridge User Guide*. * **Level** *(string) --* The level of logging detail to include. This applies to all log destinations for the event bus. For more information, see Specifying event bus log level in the *EventBridge User Guide*. **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / activate_event_source activate_event_source ********************* EventBridge.Client.activate_event_source(**kwargs) 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' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the partner event source to activate. Returns: None **Exceptions** * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.InvalidStateException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.OperationDisabledException" EventBridge / Client / update_connection update_connection ***************** EventBridge.Client.update_connection(**kwargs) 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 }, ] }, 'ConnectivityParameters': { 'ResourceParameters': { 'ResourceConfigurationArn': 'string' } } }, InvocationConnectivityParameters={ 'ResourceParameters': { 'ResourceConfigurationArn': 'string' } }, KmsKeyIdentifier='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the connection to update. * **Description** (*string*) -- A description for the connection. * **AuthorizationType** (*string*) -- The type of authorization to use for the connection. * **AuthParameters** (*dict*) -- The authorization parameters to use for the connection. * **BasicAuthParameters** *(dict) --* The authorization parameters for Basic authorization. * **Username** *(string) --* The user name to use for Basic authorization. * **Password** *(string) --* The password associated with the user name to use for Basic authorization. * **OAuthParameters** *(dict) --* The authorization parameters for OAuth authorization. * **ClientParameters** *(dict) --* The client parameters to use for the connection when OAuth is specified as the authorization type. * **ClientID** *(string) --* The client ID to use for OAuth authorization. * **ClientSecret** *(string) --* The client secret assciated with the client ID to use for OAuth authorization. * **AuthorizationEndpoint** *(string) --* The URL to the authorization endpoint when OAuth is specified as the authorization type. * **HttpMethod** *(string) --* The method used to connect to the HTTP endpoint. * **OAuthHttpParameters** *(dict) --* The additional HTTP parameters used for the OAuth authorization request. * **HeaderParameters** *(list) --* Any additional header parameters for the connection. * *(dict) --* Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is a secret. * **QueryStringParameters** *(list) --* Any additional query string parameters for the connection. * *(dict) --* Any 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. * **Key** *(string) --* The key for a query string parameter. * **Value** *(string) --* The value associated with the key for the query string parameter. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **BodyParameters** *(list) --* Any additional body string parameters for the connection. * *(dict) --* Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **ApiKeyAuthParameters** *(dict) --* The authorization parameters for API key authorization. * **ApiKeyName** *(string) --* The name of the API key to use for authorization. * **ApiKeyValue** *(string) --* The value associated with the API key to use for authorization. * **InvocationHttpParameters** *(dict) --* The additional parameters to use for the connection. * **HeaderParameters** *(list) --* Any additional header parameters for the connection. * *(dict) --* Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is a secret. * **QueryStringParameters** *(list) --* Any additional query string parameters for the connection. * *(dict) --* Any 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. * **Key** *(string) --* The key for a query string parameter. * **Value** *(string) --* The value associated with the key for the query string parameter. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **BodyParameters** *(list) --* Any additional body string parameters for the connection. * *(dict) --* Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB. * **Key** *(string) --* The key for the parameter. * **Value** *(string) --* The value associated with the key. * **IsValueSecret** *(boolean) --* Specifies whether the value is secret. * **ConnectivityParameters** *(dict) --* If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint. For more information, see Authorization methods for connections in the *Amazon EventBridge User Guide* . * **ResourceParameters** *(dict) --* **[REQUIRED]** The parameters for EventBridge to use when invoking the resource endpoint. * **ResourceConfigurationArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. * **InvocationConnectivityParameters** (*dict*) -- For connections to private APIs, the parameters to use for invoking the API. For more information, see Connecting to private APIs in the *Amazon EventBridge User Guide* . * **ResourceParameters** *(dict) --* **[REQUIRED]** The parameters for EventBridge to use when invoking the resource endpoint. * **ResourceConfigurationArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. * **KmsKeyIdentifier** (*string*) -- The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection. For more information, see Identify and view keys in the *Key Management Service Developer Guide*. Return type: dict Returns: **Response Syntax** { 'ConnectionArn': 'string', 'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY', '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** * "EventBridge.Client.exceptions.ConcurrentModificationException" * "EventBridge.Client.exceptions.ResourceNotFoundException" * "EventBridge.Client.exceptions.InternalException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.AccessDeniedException" * "EventBridge.Client.exceptions.ThrottlingException" EventBridge / Client / list_connections list_connections **************** EventBridge.Client.list_connections(**kwargs) 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'|'ACTIVE'|'FAILED_CONNECTIVITY', NextToken='string', Limit=123 ) Parameters: * **NamePrefix** (*string*) -- A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned. * **ConnectionState** (*string*) -- The state of the connection. * **NextToken** (*string*) -- The token returned by a previous call, which you can use to retrieve the next set of results. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. * **Limit** (*integer*) -- The maximum number of connections to return. Return type: dict Returns: **Response Syntax** { 'Connections': [ { 'ConnectionArn': 'string', 'Name': 'string', 'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY', '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. Note: OAUTH tokens are refreshed when a 401 or 407 response is returned. * **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 indicating there are more results available. If there are no more results, no token is included in the response. The value of "nextToken" is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an "HTTP 400 InvalidToken" error. **Exceptions** * "EventBridge.Client.exceptions.InternalException" EventBridge / Client / create_endpoint create_endpoint *************** EventBridge.Client.create_endpoint(**kwargs) Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state. See also: AWS API Documentation **Request Syntax** response = client.create_endpoint( Name='string', Description='string', RoutingConfig={ 'FailoverConfig': { 'Primary': { 'HealthCheck': 'string' }, 'Secondary': { 'Route': 'string' } } }, ReplicationConfig={ 'State': 'ENABLED'|'DISABLED' }, EventBuses=[ { 'EventBusArn': 'string' }, ], RoleArn='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the global endpoint. For example, ""Name":"us- east-2-custom_bus_A-endpoint"". * **Description** (*string*) -- A description of the global endpoint. * **RoutingConfig** (*dict*) -- **[REQUIRED]** Configure the routing policy, including the health check and secondary Region.. * **FailoverConfig** *(dict) --* **[REQUIRED]** The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered. * **Primary** *(dict) --* **[REQUIRED]** The main Region of the endpoint. * **HealthCheck** *(string) --* **[REQUIRED]** The ARN of the health check used by the endpoint to determine whether failover is triggered. * **Secondary** *(dict) --* **[REQUIRED]** The Region that events are routed to when failover is triggered or event replication is enabled. * **Route** *(string) --* **[REQUIRED]** Defines the secondary Region. * **ReplicationConfig** (*dict*) -- Enable or disable event replication. The default state is "ENABLED" which means you must supply a "RoleArn". If you don't have a "RoleArn" or you don't want event replication enabled, set the state to "DISABLED". * **State** *(string) --* The state of event replication. * **EventBuses** (*list*) -- **[REQUIRED]** Define the event buses used. Warning: The names of the event buses must be identical in each Region. * *(dict) --* The event buses the endpoint is associated with. * **EventBusArn** *(string) --* **[REQUIRED]** The ARN of the event bus the endpoint is associated with. * **RoleArn** (*string*) -- The ARN of the role used for replication. Return type: dict Returns: **Response Syntax** { 'Name': 'string', 'Arn': 'string', 'RoutingConfig': { 'FailoverConfig': { 'Primary': { 'HealthCheck': 'string' }, 'Secondary': { 'Route': 'string' } } }, 'ReplicationConfig': { 'State': 'ENABLED'|'DISABLED' }, 'EventBuses': [ { 'EventBusArn': 'string' }, ], 'RoleArn': 'string', 'State': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **Name** *(string) --* The name of the endpoint that was created by this request. * **Arn** *(string) --* The ARN of the endpoint that was created by this request. * **RoutingConfig** *(dict) --* The routing configuration defined by this request. * **FailoverConfig** *(dict) --* The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered. * **Primary** *(dict) --* The main Region of the endpoint. * **HealthCheck** *(string) --* The ARN of the health check used by the endpoint to determine whether failover is triggered. * **Secondary** *(dict) --* The Region that events are routed to when failover is triggered or event replication is enabled. * **Route** *(string) --* Defines the secondary Region. * **ReplicationConfig** *(dict) --* Whether event replication was enabled or disabled by this request. * **State** *(string) --* The state of event replication. * **EventBuses** *(list) --* The event buses used by this request. * *(dict) --* The event buses the endpoint is associated with. * **EventBusArn** *(string) --* The ARN of the event bus the endpoint is associated with. * **RoleArn** *(string) --* The ARN of the role used by event replication for this request. * **State** *(string) --* The state of the endpoint that was created by this request. **Exceptions** * "EventBridge.Client.exceptions.ResourceAlreadyExistsException" * "EventBridge.Client.exceptions.LimitExceededException" * "EventBridge.Client.exceptions.InternalException"