:doc:`DatabaseMigrationService <../../dms>` / Client / describe_endpoint_types

***********************
describe_endpoint_types
***********************



.. py:method:: DatabaseMigrationService.Client.describe_endpoint_types(**kwargs)

  

  Returns information about the type of endpoints available.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeEndpointTypes>`_  


  **Request Syntax**
  ::

    response = client.describe_endpoint_types(
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxRecords=123,
        Marker='string'
    )
    
  :type Filters: list
  :param Filters: 

    Filters applied to the endpoint types.

     

    Valid filter names: engine-name | endpoint-type

    

  
    - *(dict) --* 

      Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular ``Describe*`` call or similar operation. Filters are used as an optional parameter for certain API operations.

      

    
      - **Name** *(string) --* **[REQUIRED]** 

        The name of the filter as specified for a ``Describe*`` or similar operation.

        

      
      - **Values** *(list) --* **[REQUIRED]** 

        The filter value, which can specify one or more values used to narrow the returned results.

        

      
        - *(string) --* 

        
    
    

  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

     

    Default: 100

     

    Constraints: Minimum 20, maximum 100.

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

    

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

    
    ::

      {
          'Marker': 'string',
          'SupportedEndpointTypes': [
              {
                  'EngineName': 'string',
                  'SupportsCDC': True|False,
                  'EndpointType': 'source'|'target',
                  'ReplicationInstanceEngineMinimumVersion': 'string',
                  'EngineDisplayName': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Marker** *(string) --* 

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

        
      

      - **SupportedEndpointTypes** *(list) --* 

        The types of endpoints that are supported.

        
        

        - *(dict) --* 

          Provides information about types of supported endpoints in response to a request by the ``DescribeEndpointTypes`` operation. This information includes the type of endpoint, the database engine name, and whether change data capture (CDC) is supported.

          
          

          - **EngineName** *(string) --* 

            The database engine name. Valid values, depending on the EndpointType, include ``"mysql"``, ``"oracle"``, ``"postgres"``, ``"mariadb"``, ``"aurora"``, ``"aurora-postgresql"``, ``"redshift"``, ``"s3"``, ``"db2"``, ``"db2-zos"``, ``"azuredb"``, ``"sybase"``, ``"dynamodb"``, ``"mongodb"``, ``"kinesis"``, ``"kafka"``, ``"elasticsearch"``, ``"documentdb"``, ``"sqlserver"``, ``"neptune"``, and ``"babelfish"``.

            
          

          - **SupportsCDC** *(boolean) --* 

            Indicates if change data capture (CDC) is supported.

            
          

          - **EndpointType** *(string) --* 

            The type of endpoint. Valid values are ``source`` and ``target``.

            
          

          - **ReplicationInstanceEngineMinimumVersion** *(string) --* 

            The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.

            
          

          - **EngineDisplayName** *(string) --* 

            The expanded name for the engine name. For example, if the ``EngineName`` parameter is "aurora", this value would be "Amazon Aurora MySQL".

            
      
    
  

  **Examples**

  Returns information about the type of endpoints available.
  ::

    response = client.describe_endpoint_types(
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                    'string',
                ],
            },
        ],
        Marker='',
        MaxRecords=123,
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'Marker': '',
        'SupportedEndpointTypes': [
        ],
        'ResponseMetadata': {
            '...': '...',
        },
    }

  