Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListKeyspaces

The ListKeyspaces operation returns a list of keyspaces.

Request Syntax


{
   "maxResults": number,
   "nextToken": "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.

maxResults

The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax


{
   "keyspaces": [ 
      { 
         "keyspaceName": "string",
         "replicationRegions": [ "string" ],
         "replicationStrategy": "string",
         "resourceArn": "string"
      }
   ],
   "nextToken": "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.

keyspaces

A list of keyspaces.

Type: Array of KeyspaceSummary objects

nextToken

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

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