DescribeImageTags
Returns the image tag details for a repository in a public registry.
Request Syntax
{
"maxResults": number
,
"nextToken": "string
",
"registryId": "string
",
"repositoryName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- maxResults
-
The maximum number of repository results that's returned by
DescribeImageTags
in paginated output. When this parameter is used,DescribeImageTags
only returnsmaxResults
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherDescribeImageTags
request with the returnednextToken
value. This value can be between 1 and 1000. If this parameter isn't used, thenDescribeImageTags
returns up to 100 results and anextToken
value, if applicable. If you specify images withimageIds
, you can't use this option.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- nextToken
-
The
nextToken
value that's returned from a previous paginatedDescribeImageTags
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. If there are no more results to return, this value isnull
. If you specify images withimageIds
, you can't use this option.Type: String
Required: No
- registryId
-
The Amazon 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.
Type: String
Pattern:
[0-9]{12}
Required: No
- repositoryName
-
The name of the repository that contains the image tag details to describe.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 205.
Pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Required: Yes
Response Syntax
{
"imageTagDetails": [
{
"createdAt": number,
"imageDetail": {
"artifactMediaType": "string",
"imageDigest": "string",
"imageManifestMediaType": "string",
"imagePushedAt": number,
"imageSizeInBytes": number
},
"imageTag": "string"
}
],
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- imageTagDetails
-
The image tag details for the images in the requested repository.
Type: Array of ImageTagDetail objects
- nextToken
-
The
nextToken
value to include in a futureDescribeImageTags
request. When the results of aDescribeImageTags
request exceedmaxResults
, you can use this value to retrieve the next page of results. If there are no more results to return, this value isnull
.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
The specified parameter is invalid. Review the available parameters for the API request.
HTTP Status Code: 400
- RepositoryNotFoundException
-
The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
- UnsupportedCommandException
-
The action isn't supported in this Region.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: