PutTableBucketReplication
Creates or updates the replication configuration for a table bucket. This operation defines how tables in the source bucket are replicated to destination buckets. Replication helps ensure data availability and disaster recovery across regions or accounts.
- Permissions
-
-
You must have the
s3tables:PutTableBucketReplicationpermission to use this operation. The IAM role specified in the configuration must have permissions to read from the source bucket and write permissions to all destination buckets. -
You must also have the following permissions:
-
s3tables:GetTablepermission on the source table. -
s3tables:ListTablespermission on the bucket containing the table. -
s3tables:CreateTablepermission for the destination. -
s3tables:CreateNamespacepermission for the destination. -
s3tables:GetTableMaintenanceConfigpermission for the source bucket. -
s3tables:PutTableMaintenanceConfigpermission for the destination bucket.
-
-
You must have
iam:PassRolepermission with condition allowing roles to be passed toreplication.s3tables.amazonaws.com.
-
Request Syntax
PUT /table-bucket-replication?tableBucketARN=tableBucketARN&versionToken=versionToken HTTP/1.1
Content-type: application/json
{
"configuration": {
"role": "string",
"rules": [
{
"destinations": [
{
"destinationTableBucketARN": "string"
}
]
}
]
}
}
URI Request Parameters
The request uses the following URI parameters.
- tableBucketARN
-
The Amazon Resource Name (ARN) of the source table bucket.
Pattern:
(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})Required: Yes
- versionToken
-
A version token from a previous GetTableBucketReplication call. Use this token to ensure you're updating the expected version of the configuration.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Request Body
The request accepts the following data in JSON format.
- configuration
-
The replication configuration to apply, including the IAM role and replication rules.
Type: TableBucketReplicationConfiguration object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"status": "string",
"versionToken": "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.
- status
-
The status of the replication configuration operation.
Type: String
- versionToken
-
A new version token representing the updated replication configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Errors
- AccessDeniedException
-
The action cannot be performed because you do not have the required permission.
HTTP Status Code: 403
- BadRequestException
-
The request is invalid or malformed.
HTTP Status Code: 400
- ConflictException
-
The request failed because there is a conflict with a previous write. You can retry the request.
HTTP Status Code: 409
- ForbiddenException
-
The caller isn't authorized to make the request.
HTTP Status Code: 403
- InternalServerErrorException
-
The request failed due to an internal server error.
HTTP Status Code: 500
- NotFoundException
-
The request was rejected because the specified resource could not be found.
HTTP Status Code: 404
- TooManyRequestsException
-
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: