Get object synchronization status

Content Platform for Cloud Scale S3 Console Guide

Version

2.4.x

Audience

anonymous

Part Number

MK-HCPCS009-04

The synchronization status of an object is returned in metadata as part of the response to a GET object or HEAD object request.

For a GET object or HEAD object request, the synchronization functions return a replication status header in addition to the standard response metadata. This information is useful before deletion from a source bucket to verify synchronization.

When an object is created, HCP for cloud scale evaluates the sync-to rules for the bucket. If the object matches the rules, it sets the object's sync state as either PENDING, COMPLETED, or FAILED. If the object does not match any of the rules, nothing changes.

Most of the time, this sync state is accurate. However, it is never definitive because users might change the sync-to rules for the bucket before the policy engine starts processing the object, which happens asynchronously. The policy engine evaluates the sync-to rules again when processing an object to act according to the latest sync rules.

For example:

An object was ingested that matches the sync-to rules, so its sync state is set as PENDING. Then, a user changes the sync-to rules. The object does not match the rules anymore so the object is actually not synced and that sync state is removed.
An object was ingested that does not match the sync-to rules, so its sync state is not set. Then, a user changes the sync rules. The object now matches the rules so the object is actually synced and the sync state is set to COMPLETED.

Response header	Description
x-amz-replication-status	Status of synchronization: `PENDING`: For sync-to, one of the following: (1) a check is pending to see if the object needs synchronization; (2) the object needs synchronization, but the process is not complete. `COMPLETED`: For sync-to, all rules were successfully executed and the object was successfully synchronized. Note: This status is also returned for objects that match a sync-to rule but were skipped because they are not the most recent version. `FAILED`: For sync-to, the process has failed multiple times. To be synchronized, the object must be reloaded.
(Header not in response)	The object did not match any rules.

Response header

Description

x-amz-replication-status

Status of synchronization:

PENDING: For sync-to, one of the following: (1) a check is pending to see if the object needs synchronization; (2) the object needs synchronization, but the process is not complete.
COMPLETED: For sync-to, all rules were successfully executed and the object was successfully synchronized.
Note: This status is also returned for objects that match a sync-to rule but were skipped because they are not the most recent version.
FAILED: For sync-to, the process has failed multiple times. To be synchronized, the object must be reloaded.

(Header not in response)

The object did not match any rules.