Class GetBucketReplicationCommandProtected

Returns the replication configuration of a bucket.

It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

For information about replication configuration, see Replication in the Amazon S3 User Guide.

This action requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies.

If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements.

For information about GetBucketReplication errors, see List of replication-related error codes

The following operations are related to GetBucketReplication:

• PutBucketReplication

• DeleteBucketReplication

Example

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

import { S3Client, GetBucketReplicationCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetBucketReplicationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const command = new GetBucketReplicationCommand(input);
const response = await client.send(command);

See

• GetBucketReplicationCommandInput for command's input shape.
• GetBucketReplicationCommandOutput for command's response shape.
• config for S3Client's config shape.

Example

To get replication configuration set on a bucket

// The following example returns replication configuration set on a bucket.
const input = {
  "Bucket": "examplebucket"
};
const command = new GetBucketReplicationCommand(input);
const response = await client.send(command);
/* response ==
{
  "ReplicationConfiguration": {
    "Role": "arn:aws:iam::acct-id:role/example-role",
    "Rules": [
      {
        "Destination": {
          "Bucket": "arn:aws:s3:::destination-bucket"
        },
        "ID": "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy",
        "Prefix": "Tax",
        "Status": "Enabled"
      }
    ]
  }
}
*/
// example id: to-get-replication-configuration-set-on-a-bucket-1481593597175