Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateNamespace

Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.

Request Syntax


{
   "adminPasswordSecretKmsKeyId": "string",
   "adminUsername": "string",
   "adminUserPassword": "string",
   "defaultIamRoleArn": "string",
   "iamRoles": [ "string" ],
   "kmsKeyId": "string",
   "logExports": [ "string" ],
   "manageAdminPassword": boolean,
   "namespaceName": "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. This parameter must be updated together with adminUserPassword.

Type: String

Required: No

adminUserPassword

The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername.

You can't use adminUserPassword if manageAdminPassword is true.

Type: String

Required: No

defaultIamRoleArn

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with iamRoles.

Type: String

Required: No

iamRoles

A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.

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. The 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 to update. You can't update the name of a namespace once it is created.

Type: String

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

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

Required: Yes

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

A list of tag instances.

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

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400