BatchCheckLayerAvailability
Checks the availability of one or more image layers that are within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
Note
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
Request Syntax
{
"layerDigests": [ "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.
- layerDigests
-
The digests of the image layers to check.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: Yes
- registryId
-
The AWS account ID, or registry alias, associated with the public registry that contains the image layers to check. If you do not specify a registry, the default public registry is assumed.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 50.
Required: No
- repositoryName
-
The name of the repository that's associated with the image layers to check.
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
{
"failures": [
{
"failureCode": "string",
"failureReason": "string",
"layerDigest": "string"
}
],
"layers": [
{
"layerAvailability": "string",
"layerDigest": "string",
"layerSize": number,
"mediaType": "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.
- failures
-
Any failures associated with the call.
Type: Array of LayerFailure objects
- layers
-
A list of image layer objects that correspond to the image layer references in the request.
Type: Array of Layer objects
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
- RegistryNotFoundException
-
The registry doesn't exist.
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 AWS SDKs, see the following: