- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
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
ListImagesCommand Input
Parameter | Type | Description |
---|
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 |
maxResults | number | undefined | The maximum number of image results returned by |
nextToken | string | undefined | The 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
Parameter | Type | Description |
---|
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 |
Throws
Name | Fault | Details |
---|
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. |