S3Tables / Client / get_table_replication_status

get_table_replication_status¶

S3Tables.Client.get_table_replication_status(**kwargs)¶

Retrieves the replication status for a table, including the status of replication to each destination. This operation provides visibility into replication health and progress.

Permissions

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

Request Syntax

response = client.get_table_replication_status(
    tableArn='string'
)

Parameters:

tableArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the table.

Return type:

dict

Returns:

Response Syntax

{
    'sourceTableArn': 'string',
    'destinations': [
        {
            'replicationStatus': 'pending'|'completed'|'failed',
            'destinationTableBucketArn': 'string',
            'destinationTableArn': 'string',
            'lastSuccessfulReplicatedUpdate': {
                'metadataLocation': 'string',
                'timestamp': datetime(2015, 1, 1)
            },
            'failureMessage': 'string'
        },
    ]
}

Response Structure

(dict) –
- sourceTableArn (string) –
  
  The Amazon Resource Name (ARN) of the source table being replicated.
- destinations (list) –
  
  An array of status information for each replication destination, including the current state, last successful update, and any error messages.
  - (dict) –
    
    Contains status information for a replication destination, including the current replication state, last successful update, and any error messages.
    - replicationStatus (string) –
      
      The current status of replication to this destination.
    - destinationTableBucketArn (string) –
      
      The Amazon Resource Name (ARN) of the destination table bucket.
    - destinationTableArn (string) –
      
      The Amazon Resource Name (ARN) of the destination table.
    - lastSuccessfulReplicatedUpdate (dict) –
      
      Information about the most recent successful replication update to this destination.
      - metadataLocation (string) –
        
        The S3 location of the metadata that was successfully replicated.
      - timestamp (datetime) –
        
        The timestamp when the replication update completed successfully.
    - failureMessage (string) –
      
      If replication has failed, this field contains an error message describing the failure reason.

Exceptions

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