Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateNamespace

Creates a namespace in Amazon Redshift Serverless.

Request Syntax


{
   "adminPasswordSecretKmsKeyId": "string",
   "adminUsername": "string",
   "adminUserPassword": "string",
   "dbName": "string",
   "defaultIamRoleArn": "string",
   "iamRoles": [ "string" ],
   "kmsKeyId": "string",
   "logExports": [ "string" ],
   "manageAdminPassword": boolean,
   "namespaceName": "string",
   "redshiftIdcApplicationArn": "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.

adminPasswordSecretKmsKeyId

The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.

Type: String

Required: No

adminUsername

The username of the administrator for the first database created in the namespace.

Type: String

Required: No

adminUserPassword

The password of the administrator for the first database created in the namespace.

You can't use adminUserPassword if manageAdminPassword is true.

Type: String

Required: No

dbName

The name of the first database created in the namespace.

Type: String

Required: No

defaultIamRoleArn

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

Type: String

Required: No

iamRoles

A list of IAM roles to associate with the namespace.

Type: Array of strings

Required: No

kmsKeyId

The ID of the AWS Key Management Service key used to encrypt your data.

Type: String

Required: No

logExports

The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 16 items.

Valid Values: useractivitylog | userlog | connectionlog

Required: No

manageAdminPassword

If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.

Type: Boolean

Required: No

namespaceName

The name of the namespace.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: ^[a-z0-9-]+$

Required: Yes

redshiftIdcApplicationArn

The ARN for the Redshift application that integrates with IAM Identity Center.

Type: String

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

Required: No

tags

A list of tag instances.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


{
   "namespace": { 
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "creationDate": "string",
      "dbName": "string",
      "defaultIamRoleArn": "string",
      "iamRoles": [ "string" ],
      "kmsKeyId": "string",
      "logExports": [ "string" ],
      "namespaceArn": "string",
      "namespaceId": "string",
      "namespaceName": "string",
      "status": "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.

namespace

The created namespace object.

Type: Namespace object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The submitted action has conflicts.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

TooManyTagsException

The request exceeded the number of tags allowed for a resource.

HTTP Status Code: 400

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400