Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateKeyspace

The CreateKeyspace operation adds a new keyspace to your account. In an AWS account, keyspace names must be unique within each Region.

CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace operation.

For more information, see Create a keyspace in the Amazon Keyspaces Developer Guide.

Request Syntax


{
   "keyspaceName": "string",
   "replicationSpecification": { 
      "regionList": [ "string" ],
      "replicationStrategy": "string"
   },
   "tags": [ 
      { 
         "key": "string",
         "value": "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 to be created.

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

replicationSpecification

The replication specification of the keyspace includes:

replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.
regionList - if the replicationStrategy is MULTI_REGION, the regionList requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in.

Type: ReplicationSpecification object

Required: No

tags

A list of key-value pair tags to be attached to the keyspace.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 60 items.

Required: No

Response Syntax


{
   "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.

resourceArn

The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).

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

ConflictException

Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.

message: The requested operation conflicts with the current state of the resource or another concurrent operation.

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

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