:doc:`OpenSearchServiceServerless <../../opensearchserverless>` / Client / batch_get_collection

********************
batch_get_collection
********************



.. py:method:: OpenSearchServiceServerless.Client.batch_get_collection(**kwargs)

  

  Returns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints. For more information, see `Creating and managing Amazon OpenSearch Serverless collections <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetCollection>`_  


  **Request Syntax**
  ::

    response = 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 <https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html>`__ 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': [
              {
                  'id': 'string',
                  'name': 'string',
                  'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED',
                  'type': 'SEARCH'|'TIMESERIES'|'VECTORSEARCH',
                  'description': 'string',
                  'arn': 'string',
                  'kmsKeyArn': 'string',
                  'standbyReplicas': 'ENABLED'|'DISABLED',
                  'vectorOptions': {
                      'ServerlessVectorAcceleration': 'ENABLED'|'DISABLED'|'ALLOWED'
                  },
                  'createdDate': 123,
                  'lastModifiedDate': 123,
                  'collectionEndpoint': 'string',
                  'dashboardEndpoint': 'string',
                  'fipsEndpoints': {
                      'collectionEndpoint': 'string',
                      'dashboardEndpoint': 'string'
                  },
                  'failureCode': 'string',
                  'failureMessage': 'string',
                  'collectionGroupName': 'string'
              },
          ],
          'collectionErrorDetails': [
              {
                  'id': 'string',
                  'name': 'string',
                  'errorMessage': 'string',
                  'errorCode': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **collectionDetails** *(list) --* 

        Details about each collection.

        
        

        - *(dict) --* 

          Details about each OpenSearch Serverless collection, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints for federal government workloads.

          
          

          - **id** *(string) --* 

            A unique identifier for the collection.

            
          

          - **name** *(string) --* 

            The name of the collection.

            
          

          - **status** *(string) --* 

            The current status of the collection.

            
          

          - **type** *(string) --* 

            The type of collection.

            
          

          - **description** *(string) --* 

            A description of the collection.

            
          

          - **arn** *(string) --* 

            The Amazon Resource Name (ARN) of the collection.

            
          

          - **kmsKeyArn** *(string) --* 

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

            
          

          - **standbyReplicas** *(string) --* 

            Details about an OpenSearch Serverless collection.

            
          

          - **vectorOptions** *(dict) --* 

            Configuration options for vector search capabilities in the collection.

            
            

            - **ServerlessVectorAcceleration** *(string) --* 

              Specifies whether serverless vector acceleration is enabled for the collection.

              
        
          

          - **createdDate** *(integer) --* 

            The Epoch time when the collection was created.

            
          

          - **lastModifiedDate** *(integer) --* 

            The date and time when the collection was last modified.

            
          

          - **collectionEndpoint** *(string) --* 

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

            
          

          - **dashboardEndpoint** *(string) --* 

            Collection-specific endpoint used to access OpenSearch Dashboards.

            
          

          - **fipsEndpoints** *(dict) --* 

            FIPS-compliant endpoints for the collection. These endpoints use FIPS 140-3 validated cryptographic modules and are required for federal government workloads that must comply with FedRAMP security standards.

            
            

            - **collectionEndpoint** *(string) --* 

              FIPS-compliant collection endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government workloads.

              
            

            - **dashboardEndpoint** *(string) --* 

              FIPS-compliant endpoint used to access OpenSearch Dashboards. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government workloads that need dashboard visualization capabilities.

              
        
          

          - **failureCode** *(string) --* 

            A failure code associated with the request.

            
          

          - **failureMessage** *(string) --* 

            A message associated with the failure code.

            
          

          - **collectionGroupName** *(string) --* 

            The name of the collection group that contains this collection.

            
      
    
      

      - **collectionErrorDetails** *(list) --* 

        Error information for the request.

        
        

        - *(dict) --* 

          Error information for an OpenSearch Serverless request.

          
          

          - **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.

            
          

          - **errorMessage** *(string) --* 

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

            
          

          - **errorCode** *(string) --* 

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`OpenSearchServiceServerless.Client.exceptions.InternalServerException`

  
  *   :py:class:`OpenSearchServiceServerless.Client.exceptions.ValidationException`

  