/

POST

Returns metadata that's related to the images in a repository in a public registry.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "registryId": "string",
    "repositoryName": "string",
    "imageIds": [],
    "nextToken": "string",
    "maxResults": 0
}'

Response Example

200 - Example 1

{
    "imageDetails": [],
    "nextToken": "string"
}

Request

Query Params

maxResults

string

optional

Pagination limit

nextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

registryId

string

optional

The Amazon Web Services account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.

Match pattern:

[0-9]{12}

repositoryName

string

required

The repository that contains the images to describe.

>= 2 characters<= 205 characters

Match pattern:

(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*

imageIds

array[object (ImageIdentifier) {2}]

optional

The list of image IDs for the requested repository.

>= 1 items<= 100 items

imageDigest

string

optional

The sha256 digest of the image manifest.

imageTag

string

optional

The tag that's used for the image.

>= 1 characters<= 300 characters

nextToken

string

optional

The nextToken value that's returned from a previous paginated DescribeImages 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. If there are no more results to return, this value is null. If you specify images with imageIds, you can't use this option.

maxResults

integer

optional

The maximum number of repository results that's returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. If you specify images with imageIds, you can't use this option.

>= 1<= 1000

Examples

Responses

🟢200Success

application/json

Body

imageDetails

array[object (ImageDetail) {8}]

optional

A list of ImageDetail objects that contain data about the image.

registryId

string

optional

The Amazon Web Services account ID that's associated with the public registry where this image belongs.

Match pattern:

[0-9]{12}

repositoryName

string

optional

The name of the repository where this image belongs.

>= 2 characters<= 205 characters

Match pattern:

(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*

imageDigest

string

optional

The sha256 digest of the image manifest.

imageTags

array[string]

optional

The list of tags that's associated with this image.

imageSizeInBytes

integer

optional

The size, in bytes, of the image in the repository.

If the image is a manifest list, this is the max size of all manifests in the list.

imagePushedAt

string <date-time>

optional

The date and time, expressed in standard JavaScript date format, that the current image was pushed to the repository at.

imageManifestMediaType

string

optional

The media type of the image manifest.

artifactMediaType

string

optional

The artifact media type of the image.

nextToken

string

optional

The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, you can use this value to retrieve the next page of results. If there are no more results to return, this value is null.

🟠480ServerException

🟠481InvalidParameterException

🟠482RepositoryNotFoundException

🟠483ImageNotFoundException

🟠484UnsupportedCommandException

Modified at 2023-08-15 05:55:25