DescribeDatabase
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.
Request Syntax
{
"DatabaseName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DatabaseName
-
The name of the Timestream database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
Response Syntax
{
"Database": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform this action.
HTTP Status Code: 400
- InternalServerException
-
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
- InvalidEndpointException
-
The requested endpoint was not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
- ThrottlingException
-
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
- ValidationException
-
An invalid or malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
