Skip to content

get_table_replication_status

get_table_replication_status(
    table_arn: TableARN, *, config_overrides: Optional[S3TablesClientConfig] = None
) -> GetTableReplicationStatusResponse

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.

Parameters:

  • table_arn (TableARN) –

    The Amazon Resource Name (ARN) of the table.

Raises:

Source code in docs_src/capo_s3tables/_services/s3_tables.py
def get_table_replication_status(
    self,
    table_arn: "capo_s3tables.types.table_arn.TableARN",
    *,
    config_overrides: Optional[S3TablesClientConfig] = None,
) -> "capo_s3tables.types.get_table_replication_status_response.GetTableReplicationStatusResponse":
    """<p>Retrieves the replication status for a table, including the status of replication to each destination. This operation provides visibility into replication health and progress.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTableReplicationStatus</code> permission to use this operation.</p> </dd> </dl>

    Args:
        table_arn: <p>The Amazon Resource Name (ARN) of the table.</p>

    Raises:
        capo_s3tables.errors.bad_request_exception.BadRequestException: <p>The request is invalid or malformed.</p>
        capo_s3tables.errors.conflict_exception.ConflictException: <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
        capo_s3tables.errors.forbidden_exception.ForbiddenException: <p>The caller isn't authorized to make the request.</p>
        capo_s3tables.errors.internal_server_error_exception.InternalServerErrorException: <p>The request failed due to an internal server error.</p>
        capo_s3tables.errors.not_found_exception.NotFoundException: <p>The request was rejected because the specified resource could not be found.</p>
        capo_s3tables.errors.too_many_requests_exception.TooManyRequestsException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_s3tables.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_s3tables.types.get_table_replication_status_request.GetTableReplicationStatusRequest]",
    ) -> OperationResponse[
        "capo_s3tables.types.get_table_replication_status_response.GetTableReplicationStatusResponse"
    ]:
        import capo_s3tables._operations.s3_table_buckets.get_table_replication_status

        output, http_response = (
            capo_s3tables._operations.s3_table_buckets.get_table_replication_status.get_table_replication_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTableReplicationStatus")
    )
    input_: capo_s3tables.types.get_table_replication_status_request.GetTableReplicationStatusRequest = {
        "table_arn": table_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output