Skip to content

describe_table 

describe_table(
    database_name: ResourceName,
    table_name: ResourceName,
    *,
    config_overrides: Optional[TimestreamWriteClientConfig] = None,
) -> DescribeTableResponse

Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. See code sample for details.

Parameters:

  • database_name (ResourceName) –

    The name of the Timestream database.

  • table_name (ResourceName) –

    The name of the Timestream table.

Raises:

Source code in docs_src/capo_timestream_write/_services/timestream_write.py 
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
def describe_table(
    self,
    database_name: "capo_timestream_write.types.resource_name.ResourceName",
    table_name: "capo_timestream_write.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[TimestreamWriteClientConfig] = None,
) -> "capo_timestream_write.types.describe_table_response.DescribeTableResponse":
    """<p>Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html">code sample</a> for details. </p>

    Args:
        database_name: <p>The name of the Timestream database.</p>
        table_name: <p>The name of the Timestream table.</p>

    Raises:
        capo_timestream_write.errors.access_denied_exception.AccessDeniedException: <p>You are not authorized to perform this action.</p>
        capo_timestream_write.errors.internal_server_exception.InternalServerException: <p> Timestream was unable to fully process this request because of an internal server error.</p>
        capo_timestream_write.errors.invalid_endpoint_exception.InvalidEndpointException: <p>The requested endpoint was not valid.</p>
        capo_timestream_write.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.</p>
        capo_timestream_write.errors.throttling_exception.ThrottlingException: <p> Too many requests were made by a user and they exceeded the service quotas. The request was throttled.</p>
        capo_timestream_write.errors.validation_exception.ValidationException: <p> An invalid or malformed request.</p>
        capo_timestream_write.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_timestream_write.types.describe_table_request.DescribeTableRequest]",
    ) -> OperationResponse[
        "capo_timestream_write.types.describe_table_response.DescribeTableResponse"
    ]:
        import capo_timestream_write._operations.timestream_20181101.describe_table

        output, http_response = (
            capo_timestream_write._operations.timestream_20181101.describe_table.describe_table(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTable")
    )
    input_: capo_timestream_write.types.describe_table_request.DescribeTableRequest = {
        "database_name": database_name,
        "table_name": table_name,
    }

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