Menu
Amazon EC2 Container Registry
API Reference (API Version 2015-09-21)

GetLifecyclePolicyPreview

Retrieves the results of the specified lifecycle policy preview request.

Request Syntax

{
   "filter": { 
      "tagStatus": "string"
   },
   "imageIds": [ 
      { 
         "imageDigest": "string",
         "imageTag": "string"
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "registryId": "string",
   "repositoryName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

filter

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

Type: LifecyclePolicyPreviewFilter object

Required: No

imageIds

The list of imageIDs to be included.

Type: Array of ImageIdentifier objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

maxResults

The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a single page along with a nextToken
 response element. The remaining results of the initial request can be seen by sending
 another GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value. This value can be between 1 and 100. If this
 parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
 100 results and a nextToken value, if
 applicable.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The nextToken value returned from a previous paginated
 GetLifecyclePolicyPreviewRequest request where maxResults was used and the
 results exceeded the value of that parameter. Pagination continues from the end of the
 previous results that returned the nextToken value. This value is
 null when there are no more results to return.

Type: String

Required: No

registryId

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

Type: String

Pattern: [0-9]{12}

Required: No

repositoryName

The name of the repository.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 256.

Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*

Required: Yes

Response Syntax

{
   "lifecyclePolicyText": "string",
   "nextToken": "string",
   "previewResults": [ 
      { 
         "action": { 
            "type": "string"
         },
         "appliedRulePriority": number,
         "imageDigest": "string",
         "imagePushedAt": number,
         "imageTags": [ "string" ]
      }
   ],
   "registryId": "string",
   "repositoryName": "string",
   "status": "string",
   "summary": { 
      "expiringImageTotalCount": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

lifecyclePolicyText

The JSON lifecycle policy text.

Type: String

Length Constraints: Minimum length of 100. Maximum length of 10240.

nextToken

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.

Type: String

previewResults

The results of the lifecycle policy preview request.

Type: Array of LifecyclePolicyPreviewResult objects

registryId

The registry ID associated with the request.

Type: String

Pattern: [0-9]{12}

repositoryName

The repository name associated with the request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 256.

Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*

status

The status of the lifecycle policy preview request.

Type: String

Valid Values: IN_PROGRESS | COMPLETE | EXPIRED | FAILED

summary

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

Type: LifecyclePolicyPreviewSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

HTTP Status Code: 400

LifecyclePolicyPreviewNotFoundException

There is no dry run for this repository.

HTTP Status Code: 400

RepositoryNotFoundException

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server-side issue.

HTTP Status Code: 500

Example

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example retrieves the result of a lifecycle policy preview for a repository called project-a/amazon-ecs-sample in the default registry for an account.

Sample Request

Copy
POST / HTTP/1.1 Host: ecr.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonEC2ContainerRegistry_V20150921.GetLifecyclePolicyPreview Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.11.144 Python/3.6.1 Darwin/16.6.0 botocore/1.7.2 X-Amz-Date: 20170901T222304Z Authorization: AUTHPARAMS Content-Length: 48 { "repositoryName": "project-a/amazon-ecs-sample" }

Sample Response

Copy
HTTP/1.1 200 OK Server: Server Date: Fri, 01 Sep 2017 22:23:06 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 640 Connection: keep-alive x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f { "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", "previewResults":[], "registryId":"012345678910", "repositoryName":"project-a/amazon-ecs-sample", "status":"COMPLETE", "summary":{"expiringImageTotalCount":0} }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: