Keyspaces / Client / get_keyspace
get_keyspace#
- Keyspaces.Client.get_keyspace(**kwargs)#
Returns the name and the Amazon Resource Name (ARN) of the specified table.
See also: AWS API Documentation
Request Syntax
response = client.get_keyspace( keyspaceName='string' )
- Parameters:
keyspaceName (string) –
[REQUIRED]
The name of the keyspace.
- Return type:
dict
- Returns:
Response Syntax
{ 'keyspaceName': 'string', 'resourceArn': 'string', 'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION', 'replicationRegions': [ 'string', ] }
Response Structure
(dict) –
keyspaceName (string) –
The name of the keyspace.
resourceArn (string) –
Returns the ARN of the keyspace.
replicationStrategy (string) –
Returns the replication strategy of the keyspace. The options are
SINGLE_REGION
orMULTI_REGION
.replicationRegions (list) –
If the
replicationStrategy
of the keyspace isMULTI_REGION
, a list of replication Regions is returned.(string) –
Exceptions
Keyspaces.Client.exceptions.ValidationException
Keyspaces.Client.exceptions.ServiceQuotaExceededException
Keyspaces.Client.exceptions.InternalServerException
Keyspaces.Client.exceptions.AccessDeniedException
Keyspaces.Client.exceptions.ResourceNotFoundException