Gets detailed information for an image¶

Description¶

Gets detailed information for an image. Images are specified with either an imageTag or imageDigest.

When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.

Usage¶

ecr_batch_get_image(registryId, repositoryName, imageIds,
  acceptedMediaTypes)

Arguments¶

registryId

The Amazon Web Services account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.
repositoryName

[required] The repository that contains the images to describe.
imageIds

[required] A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
acceptedMediaTypes

The accepted media types for the request.

Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

Value¶

A list with the following syntax:

list(
  images = list(
    list(
      registryId = "string",
      repositoryName = "string",
      imageId = list(
        imageDigest = "string",
        imageTag = "string"
      ),
      imageManifest = "string",
      imageManifestMediaType = "string"
    )
  ),
  failures = list(
    list(
      imageId = list(
        imageDigest = "string",
        imageTag = "string"
      ),
      failureCode = "InvalidImageDigest"|"InvalidImageTag"|"ImageTagDoesNotMatchDigest"|"ImageNotFound"|"MissingDigestAndTag"|"ImageReferencedByManifestList"|"KmsError"|"UpstreamAccessDenied"|"UpstreamTooManyRequests"|"UpstreamUnavailable"|"ImageInaccessible",
      failureReason = "string"
    )
  )
)

Request syntax¶

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

Examples¶

# This example obtains information for an image with a specified image
# digest ID from the repository named ubuntu in the current account.
svc$batch_get_image(
  imageIds = list(
    list(
      imageTag = "precise"
    )
  ),
  repositoryName = "ubuntu"
)