:doc:`EC2 <../../ec2>` / Paginator / DescribeInstanceConnectEndpoints

********************************
DescribeInstanceConnectEndpoints
********************************



.. py:class:: EC2.Paginator.DescribeInstanceConnectEndpoints

  ::

    
    paginator = client.get_paginator('describe_instance_connect_endpoints')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`EC2.Client.describe_instance_connect_endpoints`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DryRun=True|False,
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          InstanceConnectEndpointIds=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 Filters: list
    :param Filters: 

      One or more filters.

       

      
      * ``instance-connect-endpoint-id`` - The ID of the EC2 Instance Connect Endpoint.
       
      * ``state`` - The state of the EC2 Instance Connect Endpoint ( ``create-in-progress`` | ``create-complete`` | ``create-failed`` | ``delete-in-progress`` | ``delete-complete`` | ``delete-failed``).
       
      * ``subnet-id`` - The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
       
      * ``tag``:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key ``Owner`` and the value ``TeamA``, specify ``tag:Owner`` for the filter name and ``TeamA`` for the filter value.
       
      * ``tag-key`` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
       
      * ``tag-value`` - The value of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific value, regardless of tag key.
       
      * ``vpc-id`` - The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
      

      

    
      - *(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 InstanceConnectEndpointIds: list
    :param InstanceConnectEndpointIds: 

      One or more EC2 Instance Connect Endpoint IDs.

      

    
      - *(string) --* 

      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

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

      
      ::

        {
            'InstanceConnectEndpoints': [
                {
                    'OwnerId': 'string',
                    'InstanceConnectEndpointId': 'string',
                    'InstanceConnectEndpointArn': 'string',
                    'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'update-in-progress'|'update-complete'|'update-failed',
                    'StateMessage': 'string',
                    'DnsName': 'string',
                    'FipsDnsName': 'string',
                    'NetworkInterfaceIds': [
                        'string',
                    ],
                    'VpcId': 'string',
                    'AvailabilityZone': 'string',
                    'CreatedAt': datetime(2015, 1, 1),
                    'SubnetId': 'string',
                    'PreserveClientIp': True|False,
                    'SecurityGroupIds': [
                        'string',
                    ],
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'IpAddressType': 'ipv4'|'dualstack'|'ipv6',
                    'PublicDnsNames': {
                        'Ipv4': {
                            'DnsName': 'string',
                            'FipsDnsName': 'string'
                        },
                        'Dualstack': {
                            'DnsName': 'string',
                            'FipsDnsName': 'string'
                        }
                    },
                    'AvailabilityZoneId': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **InstanceConnectEndpoints** *(list) --* 

          Information about the EC2 Instance Connect Endpoints.

          
          

          - *(dict) --* 

            Describes an EC2 Instance Connect Endpoint.

            
            

            - **OwnerId** *(string) --* 

              The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.

              
            

            - **InstanceConnectEndpointId** *(string) --* 

              The ID of the EC2 Instance Connect Endpoint.

              
            

            - **InstanceConnectEndpointArn** *(string) --* 

              The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.

              
            

            - **State** *(string) --* 

              The current state of the EC2 Instance Connect Endpoint.

              
            

            - **StateMessage** *(string) --* 

              The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.

              
            

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

              The DNS name of the EC2 Instance Connect Endpoint.

              
            

            - **FipsDnsName** *(string) --* 

              The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.

              
            

            - **NetworkInterfaceIds** *(list) --* 

              The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.

              
              

              - *(string) --* 
          
            

            - **VpcId** *(string) --* 

              The ID of the VPC in which the EC2 Instance Connect Endpoint was created.

              
            

            - **AvailabilityZone** *(string) --* 

              The Availability Zone of the EC2 Instance Connect Endpoint.

              
            

            - **CreatedAt** *(datetime) --* 

              The date and time that the EC2 Instance Connect Endpoint was created.

              
            

            - **SubnetId** *(string) --* 

              The ID of the subnet in which the EC2 Instance Connect Endpoint was created.

              
            

            - **PreserveClientIp** *(boolean) --* 

              Indicates whether your client's IP address is preserved as the source when you connect to a resource. The following are the possible values.

               

              
              * ``true`` - Use the IP address of the client. Your instance must have an IPv4 address.
               
              * ``false`` - Use the IP address of the network interface.
              

               

              Default: ``false``

              
            

            - **SecurityGroupIds** *(list) --* 

              The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint.

              
              

              - *(string) --* 
          
            

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

              The tags assigned to the EC2 Instance Connect Endpoint.

              
              

              - *(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.

                  
            
          
            

            - **IpAddressType** *(string) --* 

              The IP address type of the endpoint.

              
            

            - **PublicDnsNames** *(dict) --* 

              The public DNS names of the endpoint.

              
              

              - **Ipv4** *(dict) --* 

                The IPv4-only DNS name of the EC2 Instance Connect Endpoint.

                
                

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

                  The DNS name of the EC2 Instance Connect Endpoint.

                  
                

                - **FipsDnsName** *(string) --* 

                  The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.

                  
            
              

              - **Dualstack** *(dict) --* 

                The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.

                
                

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

                  The DNS name of the EC2 Instance Connect Endpoint.

                  
                

                - **FipsDnsName** *(string) --* 

                  The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.

                  
            
          
            

            - **AvailabilityZoneId** *(string) --* 

              The ID of the Availability Zone of the EC2 Instance Connect Endpoint.

              
        
      
    