Amazon EventBridge

2020/09/21 - Amazon EventBridge - 2 updated api methods

Changes  Update events client to latest version

ListTargetsByRule (updated) Link ¶
Changes (response)
{'Targets': {'RedshiftDataParameters': {'Database': 'string',
                                        'DbUser': 'string',
                                        'SecretManagerArn': 'string',
                                        'Sql': 'string',
                                        'StatementName': 'string',
                                        'WithEvent': 'boolean'}}}

Lists the targets assigned to the specified rule.

See also: AWS API Documentation

Request Syntax

client.list_targets_by_rule(
    Rule='string',
    EventBusName='string',
    NextToken='string',
    Limit=123
)
type Rule:

string

param Rule:

[REQUIRED]

The name of the rule.

type EventBusName:

string

param EventBusName:

The event bus associated with the rule. If you omit this, the default event bus is used.

type NextToken:

string

param NextToken:

The token returned by a previous call to retrieve the next set of results.

type Limit:

integer

param Limit:

The maximum number of results to return.

rtype:

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',
                'NetworkConfiguration': {
                    'awsvpcConfiguration': {
                        'Subnets': [
                            'string',
                        ],
                        'SecurityGroups': [
                            'string',
                        ],
                        'AssignPublicIp': 'ENABLED'|'DISABLED'
                    }
                },
                'PlatformVersion': 'string',
                'Group': '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
            }
        },
    ],
    '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 AWS Accounts in the Amazon EventBridge User Guide.

        • Id (string) --

          The ID of the target.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the target.

        • RoleArn (string) --

          The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.

        • Input (string) --

          Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

        • InputPath (string) --

          The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.

        • InputTransformer (dict) --

          Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.

          • InputPathsMap (dict) --

            Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

            InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

            The keys cannot start with "AWS."

            • (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> The InputTemplate must be valid JSON.

            If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

            • The placeholder cannot be used as an object key.

            • Object values cannot include quote marks.

            The following example shows the syntax for using InputPathsMap and InputTemplate.

            "InputTransformer":

            {

            "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

            "InputTemplate": "<instance> is in state <status>"

            }

            To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

            "InputTransformer":

            {

            "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

            "InputTemplate": "<instance> is in state \"<status>\""

            }

        • 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 AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

          • NetworkConfiguration (dict) --

            Use this structure if the 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 AWS 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.

        • BatchParameters (dict) --

          If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.

          • JobDefinition (string) --

            The ARN or name of the job definition to use if the event target is an AWS 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 AWS 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 AWS 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 AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

            • Attempts (integer) --

              The number of times to attempt to retry, if the job fails. Valid values are 1–10.

        • SqsParameters (dict) --

          Contains the message group ID to use when the target is a FIFO queue.

          If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

          • MessageGroupId (string) --

            The FIFO message group ID to use as the target.

        • HttpParameters (dict) --

          Contains the HTTP parameters to use when the target is a API Gateway REST endpoint.

          If you specify an API Gateway REST API as a target, you can use this parameter to specify headers, path parameter, query string keys/values as part of your target invoking request.

          • PathParameterValues (list) --

            The path parameter values to be used to populate API Gateway REST API path wildcards ("*").

            • (string) --

          • HeaderParameters (dict) --

            The headers that need to be sent as part of request invoking the API Gateway REST API.

            • (string) --

              • (string) --

          • QueryStringParameters (dict) --

            The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.

            • (string) --

              • (string) --

        • RedshiftDataParameters (dict) --

          Contains the Redshift Data API parameters to use when the target is a Redshift cluster.

          If you specify a Redshift Cluster as a Target, you can use this to specify parameters to invoke the 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 AWS 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.

    • NextToken (string) --

      Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

PutTargets (updated) Link ¶
Changes (request)
{'Targets': {'RedshiftDataParameters': {'Database': 'string',
                                        'DbUser': 'string',
                                        'SecretManagerArn': 'string',
                                        'Sql': 'string',
                                        'StatementName': 'string',
                                        'WithEvent': 'boolean'}}}

Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

You can configure the following as targets for Events:

  • EC2 instances

  • SSM Run Command

  • SSM Automation

  • AWS Lambda functions

  • Data streams in Amazon Kinesis Data Streams

  • Data delivery streams in Amazon Kinesis Data Firehose

  • Amazon ECS tasks

  • AWS Step Functions state machines

  • AWS Batch jobs

  • AWS CodeBuild projects

  • Pipelines in AWS CodePipeline

  • Amazon Inspector assessment templates

  • Amazon SNS topics

  • Amazon SQS queues, including FIFO queues

  • The default event bus of another AWS account

  • Amazon API Gateway REST APIs

  • Redshift Clusters to invoke Data API ExecuteStatement on

Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.

For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.

If another AWS 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 (CloudWatch Events) Pricing.

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 AWS Accounts in the Amazon EventBridge User Guide.

For more information about enabling cross-account events, see PutPermission.

Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

  • 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

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',
                'NetworkConfiguration': {
                    'awsvpcConfiguration': {
                        'Subnets': [
                            'string',
                        ],
                        'SecurityGroups': [
                            'string',
                        ],
                        'AssignPublicIp': 'ENABLED'|'DISABLED'
                    }
                },
                'PlatformVersion': 'string',
                'Group': '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
            }
        },
    ]
)
type Rule:

string

param Rule:

[REQUIRED]

The name of the rule.

type EventBusName:

string

param EventBusName:

The name of the event bus associated with the rule. If you omit this, the default event bus is used.

type Targets:

list

param Targets:

[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 AWS Accounts in the Amazon EventBridge User Guide.

    • Id (string) -- [REQUIRED]

      The ID of the target.

    • 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 must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.

    • InputTransformer (dict) --

      Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.

      • InputPathsMap (dict) --

        Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

        InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

        The keys cannot start with "AWS."

        • (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> The InputTemplate must be valid JSON.

        If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

        • The placeholder cannot be used as an object key.

        • Object values cannot include quote marks.

        The following example shows the syntax for using InputPathsMap and InputTemplate.

        "InputTransformer":

        {

        "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

        "InputTemplate": "<instance> is in state <status>"

        }

        To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

        "InputTransformer":

        {

        "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

        "InputTemplate": "<instance> is in state \"<status>\""

        }

    • 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 AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

      • NetworkConfiguration (dict) --

        Use this structure if the 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 AWS 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.

    • BatchParameters (dict) --

      If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.

      • JobDefinition (string) -- [REQUIRED]

        The ARN or name of the job definition to use if the event target is an AWS 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 AWS 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 AWS 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 AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

        • Attempts (integer) --

          The number of times to attempt to retry, if the job fails. Valid values are 1–10.

    • SqsParameters (dict) --

      Contains the message group ID to use when the target is a FIFO queue.

      If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

      • MessageGroupId (string) --

        The FIFO message group ID to use as the target.

    • HttpParameters (dict) --

      Contains the HTTP parameters to use when the target is a API Gateway REST endpoint.

      If you specify an API Gateway REST API as a target, you can use this parameter to specify headers, path parameter, query string keys/values as part of your target invoking request.

      • PathParameterValues (list) --

        The path parameter values to be used to populate API Gateway REST API path wildcards ("*").

        • (string) --

      • HeaderParameters (dict) --

        The headers that need to be sent as part of request invoking the API Gateway REST API.

        • (string) --

          • (string) --

      • QueryStringParameters (dict) --

        The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.

        • (string) --

          • (string) --

    • RedshiftDataParameters (dict) --

      Contains the Redshift Data API parameters to use when the target is a Redshift cluster.

      If you specify a Redshift Cluster as a Target, you can use this to specify parameters to invoke the 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 AWS 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) -- [REQUIRED]

        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.

rtype:

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.