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

***************************
DescribeVpcEndpointServices
***************************



.. py:class:: EC2.Paginator.DescribeVpcEndpointServices

  ::

    
    paginator = client.get_paginator('describe_vpc_endpoint_services')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DryRun=True|False,
          ServiceNames=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          ServiceRegions=[
              '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 ServiceNames: list
    :param ServiceNames: 

      The service names.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      The filters.

       

      
      * ``owner`` - The ID or alias of the Amazon Web Services account that owns the service.
       
      * ``service-name`` - The name of the service.
       
      * ``service-region`` - The Region of the service.
       
      * ``service-type`` - The type of service ( ``Interface`` | ``Gateway`` | ``GatewayLoadBalancer``).
       
      * ``supported-ip-address-types`` - The IP address type ( ``ipv4`` | ``ipv6``).
       
      * ``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.
      

      

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

      The service Regions.

      

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

      
      ::

        {
            'ServiceNames': [
                'string',
            ],
            'ServiceDetails': [
                {
                    'ServiceName': 'string',
                    'ServiceId': 'string',
                    'ServiceType': [
                        {
                            'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
                        },
                    ],
                    'ServiceRegion': 'string',
                    'AvailabilityZoneIds': [
                        'string',
                    ],
                    'AvailabilityZones': [
                        'string',
                    ],
                    'Owner': 'string',
                    'BaseEndpointDnsNames': [
                        'string',
                    ],
                    'PrivateDnsName': 'string',
                    'PrivateDnsNames': [
                        {
                            'PrivateDnsName': 'string'
                        },
                    ],
                    'VpcEndpointPolicySupported': True|False,
                    'AcceptanceRequired': True|False,
                    'ManagesVpcEndpoints': True|False,
                    'PayerResponsibility': 'ServiceOwner',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'PrivateDnsNameVerificationState': 'pendingVerification'|'verified'|'failed',
                    'SupportedIpAddressTypes': [
                        'ipv4'|'ipv6',
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ServiceNames** *(list) --* 

          The supported services.

          
          

          - *(string) --* 
      
        

        - **ServiceDetails** *(list) --* 

          Information about the service.

          
          

          - *(dict) --* 

            Describes a VPC endpoint service.

            
            

            - **ServiceName** *(string) --* 

              The name of the service.

              
            

            - **ServiceId** *(string) --* 

              The ID of the endpoint service.

              
            

            - **ServiceType** *(list) --* 

              The type of service.

              
              

              - *(dict) --* 

                Describes the type of service for a VPC endpoint.

                
                

                - **ServiceType** *(string) --* 

                  The type of service.

                  
            
          
            

            - **ServiceRegion** *(string) --* 

              The Region where the service is hosted.

              
            

            - **AvailabilityZoneIds** *(list) --* 

              The IDs of the Availability Zones in which the service is available.

               

              Either ``AvailabilityZone`` or ``AvailabilityZoneId`` can be specified, but not both

              
              

              - *(string) --* 
          
            

            - **AvailabilityZones** *(list) --* 

              The Availability Zones in which the service is available.

               

              Either ``AvailabilityZone`` or ``AvailabilityZoneId`` can be specified, but not both

              
              

              - *(string) --* 
          
            

            - **Owner** *(string) --* 

              The Amazon Web Services account ID of the service owner.

              
            

            - **BaseEndpointDnsNames** *(list) --* 

              The DNS names for the service.

              
              

              - *(string) --* 
          
            

            - **PrivateDnsName** *(string) --* 

              The private DNS name for the service.

              
            

            - **PrivateDnsNames** *(list) --* 

              The private DNS names assigned to the VPC endpoint service.

              
              

              - *(dict) --* 

                Information about the Private DNS name for interface endpoints.

                
                

                - **PrivateDnsName** *(string) --* 

                  The private DNS name assigned to the VPC endpoint service.

                  
            
          
            

            - **VpcEndpointPolicySupported** *(boolean) --* 

              Indicates whether the service supports endpoint policies.

              
            

            - **AcceptanceRequired** *(boolean) --* 

              Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.

              
            

            - **ManagesVpcEndpoints** *(boolean) --* 

              Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.

              
            

            - **PayerResponsibility** *(string) --* 

              The payer responsibility.

              
            

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

              The tags assigned to the service.

              
              

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

                  
            
          
            

            - **PrivateDnsNameVerificationState** *(string) --* 

              The verification state of the VPC endpoint service.

               

              Consumers of the endpoint service cannot use the private name when the state is not ``verified``.

              
            

            - **SupportedIpAddressTypes** *(list) --* 

              The supported IP address types.

              
              

              - *(string) --* 
          
        
      
    