Skip to content

ListPipesRequest

Source code in docs_src/capo_pipes/types/list_pipes_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class ListPipesRequest(TypedDict, closed=True):
    name_prefix: NotRequired["capo_pipes.types.pipe_name.PipeName"]
    """<p>A value that will return a subset of the pipes associated with this account. For example, <code>"NamePrefix": "ABC"</code> will return all endpoints with "ABC" in the name.</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>"""
    source_prefix: NotRequired["capo_pipes.types.resource_arn.ResourceArn"]
    """<p>The prefix matching the pipe source.</p>"""
    target_prefix: NotRequired["capo_pipes.types.resource_arn.ResourceArn"]
    """<p>The prefix matching the pipe target.</p>"""
    next_token: NotRequired["capo_pipes.types.next_token.NextToken"]
    """<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.</p>"""
    limit: NotRequired["capo_pipes.types.limit_max100.LimitMax100"]
    """<p>The maximum number of pipes to include in the response.</p>"""

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.

limit instance-attribute 

limit: NotRequired[LimitMax100]

The maximum number of pipes to include in the response.

name_prefix instance-attribute 

name_prefix: NotRequired[PipeName]

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

next_token instance-attribute 

next_token: NotRequired[NextToken]

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

source_prefix instance-attribute 

source_prefix: NotRequired[ResourceArn]

The prefix matching the pipe source.

target_prefix instance-attribute 

target_prefix: NotRequired[ResourceArn]

The prefix matching the pipe target.