APIGateway / Client / get_vpc_links

get_vpc_links#

APIGateway.Client.get_vpc_links(**kwargs)#

Gets the VpcLinks collection under the caller’s account in a selected region.

Request Syntax

response = client.get_vpc_links(
    position='string',
    limit=123
)

Parameters:

position (string) – The current pagination position in the paged result set.
limit (integer) – The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

The collection of VPC links under the caller’s account in a region.
- position (string) –
- 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 Amazon Web Services 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) –

get_vpc_links#

Request Syntax

Response Syntax

Response Structure

Exceptions