Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetKeyspace

Returns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the AWS Regions of a multi-Region keyspace, and the status of newly added Regions after an UpdateKeyspace operation.

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",
   "replicationGroupStatuses": [ 
      { 
         "keyspaceStatus": "string",
         "region": "string",
         "tablesReplicationProgress": "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}

replicationGroupStatuses

A list of all Regions the keyspace is replicated in after the update keyspace operation and their status.

Type: Array of ReplicationGroupStatus objects

Array Members: Minimum number of 2 items.

replicationRegions

If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.

Type: Array of strings

Array Members: Minimum number of 2 items.

Length Constraints: Minimum length of 2. Maximum length of 25.

replicationStrategy

Returns the replication strategy of the keyspace. The options are SINGLE_REGION or MULTI_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.

message: You don't have the required permissions to perform this operation. Verify your IAM permissions and try again.

HTTP Status Code: 400

InternalServerException

Amazon Keyspaces was unable to fully process this request because of an internal server error.

message: An internal service error occurred. Retry your request. If the problem persists, contact AWS Support.

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.

message: The specified resource was not found. Verify the resource identifier and ensure the resource exists and is in an ACTIVE state.
resourceArn: The unique identifier in the format of Amazon Resource Name (ARN) for the resource couldn't be found.

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.

message: The requested operation would exceed the service quota for this resource. Review the service quotas and adjust your request accordingly.

HTTP Status Code: 400

ValidationException

The operation failed due to an invalid or malformed request.

message: The request parameters are invalid or malformed. Review the API documentation and correct the request format.

HTTP Status Code: 400