OpenSearch Service Serverless

{'collectionDetails': {'failureCode': 'string', 'failureMessage': 'string'}}

Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

See also: AWS API Documentation

Request Syntax

client.batch_get_collection(
    ids=[
        'string',
    ],
    names=[
        'string',
    ]
)

type ids:

list

param ids:

A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

• (string) --

type names:

list

param names:

A list of collection names. You can't provide names and IDs in the same request.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'collectionDetails': [
        {
            'arn': 'string',
            'collectionEndpoint': 'string',
            'createdDate': 123,
            'dashboardEndpoint': 'string',
            'description': 'string',
            'failureCode': 'string',
            'failureMessage': 'string',
            'id': 'string',
            'kmsKeyArn': 'string',
            'lastModifiedDate': 123,
            'name': 'string',
            'standbyReplicas': 'ENABLED'|'DISABLED',
            'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED',
            'type': 'SEARCH'|'TIMESERIES'|'VECTORSEARCH'
        },
    ],
    'collectionErrorDetails': [
        {
            'errorCode': 'string',
            'errorMessage': 'string',
            'id': 'string',
            'name': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • collectionDetails (list) --

    Details about each collection.

    • (dict) --

      Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.

      • arn (string) --

        The Amazon Resource Name (ARN) of the collection.

      • collectionEndpoint (string) --

        Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

      • createdDate (integer) --

        The Epoch time when the collection was created.

      • dashboardEndpoint (string) --

        Collection-specific endpoint used to access OpenSearch Dashboards.

      • description (string) --

        A description of the collection.

      • failureCode (string) --

        A failure code associated with the request.

      • failureMessage (string) --

        A message associated with the failure code.

      • id (string) --

        A unique identifier for the collection.

      • kmsKeyArn (string) --

        The ARN of the Amazon Web Services KMS key used to encrypt the collection.

      • lastModifiedDate (integer) --

        The date and time when the collection was last modified.

      • name (string) --

        The name of the collection.

      • standbyReplicas (string) --

        Details about an OpenSearch Serverless collection.

      • status (string) --

        The current status of the collection.

      • type (string) --

        The type of collection.

  • collectionErrorDetails (list) --

    Error information for the request.

    • (dict) --

      Error information for an OpenSearch Serverless request.

      • errorCode (string) --

        The error code for the request. For example, NOT_FOUND.

      • errorMessage (string) --

        A description of the error. For example, The specified Collection is not found.

      • id (string) --

        If the request contains collection IDs, the response includes the IDs provided in the request.

      • name (string) --

        If the request contains collection names, the response includes the names provided in the request.

{'vpcEndpointDetails': {'failureCode': 'string', 'failureMessage': 'string'}}

Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

See also: AWS API Documentation

Request Syntax

client.batch_get_vpc_endpoint(
    ids=[
        'string',
    ]
)

type ids:

list

param ids:

[REQUIRED]

A list of VPC endpoint identifiers.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'vpcEndpointDetails': [
        {
            'createdDate': 123,
            'failureCode': 'string',
            'failureMessage': 'string',
            'id': 'string',
            'name': 'string',
            'securityGroupIds': [
                'string',
            ],
            'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED',
            'subnetIds': [
                'string',
            ],
            'vpcId': 'string'
        },
    ],
    'vpcEndpointErrorDetails': [
        {
            'errorCode': 'string',
            'errorMessage': 'string',
            'id': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • vpcEndpointDetails (list) --

    Details about the specified VPC endpoint.

    • (dict) --

      Details about an OpenSearch Serverless-managed interface endpoint.

      • createdDate (integer) --

        The date the endpoint was created.

      • failureCode (string) --

        A failure code associated with the request.

      • failureMessage (string) --

        A message associated with the failure code.

      • id (string) --

        The unique identifier of the endpoint.

      • name (string) --

        The name of the endpoint.

      • securityGroupIds (list) --

        The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

        • (string) --

      • status (string) --

        The current status of the endpoint.

      • subnetIds (list) --

        The ID of the subnets from which you access OpenSearch Serverless.

        • (string) --

      • vpcId (string) --

        The ID of the VPC from which you access OpenSearch Serverless.

  • vpcEndpointErrorDetails (list) --

    Error information for a failed request.

    • (dict) --

      Error information for a failed BatchGetVpcEndpoint request.

      • errorCode (string) --

        The error code for the failed request.

      • errorMessage (string) --

        An error message describing the reason for the failure.

      • id (string) --

        The unique identifier of the VPC endpoint.