AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . opensearch ]

list-insights

Description

Lists insights for an Amazon OpenSearch Service domain or Amazon Web Services account. Returns a paginated list of insights based on the specified entity, filters, time range, and sort order.

See also: AWS API Documentation

Synopsis

  list-insights
--entity <value>
[--time-range <value>]
[--sort-order <value>]
[--max-results <value>]
[--next-token <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>]
[--v2-debug]

Options

--entity (structure)

The entity for which to list insights. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID.

Type -> (string)

The type of the entity. Possible values are Account and DomainName .

Value -> (string)

The value of the entity. For DomainName , this is the domain name. For Account , this is the Amazon Web Services account ID.

Shorthand Syntax:

Type=string,Value=string

JSON Syntax:

{
  "Type": "Account"|"DomainName",
  "Value": "string"
}

--time-range (structure)

The time range for filtering insights, specified as epoch millisecond timestamps.

From -> (long)

The start of the time range, in epoch milliseconds.

To -> (long)

The end of the time range, in epoch milliseconds.

Shorthand Syntax:

From=long,To=long

JSON Syntax:

{
  "From": long,
  "To": long
}

--sort-order (string)

The sort order for the results. Possible values are ASC (ascending) and DESC (descending).

Possible values:

  • ASC
  • DESC

--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. Valid values are 1 to 500.

--next-token (string)

If your initial ListInsights operation returns a NextToken , include the returned NextToken in subsequent ListInsights operations to retrieve the next page of results.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Insights -> (list)

The list of insights returned for the specified entity.

(structure)

Represents an insight returned by the ListInsights operation. An insight is a notification about a domain event or recommendation that helps you optimize your Amazon OpenSearch Service domain.

InsightId -> (string)

The unique identifier of the insight.

DisplayName -> (string)

The display name of the insight.

Type -> (string)

The type of the insight. Possible values are EVENT and RECOMMENDATION .

Priority -> (string)

The priority level of the insight. Possible values are CRITICAL , HIGH , MEDIUM , and LOW .

Status -> (string)

The current status of the insight. Possible values are ACTIVE , RESOLVED , and DISMISSED .

CreationTime -> (timestamp)

The timestamp when the insight was created, in epoch milliseconds.

UpdateTime -> (timestamp)

The timestamp when the insight was last updated, in epoch milliseconds.

IsExperimental -> (boolean)

Indicates whether the insight is experimental.

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.