You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ECR::Types::GetLifecyclePolicyPreviewRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetLifecyclePolicyPreviewRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  registry_id: "RegistryId",
  repository_name: "RepositoryName", # required
  image_ids: [
    {
      image_digest: "ImageDigest",
      image_tag: "ImageTag",
    },
  ],
  next_token: "NextToken",
  max_results: 1,
  filter: {
    tag_status: "TAGGED", # accepts TAGGED, UNTAGGED, ANY
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::LifecyclePolicyPreviewFilter

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

Returns:

#image_ids ⇒ Array<Types::ImageIdentifier>

The list of imageIDs to be included.

Returns:

#max_results ⇒ Integer

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 1000. If this
 parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
 100 results and a nextToken value, if
 applicable. This option cannot be used when you specify images with imageIds.

Returns:

  • (Integer) —

    The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
 paginated output.

#next_token ⇒ String

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. This option cannot be used when you specify images with imageIds.

Returns:

  • (String) —

    The nextToken value returned from a previous paginated
 GetLifecyclePolicyPreviewRequest request where maxResults was used and the
 results exceeded the value of that parameter.

#registry_id ⇒ String

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

Returns:

  • (String) —

    The AWS account ID associated with the registry that contains the repository.

#repository_name ⇒ String

The name of the repository.

Returns:

  • (String) —

    The name of the repository.