DescribePipeResponse ¶

class DescribePipeResponse(TypedDict, closed=True):
    arn: NotRequired["capo_pipes.types.pipe_arn.PipeArn"]
    """<p>The ARN of the pipe.</p>"""
    name: NotRequired["capo_pipes.types.pipe_name.PipeName"]
    """<p>The name of the pipe.</p>"""
    description: NotRequired["capo_pipes.types.pipe_description.PipeDescription"]
    """<p>A description of the pipe.</p>"""
    desired_state: NotRequired[
        "capo_pipes.types.requested_pipe_state_describe_response.RequestedPipeStateDescribeResponse"
    ]
    """<p>The state the pipe should be in.</p>"""
    current_state: NotRequired["capo_pipes.types.pipe_state.PipeState"]
    """<p>The state the pipe is in.</p>"""
    state_reason: NotRequired["capo_pipes.types.pipe_state_reason.PipeStateReason"]
    """<p>The reason the pipe is in its current state.</p>"""
    source: NotRequired["capo_pipes.types.arn_or_url.ArnOrUrl"]
    """<p>The ARN of the source resource.</p>"""
    source_parameters: NotRequired[
        "capo_pipes.types.pipe_source_parameters.PipeSourceParameters"
    ]
    """<p>The parameters required to set up a source for your pipe.</p>"""
    enrichment: NotRequired["capo_pipes.types.optional_arn.OptionalArn"]
    """<p>The ARN of the enrichment resource.</p>"""
    enrichment_parameters: NotRequired[
        "capo_pipes.types.pipe_enrichment_parameters.PipeEnrichmentParameters"
    ]
    """<p>The parameters required to set up enrichment on your pipe.</p>"""
    target: NotRequired["capo_pipes.types.arn.Arn"]
    """<p>The ARN of the target resource.</p>"""
    target_parameters: NotRequired[
        "capo_pipes.types.pipe_target_parameters.PipeTargetParameters"
    ]
    """<p>The parameters required to set up a target for your pipe.</p> <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>"""
    role_arn: NotRequired["capo_pipes.types.role_arn.RoleArn"]
    """<p>The ARN of the role that allows the pipe to send data to the target.</p>"""
    tags: NotRequired["capo_pipes.types.tag_map.TagMap"]
    """<p>The list of key-value pairs to associate with the pipe.</p>"""
    creation_time: NotRequired["capo_pipes.types.timestamp.Timestamp"]
    """<p>The time the pipe was created.</p>"""
    last_modified_time: NotRequired["capo_pipes.types.timestamp.Timestamp"]
    """<p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>"""
    log_configuration: NotRequired[
        "capo_pipes.types.pipe_log_configuration.PipeLogConfiguration"
    ]
    """<p>The logging configuration settings for the pipe.</p>"""
    kms_key_identifier: NotRequired[
        "capo_pipes.types.kms_key_identifier.KmsKeyIdentifier"
    ]
    """<p>The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p>"""