Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeOutboundConnections

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.

Request Syntax


POST /2021-01-01/opensearch/cc/outboundConnection/search HTTP/1.1
Content-type: application/json

{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filters

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

Type: Array of Filter objects

Required: No

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

Valid Range: Maximum value of 100.

Required: No

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.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Connections": [ 
      { 
         "ConnectionAlias": "string",
         "ConnectionId": "string",
         "ConnectionMode": "string",
         "ConnectionProperties": { 
            "CrossClusterSearch": { 
               "SkipUnavailable": "string"
            },
            "Endpoint": "string"
         },
         "ConnectionStatus": { 
            "Message": "string",
            "StatusCode": "string"
         },
         "LocalDomainInfo": { 
            "AWSDomainInformation": { 
               "DomainName": "string",
               "OwnerId": "string",
               "Region": "string"
            }
         },
         "RemoteDomainInfo": { 
            "AWSDomainInformation": { 
               "DomainName": "string",
               "OwnerId": "string",
               "Region": "string"
            }
         }
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Connections

List of outbound connections that match the filter criteria.

Type: Array of OutboundConnection objects

NextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InvalidPaginationTokenException

Request processing failed because you provided an invalid pagination token.

HTTP Status Code: 400