Amazon Elasticsearch Service
    Amazon Elasticsearch Service
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept
      PUT
    • /2015-01-01/tags
      POST
    • /2015-01-01/packages/associate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/cancel
      POST
    • /2015-01-01/es/domain
      POST
    • /2015-01-01/es/ccs/outboundConnection
      POST
    • /2015-01-01/packages
      POST
    • /2015-01-01/es/vpcEndpoints
      POST
    • /2015-01-01/es/vpcEndpoints
      GET
    • /2015-01-01/es/domain/{DomainName}
      DELETE
    • /2015-01-01/es/domain/{DomainName}
      GET
    • /2015-01-01/es/role
      DELETE
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/es/ccs/outboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/packages/{PackageID}
      DELETE
    • /2015-01-01/es/vpcEndpoints/{VpcEndpointId}
      DELETE
    • /2015-01-01/es/domain/{DomainName}/autoTunes
      GET
    • /2015-01-01/es/domain/{DomainName}/progress
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      POST
    • /2015-01-01/es/domain-info
      POST
    • /2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}
      GET
    • /2015-01-01/es/ccs/inboundConnection/search
      POST
    • /2015-01-01/es/ccs/outboundConnection/search
      POST
    • /2015-01-01/packages/describe
      POST
    • /2015-01-01/es/reservedInstanceOfferings
      GET
    • /2015-01-01/es/reservedInstances
      GET
    • /2015-01-01/es/vpcEndpoints/describe
      POST
    • /2015-01-01/packages/dissociate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/compatibleVersions
      GET
    • /2015-01-01/packages/{PackageID}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/status
      GET
    • /2015-01-01/domain
      GET
    • /2015-01-01/packages/{PackageID}/domains
      GET
    • /2015-01-01/es/instanceTypes/{ElasticsearchVersion}
      GET
    • /2015-01-01/es/versions
      GET
    • /2015-01-01/domain/{DomainName}/packages
      GET
    • /2015-01-01/tags/
      GET
    • /2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess
      GET
    • /2015-01-01/es/domain/{DomainName}/vpcEndpoints
      GET
    • /2015-01-01/es/purchaseReservedInstanceOffering
      POST
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject
      PUT
    • /2015-01-01/tags-removal
      POST
    • /2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/start
      POST
    • /2015-01-01/packages/update
      POST
    • /2015-01-01/es/vpcEndpoints/update
      POST
    • /2015-01-01/es/upgradeDomain
      POST

      /2015-01-01/es/ccs/outboundConnection

      The Amazon Elasticsearch Service multi-region endpoint
      http://es.{region}.amazonaws.com
      The Amazon Elasticsearch Service multi-region endpoint
      http://es.{region}.amazonaws.com
      POST
      /2015-01-01/es/ccs/outboundConnection
      Creates a new cross-cluster search connection from a source domain to a destination domain.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/ccs/outboundConnection' \
--header 'Content-Type: application/json' \
--data-raw '{
    "SourceDomainInfo": {
        "OwnerId": "stringstring",
        "DomainName": "string",
        "Region": "string"
    },
    "DestinationDomainInfo": {
        "OwnerId": "stringstring",
        "DomainName": "string",
        "Region": "string"
    },
    "ConnectionAlias": "string"
}'
      Response Response Example
      200 - Example 1
      {
  "SourceDomainInfo": {
    "OwnerId": "stringstring",
    "DomainName": "string",
    "Region": "string"
  },
  "DestinationDomainInfo": {
    "OwnerId": "stringstring",
    "DomainName": "string",
    "Region": "string"
  },
  "ConnectionAlias": "string",
  "ConnectionStatus": {
    "StatusCode": "PENDING_ACCEPTANCE",
    "Message": "string"
  },
  "CrossClusterSearchConnectionId": "string"
}

      Request

      Body Params application/json
      SourceDomainInfo
      object 
      required
      Specifies the DomainInformation for the source Elasticsearch domain.
      OwnerId
      string 
      optional
      >= 12 characters<= 12 characters
      DomainName
      string 
      optional
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
      >= 3 characters<= 28 characters
      Match pattern:
      [a-z][a-z0-9\-]+
      Region
      string 
      optional
      DestinationDomainInfo
      object 
      required
      Specifies the DomainInformation for the destination Elasticsearch domain.
      OwnerId
      string 
      optional
      >= 12 characters<= 12 characters
      DomainName
      string 
      optional
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
      >= 3 characters<= 28 characters
      Match pattern:
      [a-z][a-z0-9\-]+
      Region
      string 
      optional
      ConnectionAlias
      string 
      required
      Specifies the connection alias that will be used by the customer for this connection.
      <= 20 characters
      Examples

      Responses

      🟢200Success
      application/json
      Body
      The result of a <code><a>CreateOutboundCrossClusterSearchConnection</a></code> request. Contains the details of the newly created cross-cluster search connection.
      SourceDomainInfo
      object 
      optional
      Specifies the DomainInformation for the source Elasticsearch domain.
      OwnerId
      string 
      OwnerId
      optional
      >= 12 characters<= 12 characters
      DomainName
      string 
      DomainName
      required
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
      >= 3 characters<= 28 characters
      Match pattern:
      [a-z][a-z0-9\-]+
      Region
      string 
      Region
      optional
      DestinationDomainInfo
      object 
      optional
      Specifies the DomainInformation for the destination Elasticsearch domain.
      OwnerId
      string 
      OwnerId
      optional
      >= 12 characters<= 12 characters
      DomainName
      string 
      DomainName
      required
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
      >= 3 characters<= 28 characters
      Match pattern:
      [a-z][a-z0-9\-]+
      Region
      string 
      Region
      optional
      ConnectionAlias
      string 
      optional
      Specifies the connection alias provided during the create connection request.
      <= 20 characters
      ConnectionStatus
      object 
      optional
      Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.
      StatusCode
      enum<string> 
      optional
      The state code for outbound connection. This 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 destination domain owner.
      • PROVISIONING: Outbound connection request is in process.
      • ACTIVE: Outbound connection is active and ready to use.
      • REJECTED: Outbound connection request is rejected by destination domain owner.
      • DELETING: Outbound connection deletion is in progress.
      • DELETED: Outbound connection is deleted and cannot be used further.
      Allowed values:
      PENDING_ACCEPTANCEVALIDATINGVALIDATION_FAILEDPROVISIONINGACTIVEREJECTEDDELETINGDELETED
      Message
      string 
      optional
      Specifies verbose information for the outbound connection status.
      CrossClusterSearchConnectionId
      string 
      optional
      Unique id for the created outbound connection, which is used for subsequent operations on connection.
      🟠480LimitExceededException
      🟠481InternalException
      🟠482ResourceAlreadyExistsException
      🟠483DisabledOperationException
      Modified at over 1 year ago
      Previous
      /2015-01-01/es/domain
      Next
      /2015-01-01/packages
      Built with