Batch Delete Image

ecr_batch_delete_image

R Documentation

Deletes a list of specified images within a repository¶

Description¶

Deletes a list of specified images within a repository. Images are specified with either an imageTag or imageDigest.

You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.

You can completely delete an image (and all of its tags) by specifying the image's digest in your request.

Usage¶

ecr_batch_delete_image(registryId, repositoryName, imageIds)

Arguments¶

registryId: The Amazon Web Services account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.
repositoryName: [required] The repository that contains the image to delete.
imageIds: [required] A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

Value¶

A list with the following syntax:

list(
  imageIds = list(
    list(
      imageDigest = "string",
      imageTag = "string"
    )
  ),
  failures = list(
    list(
      imageId = list(
        imageDigest = "string",
        imageTag = "string"
      ),
      failureCode = "InvalidImageDigest"|"InvalidImageTag"|"ImageTagDoesNotMatchDigest"|"ImageNotFound"|"MissingDigestAndTag"|"ImageReferencedByManifestList"|"KmsError"|"UpstreamAccessDenied"|"UpstreamTooManyRequests"|"UpstreamUnavailable",
      failureReason = "string"
    )
  )
)

Request syntax¶

svc$batch_delete_image(
  registryId = "string",
  repositoryName = "string",
  imageIds = list(
    list(
      imageDigest = "string",
      imageTag = "string"
    )
  )
)

Examples¶

## Not run: 
# This example deletes images with the tags precise and trusty in a
# repository called ubuntu in the default registry for an account.
svc$batch_delete_image(
  imageIds = list(
    list(
      imageTag = "precise"
    )
  ),
  repositoryName = "ubuntu"
)

## End(Not run)