DescribeImageReplicationStatus
Returns the replication status for a specified image.
Request Syntax
{
"imageId": {
"imageDigest": "string",
"imageTag": "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.
- imageId
-
An object with identifying information for an image in an Amazon ECR repository.
Type: ImageIdentifier object
Required: Yes
- registryId
-
The AWS account ID associated with the registry. 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 the image is in.
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
{
"imageId": {
"imageDigest": "string",
"imageTag": "string"
},
"replicationStatuses": [
{
"failureCode": "string",
"region": "string",
"registryId": "string",
"status": "string"
}
],
"repositoryName": "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.
- imageId
-
An object with identifying information for an image in an Amazon ECR repository.
Type: ImageIdentifier object
- replicationStatuses
-
The replication status details for the images in the specified repository.
Type: Array of ImageReplicationStatus objects
- repositoryName
-
The repository name associated with the request.
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]+)*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ImageNotFoundException
-
The image requested does not exist in the specified repository.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter is invalid. Review the available parameters for the API request.
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
- ValidationException
-
There was an exception validating this request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
