S3Tables / Client / get_table_bucket_replication

get_table_bucket_replication¶

S3Tables.Client.get_table_bucket_replication(**kwargs)¶

Retrieves the replication configuration for a table bucket.This operation returns the IAM role, versionToken, and replication rules that define how tables in this bucket are replicated to other buckets.

Permissions

You must have the s3tables:GetTableBucketReplication permission to use this operation.

Request Syntax

response = client.get_table_bucket_replication(
    tableBucketARN='string'
)

Parameters:

tableBucketARN (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the table bucket.

Return type:

dict

Returns:

Response Syntax

{
    'versionToken': 'string',
    'configuration': {
        'role': 'string',
        'rules': [
            {
                'destinations': [
                    {
                        'destinationTableBucketARN': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

(dict) –
- versionToken (string) –
  
  A version token that represents the current state of the replication configuration. Use this token when updating the configuration to ensure consistency.
- configuration (dict) –
  
  The replication configuration for the table bucket, including the IAM role and replication rules.
  - role (string) –
    
    The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate tables on your behalf.
  - rules (list) –
    
    An array of replication rules that define which tables to replicate and where to replicate them.
    - (dict) –
      
      Defines a rule for replicating tables from a source table bucket to one or more destination table buckets.
      - destinations (list) –
        
        An array of destination table buckets where tables should be replicated.
        
        (dict) –
        
        Specifies a destination table bucket for replication.
        
        destinationTableBucketARN (string) –
        
        The Amazon Resource Name (ARN) of the destination table bucket where tables will be replicated.

Exceptions

S3Tables.Client.exceptions.InternalServerErrorException
S3Tables.Client.exceptions.ForbiddenException
S3Tables.Client.exceptions.NotFoundException
S3Tables.Client.exceptions.AccessDeniedException
S3Tables.Client.exceptions.TooManyRequestsException
S3Tables.Client.exceptions.ConflictException
S3Tables.Client.exceptions.BadRequestException