Skip to content

StopPipeResponse

Source code in docs_src/capo_pipes/types/stop_pipe_response.py
class StopPipeResponse(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>"""
    desired_state: NotRequired[
        "capo_pipes.types.requested_pipe_state.RequestedPipeState"
    ]
    """<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>"""
    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>"""

arn instance-attribute

arn: NotRequired[PipeArn]

The ARN of the pipe.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The time the pipe was created.

current_state instance-attribute

current_state: NotRequired[PipeState]

The state the pipe is in.

desired_state instance-attribute

desired_state: NotRequired[RequestedPipeState]

The state the pipe should be in.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

name instance-attribute

name: NotRequired[PipeName]

The name of the pipe.