GetDownloadUrlForLayer
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
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
{
"layerDigest": "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.
- layerDigest
-
The digest of the image layer to download.
Type: String
Pattern:
[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+Required: Yes
- registryId
-
The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.
Type: String
Pattern:
[0-9]{12}Required: No
- repositoryName
-
The name of the repository that is associated with the image layer to download.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 256.
Pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*Required: Yes
Response Syntax
{
"downloadUrl": "string",
"layerDigest": "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.
- downloadUrl
-
The pre-signed Amazon S3 download URL for the requested layer.
Type: String
- layerDigest
-
The digest of the image layer to download.
Type: String
Pattern:
[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+
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
- LayerInaccessibleException
-
The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.
HTTP Status Code: 400
- LayersNotFoundException
-
The specified layers could not be found, or the specified layer is not valid for this repository.
HTTP Status Code: 400
- RepositoryNotFoundException
-
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.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
- UnableToGetUpstreamLayerException
-
There was an issue getting the upstream layer matching the pull through cache rule.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
