GetKeyspace
Returns the name and the Amazon Resource Name (ARN) of the specified table.
Request Syntax
{
"keyspaceName": "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.
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
{
"keyspaceName": "string",
"replicationRegions": [ "string" ],
"replicationStrategy": "string",
"resourceArn": "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.
- keyspaceName
-
The name of the keyspace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_]{0,47}
- replicationRegions
-
If the
replicationStrategy
of the keyspace isMULTI_REGION
, a list of replication Regions is returned.Type: Array of strings
Array Members: Minimum number of 2 items. Maximum number of 6 items.
Length Constraints: Minimum length of 2. Maximum length of 25.
- replicationStrategy
-
Returns the replication strategy of the keyspace. The options are
SINGLE_REGION
orMULTI_REGION
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Valid Values:
SINGLE_REGION | MULTI_REGION
- resourceArn
-
Returns the ARN of the keyspace.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1000.
Pattern:
arn:(aws[a-zA-Z0-9-]*):cassandra:.+.*
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 or table 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: