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

********************************************
describe_vpc_endpoint_service_configurations
********************************************



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

  

  Describes the VPC endpoint service configurations in your account (your services).

  

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


  **Request Syntax**
  ::

    response = client.describe_vpc_endpoint_service_configurations(
        DryRun=True|False,
        ServiceIds=[
            '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 ServiceIds: list
  :param ServiceIds: 

    The IDs of the endpoint services.

    

  
    - *(string) --* 

    

  :type Filters: list
  :param Filters: 

    The filters.

     

    
    * ``service-name`` - The name of the service.
     
    * ``service-id`` - The ID of the service.
     
    * ``service-state`` - The state of the service ( ``Pending`` | ``Available`` | ``Deleting`` | ``Deleted`` | ``Failed``).
     
    * ``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 MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned ``NextToken`` value. This value can be between 5 and 1,000; if ``MaxResults`` is given a value larger than 1,000, only 1,000 results are returned.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to retrieve the next page of results.

    

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

    
    ::

      {
          'ServiceConfigurations': [
              {
                  'ServiceType': [
                      {
                          'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
                      },
                  ],
                  'ServiceId': 'string',
                  'ServiceName': 'string',
                  'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
                  'AvailabilityZoneIds': [
                      'string',
                  ],
                  'AvailabilityZones': [
                      'string',
                  ],
                  'AcceptanceRequired': True|False,
                  'ManagesVpcEndpoints': True|False,
                  'NetworkLoadBalancerArns': [
                      'string',
                  ],
                  'GatewayLoadBalancerArns': [
                      'string',
                  ],
                  'SupportedIpAddressTypes': [
                      'ipv4'|'ipv6',
                  ],
                  'BaseEndpointDnsNames': [
                      'string',
                  ],
                  'PrivateDnsName': 'string',
                  'PrivateDnsNameConfiguration': {
                      'State': 'pendingVerification'|'verified'|'failed',
                      'Type': 'string',
                      'Value': 'string',
                      'Name': 'string'
                  },
                  'PayerResponsibility': 'ServiceOwner',
                  'Tags': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ],
                  'SupportedRegions': [
                      {
                          'Region': 'string',
                          'ServiceState': 'string'
                      },
                  ],
                  'RemoteAccessEnabled': True|False
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ServiceConfigurations** *(list) --* 

        Information about the services.

        
        

        - *(dict) --* 

          Describes a service configuration for a VPC endpoint service.

          
          

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

            The type of service.

            
            

            - *(dict) --* 

              Describes the type of service for a VPC endpoint.

              
              

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

                The type of service.

                
          
        
          

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

            The ID of the service.

            
          

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

            The name of the service.

            
          

          - **ServiceState** *(string) --* 

            The service state.

            
          

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

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

            Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.

            
          

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

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

            
          

          - **NetworkLoadBalancerArns** *(list) --* 

            The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.

            
            

            - *(string) --* 
        
          

          - **GatewayLoadBalancerArns** *(list) --* 

            The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

            
            

            - *(string) --* 
        
          

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

            The supported IP address types.

            
            

            - *(string) --* 
        
          

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

            The DNS names for the service.

            
            

            - *(string) --* 
        
          

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

            The private DNS name for the service.

            
          

          - **PrivateDnsNameConfiguration** *(dict) --* 

            Information about the endpoint service private DNS name configuration.

            
            

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

              The verification state of the VPC endpoint service.

               

              Consumers of the endpoint service can use the private name only when the state is ``verified``.

              
            

            - **Type** *(string) --* 

              The endpoint service verification type, for example TXT.

              
            

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

              The value the service provider adds to the private DNS name domain record before verification.

              
            

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

              The name of the record subdomain the service provider needs to create. The service provider adds the ``value`` text to the ``name``.

              
        
          

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

                
          
        
          

          - **SupportedRegions** *(list) --* 

            The supported Regions.

            
            

            - *(dict) --* 

              Describes a supported Region.

              
              

              - **Region** *(string) --* 

                The Region code.

                
              

              - **ServiceState** *(string) --* 

                The service state. The possible values are ``Pending``, ``Available``, ``Deleting``, ``Deleted``, ``Failed``, and ``Closed``.

                
          
        
          

          - **RemoteAccessEnabled** *(boolean) --* 

            Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.

            
      
    
      

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

        The token to use to retrieve the next page of results. This value is ``null`` when there are no more results to return.

        
  