OpenSearchServiceServerless / Client / batch_get_collection

batch_get_collection#

OpenSearchServiceServerless.Client.batch_get_collection(**kwargs)#

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.

Request Syntax

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

Parameters:

ids (list) –
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) –
names (list) –
A list of collection names. You can’t provide names and IDs in the same request.
- (string) –

Return type:

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.

Exceptions

OpenSearchServiceServerless.Client.exceptions.InternalServerException
OpenSearchServiceServerless.Client.exceptions.ValidationException