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

**************************
create_outbound_connection
**************************



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

  

  Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination 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/CreateOutboundConnection>`_  


  **Request Syntax**
  ::

    response = client.create_outbound_connection(
        LocalDomainInfo={
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        RemoteDomainInfo={
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        ConnectionAlias='string',
        ConnectionMode='DIRECT'|'VPC_ENDPOINT',
        ConnectionProperties={
            'Endpoint': 'string',
            'CrossClusterSearch': {
                'SkipUnavailable': 'ENABLED'|'DISABLED'
            }
        }
    )
    
  :type LocalDomainInfo: dict
  :param LocalDomainInfo: **[REQUIRED]** 

    Name and Region of 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) --* **[REQUIRED]** 

        Name of the domain.

        

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

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

        

      
    
  
  :type RemoteDomainInfo: dict
  :param RemoteDomainInfo: **[REQUIRED]** 

    Name and Region of 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) --* **[REQUIRED]** 

        Name of the domain.

        

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

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

        

      
    
  
  :type ConnectionAlias: string
  :param ConnectionAlias: **[REQUIRED]** 

    Name of the connection.

    

  
  :type ConnectionMode: string
  :param ConnectionMode: 

    The connection mode.

    

  
  :type ConnectionProperties: dict
  :param ConnectionProperties: 

    The ``ConnectionProperties`` 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.

        

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

    
    ::

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

    

    - *(dict) --* 

      The result of a ``CreateOutboundConnection`` request. Contains details about the newly created 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.

            
      
    
      

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

        Name of the connection.

        
      

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

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

          
    
      

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

        The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.

        
      

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

        The connection mode.

        
      

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

        The ``ConnectionProperties`` for the newly created 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.

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

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

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

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

  