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

Class: Aws::ECR::Types::BatchDeleteImageRequest

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 BatchDeleteImageRequest data as a hash:

{
  registry_id: "RegistryId",
  repository_name: "RepositoryName", # required
  image_ids: [ # required
    {
      image_digest: "ImageDigest",
      image_tag: "ImageTag",
    },
  ],
}

Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.

Instance Attribute Summary collapse

Instance Attribute Details

#image_idsArray<Types::ImageIdentifier>

A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

Returns:



126
127
128
129
130
131
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 126

class BatchDeleteImageRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids)
  include Aws::Structure
end

#registry_idString

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

Returns:

  • (String)


126
127
128
129
130
131
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 126

class BatchDeleteImageRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids)
  include Aws::Structure
end

#repository_nameString

The repository that contains the image to delete.

Returns:

  • (String)


126
127
128
129
130
131
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 126

class BatchDeleteImageRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids)
  include Aws::Structure
end