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
{
"adminUsername": "string
",
"adminUserPassword": "string
",
"defaultIamRoleArn": "string
",
"iamRoles": [ "string
" ],
"kmsKeyId": "string
",
"logExports": [ "string
" ],
"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.
- 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
.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
, anduseractivitylog
.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 16 items.
Valid Values:
useractivitylog | userlog | connectionlog
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": {
"adminUsername": "string",
"creationDate": number,
"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.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: