Target ¶

class Target(TypedDict, closed=True):
    id: "capo_eventbridge.types.target_id.TargetId"
    """<p>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.</p>"""
    arn: "capo_eventbridge.types.target_arn.TargetArn"
    """<p>The Amazon Resource Name (ARN) of the target.</p>"""
    role_arn: NotRequired["capo_eventbridge.types.role_arn.RoleArn"]
    """<p>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.</p>"""
    input: NotRequired["capo_eventbridge.types.target_input.TargetInput"]
    """<p>Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data Interchange Format</a>.</p>"""
    input_path: NotRequired["capo_eventbridge.types.target_input_path.TargetInputPath"]
    """<p>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 <a href="http://goessner.net/articles/JsonPath/">JSONPath</a>.</p>"""
    input_transformer: NotRequired[
        "capo_eventbridge.types.input_transformer.InputTransformer"
    ]
    """<p>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.</p>"""
    kinesis_parameters: NotRequired[
        "capo_eventbridge.types.kinesis_parameters.KinesisParameters"
    ]
    """<p>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 <code>eventId</code> as the partition key.</p>"""
    run_command_parameters: NotRequired[
        "capo_eventbridge.types.run_command_parameters.RunCommandParameters"
    ]
    """<p>Parameters used when you are using the rule to invoke Amazon EC2 Run Command.</p>"""
    ecs_parameters: NotRequired["capo_eventbridge.types.ecs_parameters.EcsParameters"]
    """<p>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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Task Definitions </a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>"""
    batch_parameters: NotRequired[
        "capo_eventbridge.types.batch_parameters.BatchParameters"
    ]
    """<p>If the event target is an Batch job, this contains the job definition, job name, and other parameters. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/jobs.html">Jobs</a> in the <i>Batch User Guide</i>.</p>"""
    sqs_parameters: NotRequired["capo_eventbridge.types.sqs_parameters.SqsParameters"]
    """<p>Contains the message group ID to use when the target is an Amazon SQS fair or FIFO queue.</p> <p>If you specify a fair or FIFO queue as a target, the queue must have content-based deduplication enabled.</p>"""
    http_parameters: NotRequired[
        "capo_eventbridge.types.http_parameters.HttpParameters"
    ]
    """<p>Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.</p> <p>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.</p>"""
    redshift_data_parameters: NotRequired[
        "capo_eventbridge.types.redshift_data_parameters.RedshiftDataParameters"
    ]
    """<p>Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.</p> <p>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.</p>"""
    sage_maker_pipeline_parameters: NotRequired[
        "capo_eventbridge.types.sage_maker_pipeline_parameters.SageMakerPipelineParameters"
    ]
    """<p>Contains the SageMaker AI Model Building Pipeline parameters to start execution of a SageMaker AI Model Building Pipeline.</p> <p>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.</p>"""
    dead_letter_config: NotRequired[
        "capo_eventbridge.types.dead_letter_config.DeadLetterConfig"
    ]
    """<p>The <code>DeadLetterConfig</code> that defines the target queue to send dead-letter queue events to.</p>"""
    retry_policy: NotRequired["capo_eventbridge.types.retry_policy.RetryPolicy"]
    """<p>The retry policy configuration to use for the dead-letter queue.</p>"""
    app_sync_parameters: NotRequired[
        "capo_eventbridge.types.app_sync_parameters.AppSyncParameters"
    ]
    """<p>Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.</p>"""