APIGateway / Paginator / GetVpcLinks

GetVpcLinks

class APIGateway.Paginator.GetVpcLinks

paginator = client.get_paginator('get_vpc_links')

paginate(**kwargs)

Creates an iterator that will paginate through responses from APIGateway.Client.get_vpc_links().

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

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'targetArns': [
                'string',
            ],
            'status': 'AVAILABLE'|'PENDING'|'DELETING'|'FAILED',
            'statusMessage': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The collection of VPC links under the caller’s account in a region.

  • items (list) –

    The current page of elements from this collection.

    • (dict) –

      An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

      • id (string) –

        The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

      • name (string) –

        The name used to label and identify the VPC link.

      • description (string) –

        The description of the VPC link.

      • targetArns (list) –

        The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

        • (string) –

      • status (string) –

        The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

      • statusMessage (string) –

        A description about the VPC link status.

      • tags (dict) –

        The collection of tags. Each tag element is associated with a given resource.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.