Skip to content

PipeTargetParameters

Source code in docs_src/capo_pipes/types/pipe_target_parameters.py
class PipeTargetParameters(TypedDict, closed=True):
    input_template: NotRequired["capo_pipes.types.input_template.InputTemplate"]
    """<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> <p>To remove an input template, specify an empty string.</p>"""
    lambda_function_parameters: NotRequired[
        "capo_pipes.types.pipe_target_lambda_function_parameters.PipeTargetLambdaFunctionParameters"
    ]
    """<p>The parameters for using a Lambda function as a target.</p>"""
    step_function_state_machine_parameters: NotRequired[
        "capo_pipes.types.pipe_target_state_machine_parameters.PipeTargetStateMachineParameters"
    ]
    """<p>The parameters for using a Step Functions state machine as a target.</p>"""
    kinesis_stream_parameters: NotRequired[
        "capo_pipes.types.pipe_target_kinesis_stream_parameters.PipeTargetKinesisStreamParameters"
    ]
    """<p>The parameters for using a Kinesis stream as a target.</p>"""
    ecs_task_parameters: NotRequired[
        "capo_pipes.types.pipe_target_ecs_task_parameters.PipeTargetEcsTaskParameters"
    ]
    """<p>The parameters for using an Amazon ECS task as a target.</p>"""
    batch_job_parameters: NotRequired[
        "capo_pipes.types.pipe_target_batch_job_parameters.PipeTargetBatchJobParameters"
    ]
    """<p>The parameters for using an Batch job as a target.</p>"""
    sqs_queue_parameters: NotRequired[
        "capo_pipes.types.pipe_target_sqs_queue_parameters.PipeTargetSqsQueueParameters"
    ]
    """<p>The parameters for using a Amazon SQS stream as a target.</p>"""
    http_parameters: NotRequired[
        "capo_pipes.types.pipe_target_http_parameters.PipeTargetHttpParameters"
    ]
    """<p>These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.</p>"""
    redshift_data_parameters: NotRequired[
        "capo_pipes.types.pipe_target_redshift_data_parameters.PipeTargetRedshiftDataParameters"
    ]
    """<p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.</p>"""
    sage_maker_pipeline_parameters: NotRequired[
        "capo_pipes.types.pipe_target_sage_maker_pipeline_parameters.PipeTargetSageMakerPipelineParameters"
    ]
    """<p>The parameters for using a SageMaker pipeline as a target.</p>"""
    event_bridge_event_bus_parameters: NotRequired[
        "capo_pipes.types.pipe_target_event_bridge_event_bus_parameters.PipeTargetEventBridgeEventBusParameters"
    ]
    """<p>The parameters for using an EventBridge event bus as a target.</p>"""
    cloud_watch_logs_parameters: NotRequired[
        "capo_pipes.types.pipe_target_cloud_watch_logs_parameters.PipeTargetCloudWatchLogsParameters"
    ]
    """<p>The parameters for using an CloudWatch Logs log stream as a target.</p>"""
    timestream_parameters: NotRequired[
        "capo_pipes.types.pipe_target_timestream_parameters.PipeTargetTimestreamParameters"
    ]
    """<p>The parameters for using a Timestream for LiveAnalytics table as a target.</p>"""

batch_job_parameters instance-attribute

batch_job_parameters: NotRequired[PipeTargetBatchJobParameters]

The parameters for using an Batch job as a target.

cloud_watch_logs_parameters instance-attribute

cloud_watch_logs_parameters: NotRequired[PipeTargetCloudWatchLogsParameters]

The parameters for using an CloudWatch Logs log stream as a target.

ecs_task_parameters instance-attribute

ecs_task_parameters: NotRequired[PipeTargetEcsTaskParameters]

The parameters for using an Amazon ECS task as a target.

event_bridge_event_bus_parameters instance-attribute

event_bridge_event_bus_parameters: NotRequired[PipeTargetEventBridgeEventBusParameters]

The parameters for using an EventBridge event bus as a target.

http_parameters instance-attribute

http_parameters: NotRequired[PipeTargetHttpParameters]

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

input_template instance-attribute

input_template: NotRequired[InputTemplate]

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.

To remove an input template, specify an empty string.

kinesis_stream_parameters instance-attribute

kinesis_stream_parameters: NotRequired[PipeTargetKinesisStreamParameters]

The parameters for using a Kinesis stream as a target.

lambda_function_parameters instance-attribute

lambda_function_parameters: NotRequired[PipeTargetLambdaFunctionParameters]

The parameters for using a Lambda function as a target.

redshift_data_parameters instance-attribute

redshift_data_parameters: NotRequired[PipeTargetRedshiftDataParameters]

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

sage_maker_pipeline_parameters instance-attribute

sage_maker_pipeline_parameters: NotRequired[PipeTargetSageMakerPipelineParameters]

The parameters for using a SageMaker pipeline as a target.

sqs_queue_parameters instance-attribute

sqs_queue_parameters: NotRequired[PipeTargetSqsQueueParameters]

The parameters for using a Amazon SQS stream as a target.

step_function_state_machine_parameters instance-attribute

step_function_state_machine_parameters: NotRequired[PipeTargetStateMachineParameters]

The parameters for using a Step Functions state machine as a target.

timestream_parameters instance-attribute

timestream_parameters: NotRequired[PipeTargetTimestreamParameters]

The parameters for using a Timestream for LiveAnalytics table as a target.