EventBridgePipes / Client / list_pipes

list_pipes#

EventBridgePipes.Client.list_pipes(**kwargs)#

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_pipes(
    NamePrefix='string',
    DesiredState='RUNNING'|'STOPPED',
    CurrentState='RUNNING'|'STOPPED'|'CREATING'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'CREATE_FAILED'|'UPDATE_FAILED'|'START_FAILED'|'STOP_FAILED'|'DELETE_FAILED'|'CREATE_ROLLBACK_FAILED'|'DELETE_ROLLBACK_FAILED'|'UPDATE_ROLLBACK_FAILED',
    SourcePrefix='string',
    TargetPrefix='string',
    NextToken='string',
    Limit=123
)
Parameters:

  • NamePrefix (string) – 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.

  • DesiredState (string) – The state the pipe should be in.

  • CurrentState (string) – The state the pipe is in.

  • SourcePrefix (string) – The prefix matching the pipe source.

  • TargetPrefix (string) – The prefix matching the pipe target.

  • NextToken (string) – 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.

  • Limit (integer) – The maximum number of pipes to include in the response.

Return type:

dict

Returns:

Response Syntax

{
    'Pipes': [
        {
            'Name': 'string',
            'Arn': 'string',
            'DesiredState': 'RUNNING'|'STOPPED',
            'CurrentState': 'RUNNING'|'STOPPED'|'CREATING'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'CREATE_FAILED'|'UPDATE_FAILED'|'START_FAILED'|'STOP_FAILED'|'DELETE_FAILED'|'CREATE_ROLLBACK_FAILED'|'DELETE_ROLLBACK_FAILED'|'UPDATE_ROLLBACK_FAILED',
            'StateReason': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'Source': 'string',
            'Target': 'string',
            'Enrichment': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Pipes (list) –

      The pipes returned by the call.

      • (dict) –

        An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

        • Name (string) –

          The name of the pipe.

        • Arn (string) –

          The ARN of the pipe.

        • DesiredState (string) –

          The state the pipe should be in.

        • CurrentState (string) –

          The state the pipe is in.

        • StateReason (string) –

          The reason the pipe is in its current state.

        • CreationTime (datetime) –

          The time the pipe was created.

        • LastModifiedTime (datetime) –

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

        • Source (string) –

          The ARN of the source resource.

        • Target (string) –

          The ARN of the target resource.

        • Enrichment (string) –

          The ARN of the enrichment resource.

    • NextToken (string) –

      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.

Exceptions