OpenSearchService / Client / describe_inbound_connections

describe_inbound_connections#

OpenSearchService.Client.describe_inbound_connections(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_inbound_connections(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • Filters (list) –

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

    • (dict) –

      A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

      • Name (string) –

        The name of the filter.

      • Values (list) –

        One or more values for the filter.

        • (string) –

  • MaxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Connections': [
        {
            'LocalDomainInfo': {
                'AWSDomainInformation': {
                    'OwnerId': 'string',
                    'DomainName': 'string',
                    'Region': 'string'
                }
            },
            'RemoteDomainInfo': {
                'AWSDomainInformation': {
                    'OwnerId': 'string',
                    'DomainName': 'string',
                    'Region': 'string'
                }
            },
            'ConnectionId': 'string',
            'ConnectionStatus': {
                'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
                'Message': 'string'
            },
            'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Contains a list of connections matching the filter criteria.

    • Connections (list) –

      List of inbound connections.

      • (dict) –

        Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.

        • LocalDomainInfo (dict) –

          Information about the source (local) domain.

          • AWSDomainInformation (dict) –

            Information about an Amazon OpenSearch Service domain.

            • OwnerId (string) –

              The Amazon Web Services account ID of the domain owner.

            • DomainName (string) –

              Name of the domain.

            • Region (string) –

              The Amazon Web Services Region in which the domain is located.

        • RemoteDomainInfo (dict) –

          Information about the destination (remote) domain.

          • AWSDomainInformation (dict) –

            Information about an Amazon OpenSearch Service domain.

            • OwnerId (string) –

              The Amazon Web Services account ID of the domain owner.

            • DomainName (string) –

              Name of the domain.

            • Region (string) –

              The Amazon Web Services Region in which the domain is located.

        • ConnectionId (string) –

          The unique identifier of the connection.

        • ConnectionStatus (dict) –

          The current status of the connection.

          • StatusCode (string) –

            The status code for the connection. Can be one of the following:

            • PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.

            • APPROVED: Inbound connection is pending acceptance by the remote domain owner.

            • PROVISIONING: Inbound connection is being provisioned.

            • ACTIVE: Inbound connection is active and ready to use.

            • REJECTING: Inbound connection rejection is in process.

            • REJECTED: Inbound connection is rejected.

            • DELETING: Inbound connection deletion is in progress.

            • DELETED: Inbound connection is deleted and can no longer be used.

          • Message (string) –

            Information about the connection.

        • ConnectionMode (string) –

          The connection mode.

    • NextToken (string) –

      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.

Exceptions