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

**************************
describe_endpoint_settings
**************************



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

  

  Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.

  

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


  **Request Syntax**
  ::

    response = client.describe_endpoint_settings(
        EngineName='string',
        MaxRecords=123,
        Marker='string'
    )
    
  :type EngineName: string
  :param EngineName: **[REQUIRED]** 

    The database engine used for your source or target endpoint.

    

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

    

  
  :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',
          'EndpointSettings': [
              {
                  'Name': 'string',
                  'Type': 'string'|'boolean'|'integer'|'enum',
                  'EnumValues': [
                      'string',
                  ],
                  'Sensitive': True|False,
                  'Units': 'string',
                  'Applicability': 'string',
                  'IntValueMin': 123,
                  'IntValueMax': 123,
                  'DefaultValue': '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``.

        
      

      - **EndpointSettings** *(list) --* 

        Descriptions of the endpoint settings available for your source or target database engine.

        
        

        - *(dict) --* 

          Endpoint settings.

          
          

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

            The name that you want to give the endpoint settings.

            
          

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

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

            
          

          - **EnumValues** *(list) --* 

            Enumerated values to use for this endpoint.

            
            

            - *(string) --* 
        
          

          - **Sensitive** *(boolean) --* 

            A value that marks this endpoint setting as sensitive.

            
          

          - **Units** *(string) --* 

            The unit of measure for this endpoint setting.

            
          

          - **Applicability** *(string) --* 

            The relevance or validity of an endpoint setting for an engine name and its endpoint type.

            
          

          - **IntValueMin** *(integer) --* 

            The minimum value of an endpoint setting that is of type ``int``.

            
          

          - **IntValueMax** *(integer) --* 

            The maximum value of an endpoint setting that is of type ``int``.

            
          

          - **DefaultValue** *(string) --* 

            The default value of the endpoint setting if no value is specified using ``CreateEndpoint`` or ``ModifyEndpoint``.

            
      
    
  