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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb

Overview

Note:

When making an API call, you may pass GetLifecyclePolicyPreviewRequest data as a 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
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::LifecyclePolicyPreviewFilter

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



789
790
791
792
793
794
795
796
797
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 789

class GetLifecyclePolicyPreviewRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end

#image_idsArray<Types::ImageIdentifier>

The list of imageIDs to be included.

Returns:



789
790
791
792
793
794
795
796
797
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 789

class GetLifecyclePolicyPreviewRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


789
790
791
792
793
794
795
796
797
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 789

class GetLifecyclePolicyPreviewRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


789
790
791
792
793
794
795
796
797
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 789

class GetLifecyclePolicyPreviewRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end

#registry_idString

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)


789
790
791
792
793
794
795
796
797
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 789

class GetLifecyclePolicyPreviewRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end

#repository_nameString

The name of the repository with the policy to retrieve.

Returns:

  • (String)


789
790
791
792
793
794
795
796
797
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 789

class GetLifecyclePolicyPreviewRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end