:doc:`OpenSearchService <../../opensearch>` / Client / describe_outbound_connections

*****************************
describe_outbound_connections
*****************************



.. py:method:: OpenSearchService.Client.describe_outbound_connections(**kwargs)

  

  Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see `Cross-cluster search for Amazon OpenSearch Service <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeOutboundConnections>`_  


  **Request Syntax**
  ::

    response = client.describe_outbound_connections(
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxResults=123,
        NextToken='string'
    )
    
  :type Filters: list
  :param Filters: 

    List of filter names and values that you can use for requests.

    

  
    - *(dict) --* 

      A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

      

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

        The name of the filter.

        

      
      - **Values** *(list) --* 

        One or more values for the filter.

        

      
        - *(string) --* 

        
    
    

  :type MaxResults: integer
  :param MaxResults: 

    An optional parameter that specifies the maximum number of results to return. You can use ``nextToken`` to get the next page of results.

    

  
  :type NextToken: string
  :param NextToken: 

    If your initial ``DescribeOutboundConnections`` operation returns a ``nextToken``, you can include the returned ``nextToken`` in subsequent ``DescribeOutboundConnections`` operations, which returns results in the next page.

    

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

    
    ::

      {
          'Connections': [
              {
                  'LocalDomainInfo': {
                      'AWSDomainInformation': {
                          'OwnerId': 'string',
                          'DomainName': 'string',
                          'Region': 'string'
                      }
                  },
                  'RemoteDomainInfo': {
                      'AWSDomainInformation': {
                          'OwnerId': 'string',
                          'DomainName': 'string',
                          'Region': 'string'
                      }
                  },
                  'ConnectionId': 'string',
                  'ConnectionAlias': 'string',
                  'ConnectionStatus': {
                      'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
                      'Message': 'string'
                  },
                  'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT',
                  'ConnectionProperties': {
                      'Endpoint': 'string',
                      'CrossClusterSearch': {
                          'SkipUnavailable': 'ENABLED'|'DISABLED'
                      }
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Contains a list of connections matching the filter criteria.

      
      

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

        List of outbound connections that match the filter criteria.

        
        

        - *(dict) --* 

          Specifies details about an outbound cross-cluster connection.

          
          

          - **LocalDomainInfo** *(dict) --* 

            Information about the source (local) domain.

            
            

            - **AWSDomainInformation** *(dict) --* 

              Information about an Amazon OpenSearch Service domain.

              
              

              - **OwnerId** *(string) --* 

                The Amazon Web Services account ID of the domain owner.

                
              

              - **DomainName** *(string) --* 

                Name of the domain.

                
              

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

                The Amazon Web Services Region in which the domain is located.

                
          
        
          

          - **RemoteDomainInfo** *(dict) --* 

            Information about the destination (remote) domain.

            
            

            - **AWSDomainInformation** *(dict) --* 

              Information about an Amazon OpenSearch Service domain.

              
              

              - **OwnerId** *(string) --* 

                The Amazon Web Services account ID of the domain owner.

                
              

              - **DomainName** *(string) --* 

                Name of the domain.

                
              

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

                The Amazon Web Services Region in which the domain is located.

                
          
        
          

          - **ConnectionId** *(string) --* 

            Unique identifier of the connection.

            
          

          - **ConnectionAlias** *(string) --* 

            Name of the connection.

            
          

          - **ConnectionStatus** *(dict) --* 

            Status of the connection.

            
            

            - **StatusCode** *(string) --* 

              The status code for the outbound connection. Can be one of the following:

               

              
              * **VALIDATING** - The outbound connection request is being validated.
               
              * **VALIDATION_FAILED** - Validation failed for the connection request.
               
              * **PENDING_ACCEPTANCE**: Outbound connection request is validated and is not yet accepted by the remote domain owner.
               
              * **APPROVED** - Outbound connection has been approved by the remote domain owner for getting provisioned.
               
              * **PROVISIONING** - Outbound connection request is in process.
               
              * **ACTIVE** - Outbound connection is active and ready to use.
               
              * **REJECTING** - Outbound connection rejection by remote domain owner is in progress.
               
              * **REJECTED** - Outbound connection request is rejected by remote domain owner.
               
              * **DELETING** - Outbound connection deletion is in progress.
               
              * **DELETED** - Outbound connection is deleted and can no longer be used.
              

              
            

            - **Message** *(string) --* 

              Verbose information for the outbound connection.

              
        
          

          - **ConnectionMode** *(string) --* 

            The connection mode.

            
          

          - **ConnectionProperties** *(dict) --* 

            Properties for the outbound connection.

            
            

            - **Endpoint** *(string) --* 

              .. warning::

                

                The Endpoint attribute cannot be modified.

                 

               

              The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

              
            

            - **CrossClusterSearch** *(dict) --* 

              The connection properties for cross cluster search.

              
              

              - **SkipUnavailable** *(string) --* 

                The status of the ``SkipUnavailable`` setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.

                
          
        
      
    
      

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

        When ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

        
  
  **Exceptions**
  
  *   :py:class:`OpenSearchService.Client.exceptions.InvalidPaginationTokenException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.DisabledOperationException`

  