ListImagesCommand

Lists all the image IDs for the specified repository.

You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ECRClient, ListImagesCommand } from "@aws-sdk/client-ecr"; // ES Modules import
// const { ECRClient, ListImagesCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
const client = new ECRClient(config);
const input = { // ListImagesRequest
  registryId: "STRING_VALUE",
  repositoryName: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  filter: { // ListImagesFilter
    tagStatus: "TAGGED" || "UNTAGGED" || "ANY",
  },
};
const command = new ListImagesCommand(input);
const response = await client.send(command);
// { // ListImagesResponse
//   imageIds: [ // ImageIdentifierList
//     { // ImageIdentifier
//       imageDigest: "STRING_VALUE",
//       imageTag: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Example Usage

// This example lists all of the images in the repository named ubuntu in the default registry in the current
    account.
const input = {
repositoryName: "ubuntu"
};
const command = new ListImagesCommand(input);
const response = await client.send(command);
/* response is
{
imageIds: [
{
imageDigest: "sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a",
imageTag: "precise"
}
]
}
*\/
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
JavaScriptLn 1, Col 1
Errors: 0 Warnings: 0

ListImagesCommand Input

See ListImagesCommandInput for more details

Parameter
Type
Description
repositoryName
Required
string | undefined

The repository with image IDs to be listed.

filter
ListImagesFilter | undefined

The filter key and value with which to filter your ListImages results.

maxResults
number | undefined

The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages 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 ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

nextToken
string | undefined

The nextToken value returned from a previous paginated ListImages 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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

registryId
string | undefined

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

ListImagesCommand Output

See ListImagesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
imageIds
ImageIdentifier[] | undefined

The list of image IDs for the requested repository.

nextToken
string | undefined

The nextToken value to include in a future ListImages request. When the results of a ListImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Throws

Name
Fault
Details
InvalidParameterException
client

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException
client

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ServerException
server

These errors are usually caused by a server-side issue.

ECRServiceException
Base exception class for all service exceptions from ECR service.