get-lifecycle-policy-preview¶

Description¶

Retrieves the results of the lifecycle policy preview request for the specified repository.

Synopsis¶

  get-lifecycle-policy-preview
[--registry-id <value>]
--repository-name <value>
[--image-ids <value>]
[--filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

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

--image-ids (list)

The list of imageIDs to be included.

(structure)

An object with identifying information for an image in an Amazon ECR repository.

imageDigest -> (string)

The sha256 digest of the image manifest.

imageTag -> (string)

The tag used for the image.

Shorthand Syntax:

imageDigest=string,imageTag=string ...

JSON Syntax:

[
  {
    "imageDigest": "string",
    "imageTag": "string"
  }
  ...
]

--filter (structure)

An optional parameter that filters results based on image tag status and all tags, if tagged.

tagStatus -> (string)

The tag status of the image.

Shorthand Syntax:

tagStatus=string

JSON Syntax:

{
  "tagStatus": "TAGGED"|"UNTAGGED"|"ANY"
}

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 retrieve details for a lifecycle policy preview

The following get-lifecycle-policy-preview example retrieves the result of a lifecycle policy preview for the specified repository in the default registry for an account.

Command:

aws ecr get-lifecycle-policy-preview \
    --repository-name "project-a/amazon-ecs-sample"

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": "COMPLETE",
    "previewResults": [],
    "summary": {
        "expiringImageTotalCount": 0
    }
}

For more information, see Lifecycle Policies in the Amazon ECR User Guide.

Output¶

registryId -> (string)

The registry ID associated with the request.

repositoryName -> (string)

The repository name associated with the request.

lifecyclePolicyText -> (string)

The JSON lifecycle policy text.

status -> (string)

The status of the lifecycle policy preview request.

nextToken -> (string)

The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

previewResults -> (list)

The results of the lifecycle policy preview request.

(structure)

The result of the lifecycle policy preview.

imageTags -> (list)

The list of tags associated with this image.

(string)

imageDigest -> (string)

The sha256 digest of the image manifest.

imagePushedAt -> (timestamp)

The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.

action -> (structure)

The type of action to be taken.

type -> (string)

The type of action to be taken.

appliedRulePriority -> (integer)

The priority of the applied rule.

summary -> (structure)

The list of images that is returned as a result of the action.

expiringImageTotalCount -> (integer)

The number of expiring images.

Table of Contents

Feedback

User Guide