/AWS1/CL_S3C=>GETBUCKETREPLICATION()¶
About GetBucketReplication¶
This operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an S3 bucket's replication configuration, see GetBucketReplication in the Amazon S3 API Reference.
Returns the replication configuration of an S3 on Outposts bucket. For more information about S3 on Outposts, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
It can take a while to propagate PUT or DELETE requests for
a replication configuration to all S3 on Outposts systems. Therefore, the replication
configuration that's returned by a GET request soon after a
PUT or DELETE request might return a more recent result
than what's on the Outpost. If an Outpost is offline, the delay in updating the
replication configuration on that Outpost can be significant.
This action requires permissions for the
s3-outposts:GetReplicationConfiguration action. The Outposts bucket owner
has this permission by default and can grant it to others. For more information about
permissions, see Setting up IAM with
S3 on Outposts and Managing access to
S3 on Outposts bucket in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
If you include the Filter element in a replication configuration, you must
also include the DeleteMarkerReplication, Status, and
Priority elements. The response also returns those elements.
For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
The following operations are related to GetBucketReplication:
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_ACCOUNTID TYPE /AWS1/S3CACCOUNTID /AWS1/S3CACCOUNTID¶
The Amazon Web Services account ID of the Outposts bucket.
IV_BUCKET TYPE /AWS1/S3CBUCKETNAME /AWS1/S3CBUCKETNAME¶
Specifies the bucket to get the replication information for.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format
arn:aws:s3-outposts:. For example, to access the bucket: :outpost/ /bucket/ reportsthrough Outpostmy-outpostowned by account123456789012in Regionus-west-2, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.