GetTable
Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
To read table metadata using GetTable, the
IAM principal needs Select action
permissions for the table and the system keyspace.
Request Syntax
{
"keyspaceName": "string",
"tableName": "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.
- keyspaceName
-
The name of the keyspace that the table is stored in.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_]{0,47}Required: Yes
- tableName
-
The name of the table.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_]{0,47}Required: Yes
Response Syntax
{
"capacitySpecification": {
"lastUpdateToPayPerRequestTimestamp": number,
"readCapacityUnits": number,
"throughputMode": "string",
"writeCapacityUnits": number
},
"cdcSpecification": {
"status": "string",
"viewType": "string"
},
"clientSideTimestamps": {
"status": "string"
},
"comment": {
"message": "string"
},
"creationTimestamp": number,
"defaultTimeToLive": number,
"encryptionSpecification": {
"kmsKeyIdentifier": "string",
"type": "string"
},
"keyspaceName": "string",
"latestStreamArn": "string",
"pointInTimeRecovery": {
"earliestRestorableTimestamp": number,
"status": "string"
},
"replicaSpecifications": [
{
"capacitySpecification": {
"lastUpdateToPayPerRequestTimestamp": number,
"readCapacityUnits": number,
"throughputMode": "string",
"writeCapacityUnits": number
},
"region": "string",
"status": "string"
}
],
"resourceArn": "string",
"schemaDefinition": {
"allColumns": [
{
"name": "string",
"type": "string"
}
],
"clusteringKeys": [
{
"name": "string",
"orderBy": "string"
}
],
"partitionKeys": [
{
"name": "string"
}
],
"staticColumns": [
{
"name": "string"
}
]
},
"status": "string",
"tableName": "string",
"ttl": {
"status": "string"
}
}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.
- capacitySpecification
-
The read/write throughput capacity mode for a table. The options are:
-
throughputMode:PAY_PER_REQUEST -
throughputMode:PROVISIONED
Type: CapacitySpecificationSummary object
-
- cdcSpecification
-
The CDC stream settings of the table.
Type: CdcSpecificationSummary object
- clientSideTimestamps
-
The client-side timestamps setting of the table.
Type: ClientSideTimestamps object
- comment
-
The the description of the specified table.
Type: Comment object
- creationTimestamp
-
The creation timestamp of the specified table.
Type: Timestamp
- defaultTimeToLive
-
The default Time to Live settings in seconds of the specified table.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 630720000.
- encryptionSpecification
-
The encryption settings of the specified table.
Type: EncryptionSpecification object
- keyspaceName
-
The name of the keyspace that the specified table is stored in.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_]{0,47} - latestStreamArn
-
The Amazon Resource Name (ARN) of the stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
arn:(aws[a-zA-Z0-9-]*):cassandra:.+.* - pointInTimeRecovery
-
The point-in-time recovery status of the specified table.
Type: PointInTimeRecoverySummary object
- replicaSpecifications
-
Returns the Amazon Region specific settings of all Regions a multi-Region table is replicated in.
Type: Array of ReplicaSpecificationSummary objects
Array Members: Minimum number of 0 items.
- resourceArn
-
The Amazon Resource Name (ARN) of the specified table.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1000.
Pattern:
arn:(aws[a-zA-Z0-9-]*):cassandra:.+.* - schemaDefinition
-
The schema definition of the specified table.
Type: SchemaDefinition object
- status
-
The current status of the specified table.
Type: String
Valid Values:
ACTIVE | CREATING | UPDATING | DELETING | DELETED | RESTORING | INACCESSIBLE_ENCRYPTION_CREDENTIALS - tableName
-
The name of the specified table.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_]{0,47} - ttl
-
The custom Time to Live settings of the specified table.
Type: TimeToLive object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access permissions to perform this action.
HTTP Status Code: 400
- InternalServerException
-
Amazon Keyspaces was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE.HTTP Status Code: 400
- ServiceQuotaExceededException
-
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
HTTP Status Code: 400
- ValidationException
-
The operation failed due to an invalid or malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: