Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class DescribeImageReplicationStatusCommandProtected

Returns the replication status for a specified image.

Example

Use a bare-bones client and the command you need to make an API call.

import { ECRClient, DescribeImageReplicationStatusCommand } from "@aws-sdk/client-ecr"; // ES Modules import
// const { ECRClient, DescribeImageReplicationStatusCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
const client = new ECRClient(config);
const input = { // DescribeImageReplicationStatusRequest
repositoryName: "STRING_VALUE", // required
imageId: { // ImageIdentifier
imageDigest: "STRING_VALUE",
imageTag: "STRING_VALUE",
},
registryId: "STRING_VALUE",
};
const command = new DescribeImageReplicationStatusCommand(input);
const response = await client.send(command);
// { // DescribeImageReplicationStatusResponse
// repositoryName: "STRING_VALUE",
// imageId: { // ImageIdentifier
// imageDigest: "STRING_VALUE",
// imageTag: "STRING_VALUE",
// },
// replicationStatuses: [ // ImageReplicationStatusList
// { // ImageReplicationStatus
// region: "STRING_VALUE",
// registryId: "STRING_VALUE",
// status: "IN_PROGRESS" || "COMPLETE" || "FAILED",
// failureCode: "STRING_VALUE",
// },
// ],
// };

Param

DescribeImageReplicationStatusCommandInput

Returns

DescribeImageReplicationStatusCommandOutput

See

Throws

ImageNotFoundException (client fault)

The image requested does not exist in the specified repository.

Throws

InvalidParameterException (client fault)

The specified parameter is invalid. Review the available parameters for the API request.

Throws

RepositoryNotFoundException (client fault)

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.

Throws

ServerException (server fault)

These errors are usually caused by a server-side issue.

Throws

ValidationException (client fault)

There was an exception validating this request.

Throws

ECRServiceException

Base exception class for all service exceptions from ECR service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods