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

********************
describe_connections
********************



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

  

  Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

  

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


  **Request Syntax**
  ::

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

    The filters applied to the connection.

     

    Valid filter names: endpoint-arn | replication-instance-arn

    

  
    - *(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',
          'Connections': [
              {
                  'ReplicationInstanceArn': 'string',
                  'EndpointArn': 'string',
                  'Status': 'string',
                  'LastFailureMessage': 'string',
                  'EndpointIdentifier': 'string',
                  'ReplicationInstanceIdentifier': '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``.

        
      

      - **Connections** *(list) --* 

        A description of the connections.

        
        

        - *(dict) --* 

          Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.

          
          

          - **ReplicationInstanceArn** *(string) --* 

            The ARN of the replication instance.

            
          

          - **EndpointArn** *(string) --* 

            The ARN string that uniquely identifies the endpoint.

            
          

          - **Status** *(string) --* 

            The connection status. This parameter can return one of the following values:

             

            
            * ``"successful"``
             
            * ``"testing"``
             
            * ``"failed"``
             
            * ``"deleting"``
            

            
          

          - **LastFailureMessage** *(string) --* 

            The error message when the connection last failed.

            
          

          - **EndpointIdentifier** *(string) --* 

            The identifier of the endpoint. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

            
          

          - **ReplicationInstanceIdentifier** *(string) --* 

            The replication instance identifier. This parameter is stored as a lowercase string.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault`

  

  **Examples**

  Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
  ::

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

  
  Expected Output:
  ::

    {
        'Connections': [
            {
                'EndpointArn': 'arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE',
                'EndpointIdentifier': 'testsrc1',
                'ReplicationInstanceArn': 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ',
                'ReplicationInstanceIdentifier': 'test',
                'Status': 'successful',
            },
        ],
        'Marker': '',
        'ResponseMetadata': {
            '...': '...',
        },
    }

  