Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

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:

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 input = { // GetBucketReplicationRequest
Bucket: "STRING_VALUE", // required
ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketReplicationCommand(input);
const response = await client.send(command);
// { // GetBucketReplicationOutput
// ReplicationConfiguration: { // ReplicationConfiguration
// Role: "STRING_VALUE", // required
// Rules: [ // ReplicationRules // required
// { // ReplicationRule
// ID: "STRING_VALUE",
// Priority: Number("int"),
// Prefix: "STRING_VALUE",
// Filter: { // ReplicationRuleFilter Union: only one key present
// Prefix: "STRING_VALUE",
// Tag: { // Tag
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// And: { // ReplicationRuleAndOperator
// Prefix: "STRING_VALUE",
// Tags: [ // TagSet
// {
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// ],
// },
// },
// Status: "Enabled" || "Disabled", // required
// SourceSelectionCriteria: { // SourceSelectionCriteria
// SseKmsEncryptedObjects: { // SseKmsEncryptedObjects
// Status: "Enabled" || "Disabled", // required
// },
// ReplicaModifications: { // ReplicaModifications
// Status: "Enabled" || "Disabled", // required
// },
// },
// ExistingObjectReplication: { // ExistingObjectReplication
// Status: "Enabled" || "Disabled", // required
// },
// Destination: { // Destination
// Bucket: "STRING_VALUE", // required
// Account: "STRING_VALUE",
// StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
// AccessControlTranslation: { // AccessControlTranslation
// Owner: "Destination", // required
// },
// EncryptionConfiguration: { // EncryptionConfiguration
// ReplicaKmsKeyID: "STRING_VALUE",
// },
// ReplicationTime: { // ReplicationTime
// Status: "Enabled" || "Disabled", // required
// Time: { // ReplicationTimeValue
// Minutes: Number("int"),
// },
// },
// Metrics: { // Metrics
// Status: "Enabled" || "Disabled", // required
// EventThreshold: {
// Minutes: Number("int"),
// },
// },
// },
// DeleteMarkerReplication: { // DeleteMarkerReplication
// Status: "Enabled" || "Disabled",
// },
// },
// ],
// },
// };

Param

GetBucketReplicationCommandInput

Returns

GetBucketReplicationCommandOutput

See

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

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

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods