AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . opensearchserverless ]

batch-get-collection

Description

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

Synopsis

  batch-get-collection
[--ids <value>]
[--names <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--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)

Syntax:

"string" "string" ...

--names (list)

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

(string)

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

collectionDetails -> (list)

Details about each collection.

(structure)

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 -> (long)

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.

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 -> (long)

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.

(structure)

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.