Keyspaces.Client.get_table(**kwargs)¶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 , Select action permissions for the table and system tables are required to complete the operation.
See also: AWS API Documentation
Request Syntax
response = client.get_table(
keyspaceName='string',
tableName='string'
)
[REQUIRED]
The name of the keyspace that the table is stored in.
[REQUIRED]
The name of the table.
dict
Response Syntax
{
'keyspaceName': 'string',
'tableName': 'string',
'resourceArn': 'string',
'creationTimestamp': datetime(2015, 1, 1),
'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'DELETED'|'RESTORING'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS',
'schemaDefinition': {
'allColumns': [
{
'name': 'string',
'type': 'string'
},
],
'partitionKeys': [
{
'name': 'string'
},
],
'clusteringKeys': [
{
'name': 'string',
'orderBy': 'ASC'|'DESC'
},
],
'staticColumns': [
{
'name': 'string'
},
]
},
'capacitySpecification': {
'throughputMode': 'PAY_PER_REQUEST'|'PROVISIONED',
'readCapacityUnits': 123,
'writeCapacityUnits': 123,
'lastUpdateToPayPerRequestTimestamp': datetime(2015, 1, 1)
},
'encryptionSpecification': {
'type': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
'kmsKeyIdentifier': 'string'
},
'pointInTimeRecovery': {
'status': 'ENABLED'|'DISABLED',
'earliestRestorableTimestamp': datetime(2015, 1, 1)
},
'ttl': {
'status': 'ENABLED'
},
'defaultTimeToLive': 123,
'comment': {
'message': 'string'
},
'clientSideTimestamps': {
'status': 'ENABLED'
}
}
Response Structure
(dict) --
keyspaceName (string) --
The name of the keyspace that the specified table is stored in.
tableName (string) --
The name of the specified table.
resourceArn (string) --
The Amazon Resource Name (ARN) of the specified table.
creationTimestamp (datetime) --
The creation timestamp of the specified table.
status (string) --
The current status of the specified table.
schemaDefinition (dict) --
The schema definition of the specified table.
allColumns (list) --
The regular columns of the table.
(dict) --
The names and data types of regular columns.
name (string) --
The name of the column.
type (string) --
The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer Guide .
partitionKeys (list) --
The columns that are part of the partition key of the table .
(dict) --
The partition key portion of the primary key is required and determines how Amazon Keyspaces stores the data. The partition key can be a single column, or it can be a compound value composed of two or more columns.
name (string) --
The name(s) of the partition key column(s).
clusteringKeys (list) --
The columns that are part of the clustering key of the table.
(dict) --
The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.
name (string) --
The name(s) of the clustering column(s).
orderBy (string) --
Sets the ascendant ( ASC ) or descendant ( DESC ) order modifier.
staticColumns (list) --
The columns that have been defined as STATIC . Static columns store values that are shared by all rows in the same partition.
(dict) --
The static columns of the table. Static columns store values that are shared by all rows in the same partition.
name (string) --
The name of the static column.
capacitySpecification (dict) --
The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUESTthroughputMode:PROVISIONEDthroughputMode (string) --
The read/write throughput capacity mode for a table. The options are:
throughputMode:PAY_PER_REQUEST andthroughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.The default is throughput_mode:PAY_PER_REQUEST .
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide .
readCapacityUnits (integer) --
The throughput capacity specified for read operations defined in read capacity units (RCUs) .
writeCapacityUnits (integer) --
The throughput capacity specified for write operations defined in write capacity units (WCUs) .
lastUpdateToPayPerRequestTimestamp (datetime) --
The timestamp of the last operation that changed the provisioned throughput capacity of a table.
encryptionSpecification (dict) --
The encryption settings of the specified table.
type (string) --
The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):
type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.The default is type:AWS_OWNED_KMS_KEY .
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide .
kmsKeyIdentifier (string) --
The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN .
pointInTimeRecovery (dict) --
The point-in-time recovery status of the specified table.
status (string) --
Shows if point-in-time recovery is enabled or disabled for the specified table.
earliestRestorableTimestamp (datetime) --
Specifies the earliest possible restore point of the table in ISO 8601 format.
ttl (dict) --
The custom Time to Live settings of the specified table.
status (string) --
Shows how to enable custom Time to Live (TTL) settings for the specified table.
defaultTimeToLive (integer) --
The default Time to Live settings in seconds of the specified table.
comment (dict) --
The the description of the specified table.
message (string) --
An optional description of the table.
clientSideTimestamps (dict) --
The client-side timestamps setting of the table.
status (string) --
Shows how to enable client-side timestamps settings for the specified table.
Exceptions
Keyspaces.Client.exceptions.ValidationExceptionKeyspaces.Client.exceptions.ServiceQuotaExceededExceptionKeyspaces.Client.exceptions.InternalServerExceptionKeyspaces.Client.exceptions.AccessDeniedExceptionKeyspaces.Client.exceptions.ResourceNotFoundException