OpenSearchIngestion / Paginator / ListPipelineEndpointConnections

ListPipelineEndpointConnections

class OpenSearchIngestion.Paginator.ListPipelineEndpointConnections

paginator = client.get_paginator('list_pipeline_endpoint_connections')

paginate(**kwargs)

Creates an iterator that will paginate through responses from OpenSearchIngestion.Client.list_pipeline_endpoint_connections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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:

dict

Returns:

Response Syntax

{
    'PipelineEndpointConnections': [
        {
            'PipelineArn': 'string',
            'EndpointId': 'string',
            'Status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'REVOKING'|'REVOKED',
            'VpcEndpointOwner': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • PipelineEndpointConnections (list) –

    A list of pipeline endpoint connections.

    • (dict) –

      Represents a connection to a pipeline endpoint, containing details about the endpoint association.

      • PipelineArn (string) –

        The Amazon Resource Name (ARN) of the pipeline in the endpoint connection.

      • EndpointId (string) –

        The unique identifier of the endpoint in the connection.

      • Status (string) –

        The current status of the pipeline endpoint connection.

      • VpcEndpointOwner (string) –

        The Amazon Web Services account ID that owns the VPC endpoint used in this connection.