Describe Inbound Connections

opensearchservice_describe_inbound_connections

R Documentation

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain

Description

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Usage

opensearchservice_describe_inbound_connections(Filters, MaxResults,
  NextToken)

Arguments

Filters

A list of filters used to match properties for inbound cross-cluster connections.

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_inbound_connections operation returns a nextToken, you can include the returned nextToken in subsequent describe_inbound_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",
      ConnectionStatus = list(
        StatusCode = "PENDING_ACCEPTANCE"|"APPROVED"|"PROVISIONING"|"ACTIVE"|"REJECTING"|"REJECTED"|"DELETING"|"DELETED",
        Message = "string"
      ),
      ConnectionMode = "DIRECT"|"VPC_ENDPOINT"
    )
  ),
  NextToken = "string"
)

Request syntax

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