ApiGatewayV2 / Client / get_vpc_links

get_vpc_links

ApiGatewayV2.Client.get_vpc_links(**kwargs)

Gets a collection of VPC links.

See also: AWS API Documentation

Request Syntax

response = client.get_vpc_links(
    MaxResults='string',
    NextToken='string'
)

Parameters:

• MaxResults (string) – The maximum number of elements to be returned for this resource.

• NextToken (string) – The next page of elements from this collection. Not valid for the last element of the collection.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'CreatedDate': datetime(2015, 1, 1),
            'Name': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'SubnetIds': [
                'string',
            ],
            'Tags': {
                'string': 'string'
            },
            'VpcLinkId': 'string',
            'VpcLinkStatus': 'PENDING'|'AVAILABLE'|'DELETING'|'FAILED'|'INACTIVE',
            'VpcLinkStatusMessage': 'string',
            'VpcLinkVersion': 'V2'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Success

  • Items (list) –

    A collection of VPC links.

    • (dict) –

      Represents a VPC link.

      • CreatedDate (datetime) –

        The timestamp when the VPC link was created.

      • Name (string) –

        The name of the VPC link.

      • SecurityGroupIds (list) –

        A list of security group IDs for the VPC link.

        • (string) –

      • SubnetIds (list) –

        A list of subnet IDs to include in the VPC link.

        • (string) –

      • Tags (dict) –

        Tags for the VPC link.

        • (string) –

          • (string) –

            A string with a length between [0-1600].

      • VpcLinkId (string) –

        The ID of the VPC link.

      • VpcLinkStatus (string) –

        The status of the VPC link.

      • VpcLinkStatusMessage (string) –

        A message summarizing the cause of the status of the VPC link.

      • VpcLinkVersion (string) –

        The version of the VPC link.

  • NextToken (string) –

    The next page of elements from this collection. Not valid for the last element of the collection.

Exceptions

• ApiGatewayV2.Client.exceptions.BadRequestException

• ApiGatewayV2.Client.exceptions.TooManyRequestsException