Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain¶

Description¶

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.

Usage¶

opensearchservice_describe_outbound_connections(Filters, MaxResults,
  NextToken)

Arguments¶

Filters

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

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

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

Value¶

A list with the following syntax:

list(
  Connections = list(
    list(
      LocalDomainInfo = list(
        AWSDomainInformation = list(
          OwnerId = "string",
          DomainName = "string",
          Region = "string"
        )
      ),
      RemoteDomainInfo = list(
        AWSDomainInformation = list(
          OwnerId = "string",
          DomainName = "string",
          Region = "string"
        )
      ),
      ConnectionId = "string",
      ConnectionAlias = "string",
      ConnectionStatus = list(
        StatusCode = "VALIDATING"|"VALIDATION_FAILED"|"PENDING_ACCEPTANCE"|"APPROVED"|"PROVISIONING"|"ACTIVE"|"REJECTING"|"REJECTED"|"DELETING"|"DELETED",
        Message = "string"
      ),
      ConnectionMode = "DIRECT"|"VPC_ENDPOINT",
      ConnectionProperties = list(
        Endpoint = "string",
        CrossClusterSearch = list(
          SkipUnavailable = "ENABLED"|"DISABLED"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_outbound_connections(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)