Skip to content

describe_inbound_cross_cluster_search_connections

describe_inbound_cross_cluster_search_connections(
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeInboundCrossClusterSearchConnectionsResponse

Lists all the inbound cross-cluster search connections for a destination domain.

Parameters:

  • filters (Optional[FilterList], default: None ) –

    A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are:

    • cross-cluster-search-connection-id
    • source-domain-info.domain-name
    • source-domain-info.owner-id
    • source-domain-info.region
    • destination-domain-info.domain-name

  • max_results (Optional[MaxResults], default: None ) –

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • next_token (Optional[NextToken], default: None ) –

    NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

Raises:

  • DisabledOperationException –

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

  • InvalidPaginationTokenException –

    The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_elasticsearch_service/_services/elasticsearch_service.py
def describe_inbound_cross_cluster_search_connections(
    self,
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
    filters: Optional[
        "capo_elasticsearch_service.types.filter_list.FilterList"
    ] = None,
    max_results: Optional[
        "capo_elasticsearch_service.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_elasticsearch_service.types.next_token.NextToken"
    ] = None,
) -> "capo_elasticsearch_service.types.describe_inbound_cross_cluster_search_connections_response.DescribeInboundCrossClusterSearchConnectionsResponse":
    """<p>Lists all the inbound cross-cluster search connections for a destination domain.</p>

    Args:
        filters: <p> A list of filters used to match properties for inbound cross-cluster search connection. Available <code><a>Filter</a></code> names for this operation are: <ul> <li>cross-cluster-search-connection-id</li> <li>source-domain-info.domain-name</li> <li>source-domain-info.owner-id</li> <li>source-domain-info.region</li> <li>destination-domain-info.domain-name</li> </ul> </p>
        max_results: <p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>
        next_token: <p> NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.</p>

    Raises:
        capo_elasticsearch_service.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access a not supported operation. Gives http status code of 409.</p>
        capo_elasticsearch_service.errors.invalid_pagination_token_exception.InvalidPaginationTokenException: <p>The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400. </p>
        capo_elasticsearch_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_elasticsearch_service.types.describe_inbound_cross_cluster_search_connections_request.DescribeInboundCrossClusterSearchConnectionsRequest]",
    ) -> OperationResponse[
        "capo_elasticsearch_service.types.describe_inbound_cross_cluster_search_connections_response.DescribeInboundCrossClusterSearchConnectionsResponse"
    ]:
        import capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.describe_inbound_cross_cluster_search_connections

        output, http_response = (
            capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.describe_inbound_cross_cluster_search_connections.describe_inbound_cross_cluster_search_connections(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeInboundCrossClusterSearchConnections"),
    )
    input_: capo_elasticsearch_service.types.describe_inbound_cross_cluster_search_connections_request.DescribeInboundCrossClusterSearchConnectionsRequest = {}
    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