Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. See code sample for details.
Parameters:
-
database_name
(ResourceName)
–
The name of the Timestream database.
Raises:
Source code in docs_src/capo_timestream_write/_services/timestream_write.py
| def describe_database(
self,
database_name: "capo_timestream_write.types.resource_name.ResourceName",
*,
config_overrides: Optional[TimestreamWriteClientConfig] = None,
) -> "capo_timestream_write.types.describe_database_response.DescribeDatabaseResponse":
"""<p>Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. <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-db.html">code sample</a> for details.</p>
Args:
database_name: <p>The name of the Timestream database.</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_database_request.DescribeDatabaseRequest]",
) -> OperationResponse[
"capo_timestream_write.types.describe_database_response.DescribeDatabaseResponse"
]:
import capo_timestream_write._operations.timestream_20181101.describe_database
output, http_response = (
capo_timestream_write._operations.timestream_20181101.describe_database.describe_database(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDatabase")
)
input_: capo_timestream_write.types.describe_database_request.DescribeDatabaseRequest = {
"database_name": database_name
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|