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.
Parameters:
-
filters
(Optional[FilterList], default:
None
)
–
A list of filters used to match properties for inbound cross-cluster connections.
-
max_results
(Optional[MaxResults], default:
None
)
–
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
-
next_token
(Optional[NextToken], default:
None
)
–
If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.
Raises:
Source code in docs_src/capo_opensearch/_services/open_search.py
| def describe_inbound_connections(
self,
*,
config_overrides: Optional[OpenSearchClientConfig] = None,
filters: Optional["capo_opensearch.types.filter_list.FilterList"] = None,
max_results: Optional["capo_opensearch.types.max_results.MaxResults"] = None,
next_token: Optional["capo_opensearch.types.next_token.NextToken"] = None,
) -> "capo_opensearch.types.describe_inbound_connections_response.DescribeInboundConnectionsResponse":
"""<p>Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.</p>
Args:
filters: <p> A list of filters used to match properties for inbound cross-cluster connections.</p>
max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results.</p>
next_token: <p>If your initial <code>DescribeInboundConnections</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>DescribeInboundConnections</code> operations, which returns results in the next page.</p>
Raises:
capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
capo_opensearch.errors.invalid_pagination_token_exception.InvalidPaginationTokenException: <p>Request processing failed because you provided an invalid pagination token.</p>
capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_opensearch.types.describe_inbound_connections_request.DescribeInboundConnectionsRequest]",
) -> OperationResponse[
"capo_opensearch.types.describe_inbound_connections_response.DescribeInboundConnectionsResponse"
]:
import capo_opensearch._operations.amazon_open_search_service.describe_inbound_connections
output, http_response = (
capo_opensearch._operations.amazon_open_search_service.describe_inbound_connections.describe_inbound_connections(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeInboundConnections")
)
input_: capo_opensearch.types.describe_inbound_connections_request.DescribeInboundConnectionsRequest = {}
if filters is not None:
input_["filters"] = filters
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|