[ aws . mediastore ]

get-lifecycle-policy

Description

Retrieves the object lifecycle policy that is assigned to a container.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-lifecycle-policy
--container-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--container-name (string)

The name of the container that the object lifecycle policy is assigned to.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To view an object lifecycle policy

The following get-lifecycle-policy example displays the object lifecycle policy attached to the specified container.

aws mediastore get-lifecycle-policy \
    --container-name LiveEvents

Output:

{
    "LifecyclePolicy": {
        "rules": [
            {
                "definition": {
                    "path": [
                        {
                            "prefix": "Football/"
                        },
                        {
                            "prefix": "Baseball/"
                        }
                    ],
                    "days_since_create": [
                        {
                            "numeric": [
                                ">",
                                28
                            ]
                        }
                    ]
                },
                "action": "EXPIRE"
            }
        ]
    }
}

For more information, see Viewing an Object Lifecycle Policy in the AWS Elemental MediaStore User Guide.

Output

LifecyclePolicy -> (string)

The object lifecycle policy that is assigned to the container.