Skip to content

Pipe

Source code in docs_src/capo_pipes/types/pipe.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class Pipe(TypedDict, closed=True):
    name: NotRequired["capo_pipes.types.pipe_name.PipeName"]
    """<p>The name of the pipe.</p>"""
    arn: NotRequired["capo_pipes.types.pipe_arn.PipeArn"]
    """<p>The ARN 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>"""
    state_reason: NotRequired["capo_pipes.types.pipe_state_reason.PipeStateReason"]
    """<p>The reason the pipe is in its current state.</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>"""
    source: NotRequired["capo_pipes.types.arn_or_url.ArnOrUrl"]
    """<p>The ARN of the source resource.</p>"""
    target: NotRequired["capo_pipes.types.arn.Arn"]
    """<p>The ARN of the target resource.</p>"""
    enrichment: NotRequired["capo_pipes.types.optional_arn.OptionalArn"]
    """<p>The ARN of the enrichment resource.</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.

enrichment instance-attribute 

enrichment: NotRequired[OptionalArn]

The ARN of the enrichment resource.

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.

source instance-attribute 

source: NotRequired[ArnOrUrl]

The ARN of the source resource.

state_reason instance-attribute 

state_reason: NotRequired[PipeStateReason]

The reason the pipe is in its current state.

target instance-attribute 

target: NotRequired[Arn]

The ARN of the target resource.