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-effective-lifecycle-policy

Description

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies .

See also: AWS API Documentation

Synopsis

  batch-get-effective-lifecycle-policy
--resource-identifiers <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

--resource-identifiers (list)

The unique identifiers of policy types and resource names.

(structure)

The unique identifiers of policy types and resource names.

resource -> (string)

The name of the OpenSearch Serverless ilndex resource.

type -> (string)

The type of lifecycle policy.

Shorthand Syntax:

resource=string,type=string ...

JSON Syntax:

[
  {
    "resource": "string",
    "type": "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.

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

effectiveLifecyclePolicyDetails -> (list)

A list of lifecycle policies applied to the OpenSearch Serverless indexes.

(structure)

Error information for an OpenSearch Serverless request.

noMinRetentionPeriod -> (boolean)

The minimum number of index retention days set. That is an optional param that will return as true if the minimum number of days or hours is not set to a index resource.

policyName -> (string)

The name of the lifecycle policy.

resource -> (string)

The name of the OpenSearch Serverless index resource.

resourceType -> (string)

The type of OpenSearch Serverless resource. Currently, the only supported resource is index .

retentionPeriod -> (string)

The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.

type -> (string)

The type of lifecycle policy.

effectiveLifecyclePolicyErrorDetails -> (list)

A list of resources for which retrieval failed.

(structure)

Error information for an OpenSearch Serverless request.

errorCode -> (string)

The error code for the request.

errorMessage -> (string)

A description of the error. For example, The specified Index resource is not found .

resource -> (string)

The name of OpenSearch Serverless index resource.

type -> (string)

The type of lifecycle policy.