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 ]

list-lifecycle-policies

Description

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies .

See also: AWS API Documentation

Synopsis

  list-lifecycle-policies
[--max-results <value>]
[--next-token <value>]
[--resources <value>]
--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

--max-results (integer)

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

--next-token (string)

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

--resources (list)

Resource filters that policies can apply to. Currently, the only supported resource type is index .

(string)

Syntax:

"string" "string" ...

--type (string)

The type of lifecycle policy.

Possible values:

• retention

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

lifecyclePolicySummaries -> (list)

Details about the requested lifecycle policies.

(structure)

A summary of the lifecycle policy.

createdDate -> (long)

The Epoch time when the lifecycle policy was created.

description -> (string)

The description of the lifecycle policy.

lastModifiedDate -> (long)

The date and time when the lifecycle policy was last modified.

name -> (string)

The name of the lifecycle policy.

policyVersion -> (string)

The version of the lifecycle policy.

type -> (string)

The type of lifecycle policy.

nextToken -> (string)

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.