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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
batch-get-image
[--registry-id <value>]
--repository-name <value>
--image-ids <value>
[--accepted-media-types <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--registry-id
(string)
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.
--repository-name
(string)
The repository that contains the images to describe.
--image-ids
(list)
A list of image ID references that correspond to images to describe. The format of the
imageIds
reference isimageTag=tag
orimageDigest=digest
.(structure)
An object with identifying information for an image in an Amazon ECR repository.
imageDigest -> (string)
The
sha256
digest of the image manifest.imageTag -> (string)
The tag used for the image.
Shorthand Syntax:
imageDigest=string,imageTag=string ...
JSON Syntax:
[
{
"imageDigest": "string",
"imageTag": "string"
}
...
]
--accepted-media-types
(list)
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
(string)
Syntax:
"string" "string" ...
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Example 1: To get an image
The following batch-get-image
example gets an image with the tag v1.13.6
in a repository called
cluster-autoscaler
in the default registry for an account.
aws ecr batch-get-image \
--repository-name cluster-autoscaler \
--image-ids imageTag=v1.13.6
Output:
{
"images": [
{
"registryId": "012345678910",
"repositoryName": "cluster-autoscaler",
"imageId": {
"imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5",
"imageTag": "v1.13.6"
},
"imageManifest": "{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n \"size\": 2777,\n \"digest\": \"sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed\"\n },\n \"layers\": [\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 17743696,\n \"digest\": \"sha256:39fafc05754f195f134ca11ecdb1c9a691ab0848c697fffeb5a85f900caaf6e1\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 2565026,\n \"digest\": \"sha256:8c8a779d3a537b767ae1091fe6e00c2590afd16767aa6096d1b318d75494819f\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28005981,\n \"digest\": \"sha256:c44ba47496991c9982ee493b47fd25c252caabf2b4ae7dd679c9a27b6a3c8fb7\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 775,\n \"digest\": \"sha256:e2c388b44226544363ca007be7b896bcce1baebea04da23cbd165eac30be650f\"\n }\n ]\n}"
}
],
"failures": []
}
Example 2: To get multiple images
The following batch-get-image
example displays details of all images tagged with prod
and team1
in the specified repository.
aws ecr batch-get-image \
--repository-name MyRepository \
--image-ids imageTag=prod imageTag=team1
Output:
{
"images": [
{
"registryId": "123456789012",
"repositoryName": "MyRepository",
"imageId": {
"imageDigest": "sha256:123456789012",
"imageTag": "prod"
},
"imageManifest": "manifestExample1"
},
{
"registryId": "567890121234",
"repositoryName": "MyRepository",
"imageId": {
"imageDigest": "sha256:123456789012",
"imageTag": "team1"
},
"imageManifest": "manifestExample2"
}
],
"failures": []
}
For more information, see Images in the Amazon ECR User Guide.
images -> (list)
A list of image objects corresponding to the image references in the request.
(structure)
An object representing an Amazon ECR image.
registryId -> (string)
The Amazon Web Services account ID associated with the registry containing the image.
repositoryName -> (string)
The name of the repository associated with the image.
imageId -> (structure)
An object containing the image tag and image digest associated with an image.
imageDigest -> (string)
The
sha256
digest of the image manifest.imageTag -> (string)
The tag used for the image.
imageManifest -> (string)
The image manifest associated with the image.
imageManifestMediaType -> (string)
The manifest media type of the image.
failures -> (list)
Any failures associated with the call.
(structure)
An object representing an Amazon ECR image failure.
imageId -> (structure)
The image ID associated with the failure.
imageDigest -> (string)
The
sha256
digest of the image manifest.imageTag -> (string)
The tag used for the image.
failureCode -> (string)
The code associated with the failure.
failureReason -> (string)
The reason for the failure.