Interconnect / Paginator / ListAttachPoints

ListAttachPoints

class Interconnect.Paginator.ListAttachPoints

paginator = client.get_paginator('list_attach_points')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Interconnect.Client.list_attach_points().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• environmentId (string) –

  [REQUIRED]

  The identifier of the Environment for which to list valid Attach Points.

• 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

{
    'attachPoints': [
        {
            'type': 'DirectConnectGateway',
            'identifier': 'string',
            'name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • attachPoints (list) –

    The valid AttachPoint

    • (dict) –

      Describes a possible Attach Point for a Connection.

      • type (string) –

        The type of this AttachPoint, which will dictate the syntax of the identifier.

        Current types include:

        • ARN

        • DirectConnect Gateway

      • identifier (string) –

        The identifier for the specific type of the AttachPoint.

      • name (string) –

        The descriptive name of the identifier attach point.

  • NextToken (string) –

    A token to resume pagination.