Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StopReplicationBackfill

Stops an in progress replication backfill for a registry. The backfill to stop is identified by the replicationBackfillId returned by the StartReplicationBackfill operation.

Note

Images that have already been replicated are not affected, and replications that are already in progress continue to completion.

Request Syntax


{
   "registryId": "string",
   "replicationBackfillId": "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.

registryId

The AWS account ID associated with the registry that contains the replication backfill to stop. If you do not specify a registry, the default registry is assumed.

Type: String

Pattern: [0-9]{12}

Required: No

replicationBackfillId

The ID of the replication backfill to stop.

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

Response Syntax


{
   "destination": { 
      "region": "string",
      "registryId": "string"
   },
   "registryId": "string",
   "replicationBackfillId": "string",
   "startedAt": number,
   "status": "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.

destination

The destination Region and registry to which the images are replicated.

Type: ReplicationDestination object

registryId

The registry ID associated with the request.

Type: String

Pattern: [0-9]{12}

replicationBackfillId

The ID of the replication backfill.

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

startedAt

The date and time, in JavaScript date format, when the replication backfill was started.

Type: Timestamp

status

The current status of the replication backfill. When you stop a replication backfill, its status is STOPPED if the backfill is stopped immediately, or STOPPING if there are replications still in progress that must complete before the backfill stops.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidParameterException

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

message: The error message associated with the exception.

HTTP Status Code: 400

ReplicationBackfillInvalidStatusException

The requested operation can't be performed on the replication backfill because it is not in a valid status for that operation. For example, you can't stop a replication backfill that has already reached a terminal status. Use the DescribeReplicationBackfillResults operation to check the current status before retrying.

message: The error message associated with the exception.

HTTP Status Code: 400

ReplicationBackfillNotFoundException

The specified replication backfill could not be found. Check the specified replication backfill ID and ensure that you are operating on the correct registry.

message: The error message associated with the exception.

HTTP Status Code: 400

ServerException

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

message: The error message associated with the exception.

HTTP Status Code: 500

ValidationException

There was an exception validating this request.

HTTP Status Code: 400