:doc:`ApiGatewayV2 <../../apigatewayv2>` / Client / get_vpc_links

*************
get_vpc_links
*************



.. py:method:: ApiGatewayV2.Client.get_vpc_links(**kwargs)

  

  Gets a collection of VPC links.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/GetVpcLinks>`_  


  **Request Syntax**
  ::

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

    The maximum number of elements to be returned for this resource.

    

  
  :type NextToken: string
  :param NextToken: 

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

    

  
  
  :rtype: 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**
  
  *   :py:class:`ApiGatewayV2.Client.exceptions.BadRequestException`

  
  *   :py:class:`ApiGatewayV2.Client.exceptions.TooManyRequestsException`

  