Skip to content

describe_global_table

describe_global_table(
    global_table_name: TableName,
    *,
    config_overrides: Optional[DynamoDBClientConfig] = None,
) -> DescribeGlobalTableOutput

Returns information about the specified global table.

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

Parameters:

  • global_table_name (TableName) –

    The name of the global table.

Raises:

Source code in docs_src/capo_dynamodb/_services/dynamo_db.py
def describe_global_table(
    self,
    global_table_name: "capo_dynamodb.types.table_name.TableName",
    *,
    config_overrides: Optional[DynamoDBClientConfig] = None,
) -> "capo_dynamodb.types.describe_global_table_output.DescribeGlobalTableOutput":
    """<p>Returns information about the specified global table.</p> <important> <p>This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">Global Tables version 2019.11.21 (Current)</a> when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).</p> <p>To determine which version you're using, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the global table version you are using</a>. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">Upgrading global tables</a>.</p> </important>

    Args:
        global_table_name: <p>The name of the global table.</p>

    Raises:
        capo_dynamodb.errors.global_table_not_found_exception.GlobalTableNotFoundException: <p>The specified global table does not exist.</p>
        capo_dynamodb.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_dynamodb.errors.invalid_endpoint_exception.InvalidEndpointException
        capo_dynamodb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_dynamodb.types.describe_global_table_input.DescribeGlobalTableInput]",
    ) -> OperationResponse[
        "capo_dynamodb.types.describe_global_table_output.DescribeGlobalTableOutput"
    ]:
        import capo_dynamodb._operations.dynamo_db_20120810.describe_global_table

        output, http_response = (
            capo_dynamodb._operations.dynamo_db_20120810.describe_global_table.describe_global_table(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeGlobalTable")
    )
    input_: capo_dynamodb.types.describe_global_table_input.DescribeGlobalTableInput = {
        "global_table_name": global_table_name
    }

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