Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
start-lifecycle-policy-preview
[--registry-id <value>]
--repository-name <value>
[--lifecycle-policy-text <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--registry-id
(string)
The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
--repository-name
(string)
The name of the repository to be evaluated.
--lifecycle-policy-text
(string)
The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.
--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.
To create a lifecycle policy preview
The following start-lifecycle-policy-preview
example creates a lifecycle policy preview defined by a JSON file for the specified repository.
aws ecr start-lifecycle-policy-preview \
--repository-name "project-a/amazon-ecs-sample" \
--lifecycle-policy-text "file://policy.json"
Contents of policy.json
:
{
"rules": [
{
"rulePriority": 1,
"description": "Expire images older than 14 days",
"selection": {
"tagStatus": "untagged",
"countType": "sinceImagePushed",
"countUnit": "days",
"countNumber": 14
},
"action": {
"type": "expire"
}
}
]
}
Output:
{
"registryId": "012345678910",
"repositoryName": "project-a/amazon-ecs-sample",
"lifecyclePolicyText": "{\n \"rules\": [\n {\n \"rulePriority\": 1,\n \"description\": \"Expire images older than 14 days\",\n \"selection\": {\n \"tagStatus\": \"untagged\",\n \"countType\": \"sinceImagePushed\",\n \"countUnit\": \"days\",\n \"countNumber\": 14\n },\n \"action\": {\n \"type\": \"expire\"\n }\n }\n ]\n}\n",
"status": "IN_PROGRESS"
}
registryId -> (string)
The registry ID associated with the request.
repositoryName -> (string)
The repository name associated with the request.
lifecyclePolicyText -> (string)
The JSON repository policy text.
status -> (string)
The status of the lifecycle policy preview request.