EventBridgePipes / Paginator / ListPipes


class EventBridgePipes.Paginator.ListPipes#
paginator = client.get_paginator('list_pipes')

Creates an iterator that will paginate through responses from EventBridgePipes.Client.list_pipes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • CurrentState (string) – The state the pipe is in.

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

  • 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.

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

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'Pipes': [
            'Arn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'DesiredState': 'RUNNING'|'STOPPED',
            'Enrichment': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'Name': 'string',
            'Source': 'string',
            'StateReason': 'string',
            'Target': '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.

        • Arn (string) –

          The ARN of the pipe.

        • CreationTime (datetime) –

          The time the pipe was created.

        • CurrentState (string) –

          The state the pipe is in.

        • DesiredState (string) –

          The state the pipe should be in.

        • Enrichment (string) –

          The ARN of the enrichment resource.

        • LastModifiedTime (datetime) –

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

        • Name (string) –

          The name of the pipe.

        • Source (string) –

          The ARN of the source resource.

        • StateReason (string) –

          The reason the pipe is in its current state.

        • Target (string) –

          The ARN of the target resource.