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 . opensearch ]

list-instance-type-details

Description

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

See also: AWS API Documentation

Synopsis

  list-instance-type-details
--engine-version <value>
[--domain-name <value>]
[--max-results <value>]
[--next-token <value>]
[--retrieve-azs | --no-retrieve-azs]
[--instance-type <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

--engine-version (string)

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

--domain-name (string)

The name of the domain.

--max-results (integer)

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

--next-token (string)

If your initial ListInstanceTypeDetails operation returns a nextToken , you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

--retrieve-azs | --no-retrieve-azs (boolean)

An optional parameter that specifies the Availability Zones for the domain.

--instance-type (string)

An optional parameter that lists information for a given instance type.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

InstanceTypeDetails -> (list)

Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

(structure)

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

InstanceType -> (string)

The instance type.

EncryptionEnabled -> (boolean)

Whether encryption at rest and node-to-node encryption are supported for the instance type.

CognitoEnabled -> (boolean)

Whether Amazon Cognito access is supported for the instance type.

AppLogsEnabled -> (boolean)

Whether logging is supported for the instance type.

AdvancedSecurityEnabled -> (boolean)

Whether fine-grained access control is supported for the instance type.

WarmEnabled -> (boolean)

Whether UltraWarm is supported for the instance type.

InstanceRole -> (list)

Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.

(string)

AvailabilityZones -> (list)

The supported Availability Zones for the instance type.

(string)

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.