:doc:`EC2 <../../ec2>` / Client / describe_vpc_endpoint_associations

**********************************
describe_vpc_endpoint_associations
**********************************



.. py:method:: EC2.Client.describe_vpc_endpoint_associations(**kwargs)

  

  Describes the VPC resources, VPC endpoint services, Amazon Lattice services, or service networks associated with the VPC endpoint.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeVpcEndpointAssociations>`_  


  **Request Syntax**
  ::

    response = client.describe_vpc_endpoint_associations(
        DryRun=True|False,
        VpcEndpointIds=[
            'string',
        ],
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxResults=123,
        NextToken='string'
    )
    
  :type DryRun: boolean
  :param DryRun: 

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

    

  
  :type VpcEndpointIds: list
  :param VpcEndpointIds: 

    The IDs of the VPC endpoints.

    

  
    - *(string) --* 

    

  :type Filters: list
  :param Filters: 

    The filters.

     

    
    * ``vpc-endpoint-id`` - The ID of the VPC endpoint.
     
    * ``associated-resource-accessibility`` - The association state. When the state is ``accessible``, it returns ``AVAILABLE``. When the state is ``inaccessible``, it returns ``PENDING`` or ``FAILED``.
     
    * ``association-id`` - The ID of the VPC endpoint association.
     
    * ``associated-resource-id`` - The ID of the associated resource configuration.
     
    * ``service-network-arn`` - The Amazon Resource Name (ARN) of the associated service network. Only VPC endpoints of type service network will be returned.
     
    * ``resource-configuration-group-arn`` - The Amazon Resource Name (ARN) of the resource configuration of type GROUP.
    

    

  
    - *(dict) --* 

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

       

      If you specify multiple filters, the filters are joined with an ``AND``, and the request returns only results that match all of the specified filters.

       

      For more information, see `List and filter using the CLI and API <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.

      

    
      - **Name** *(string) --* 

        The name of the filter. Filter names are case-sensitive.

        

      
      - **Values** *(list) --* 

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an ``OR``, and the request returns all results that match any of the specified values.

        

      
        - *(string) --* 

        
    
    

  :type MaxResults: integer
  :param MaxResults: 

    The maximum page size.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'VpcEndpointAssociations': [
              {
                  'Id': 'string',
                  'VpcEndpointId': 'string',
                  'ServiceNetworkArn': 'string',
                  'ServiceNetworkName': 'string',
                  'AssociatedResourceAccessibility': 'string',
                  'FailureReason': 'string',
                  'FailureCode': 'string',
                  'DnsEntry': {
                      'DnsName': 'string',
                      'HostedZoneId': 'string'
                  },
                  'PrivateDnsEntry': {
                      'DnsName': 'string',
                      'HostedZoneId': 'string'
                  },
                  'AssociatedResourceArn': 'string',
                  'ResourceConfigurationGroupArn': 'string',
                  'Tags': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **VpcEndpointAssociations** *(list) --* 

        Details of the endpoint associations.

        
        

        - *(dict) --* 

          Describes the VPC resources, VPC endpoint services, Lattice services, or service networks associated with the VPC endpoint.

          
          

          - **Id** *(string) --* 

            The ID of the VPC endpoint association.

            
          

          - **VpcEndpointId** *(string) --* 

            The ID of the VPC endpoint.

            
          

          - **ServiceNetworkArn** *(string) --* 

            The Amazon Resource Name (ARN) of the service network.

            
          

          - **ServiceNetworkName** *(string) --* 

            The name of the service network.

            
          

          - **AssociatedResourceAccessibility** *(string) --* 

            The connectivity status of the resources associated to a VPC endpoint. The resource is accessible if the associated resource configuration is ``AVAILABLE``, otherwise the resource is inaccessible.

            
          

          - **FailureReason** *(string) --* 

            A message related to why an VPC endpoint association failed.

            
          

          - **FailureCode** *(string) --* 

            An error code related to why an VPC endpoint association failed.

            
          

          - **DnsEntry** *(dict) --* 

            The DNS entry of the VPC endpoint association.

            
            

            - **DnsName** *(string) --* 

              The DNS name.

              
            

            - **HostedZoneId** *(string) --* 

              The ID of the private hosted zone.

              
        
          

          - **PrivateDnsEntry** *(dict) --* 

            The private DNS entry of the VPC endpoint association.

            
            

            - **DnsName** *(string) --* 

              The DNS name.

              
            

            - **HostedZoneId** *(string) --* 

              The ID of the private hosted zone.

              
        
          

          - **AssociatedResourceArn** *(string) --* 

            The Amazon Resource Name (ARN) of the associated resource.

            
          

          - **ResourceConfigurationGroupArn** *(string) --* 

            The Amazon Resource Name (ARN) of the resource configuration group.

            
          

          - **Tags** *(list) --* 

            The tags to apply to the VPC endpoint association.

            
            

            - *(dict) --* 

              Describes a tag.

              
              

              - **Key** *(string) --* 

                The key of the tag.

                 

                Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``.

                
              

              - **Value** *(string) --* 

                The value of the tag.

                 

                Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

                
          
        
      
    
      

      - **NextToken** *(string) --* 

        The pagination token.

        
  