RedshiftServerless / Client / update_namespace

update_namespace

RedshiftServerless.Client.update_namespace(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_namespace(
    adminPasswordSecretKmsKeyId='string',
    adminUserPassword='string',
    adminUsername='string',
    defaultIamRoleArn='string',
    iamRoles=[
        'string',
    ],
    kmsKeyId='string',
    logExports=[
        'useractivitylog'|'userlog'|'connectionlog',
    ],
    manageAdminPassword=True|False,
    namespaceName='string'
)

Parameters:

• adminPasswordSecretKmsKeyId (string) – The ID of the 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.

• adminUserPassword (string) –

  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.

• adminUsername (string) – The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.

• defaultIamRoleArn (string) – 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.

• iamRoles (list) –

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

  • (string) –

• kmsKeyId (string) – The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

• logExports (list) –

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

  • (string) –

• manageAdminPassword (boolean) – If true, Amazon Redshift uses 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.

• namespaceName (string) –

  [REQUIRED]

  The name of the namespace to update. You can’t update the name of a namespace once it is created.

Return type:

dict

Returns:

Response Syntax

{
    'namespace': {
        'adminPasswordSecretArn': 'string',
        'adminPasswordSecretKmsKeyId': 'string',
        'adminUsername': 'string',
        'creationDate': datetime(2015, 1, 1),
        'dbName': 'string',
        'defaultIamRoleArn': 'string',
        'iamRoles': [
            'string',
        ],
        'kmsKeyId': 'string',
        'logExports': [
            'useractivitylog'|'userlog'|'connectionlog',
        ],
        'namespaceArn': 'string',
        'namespaceId': 'string',
        'namespaceName': 'string',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    }
}

Response Structure

• (dict) –

  • namespace (dict) –

    A list of tag instances.

    • adminPasswordSecretArn (string) –

      The Amazon Resource Name (ARN) for the namespace’s admin user credentials secret.

    • adminPasswordSecretKmsKeyId (string) –

      The ID of the Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret.

    • adminUsername (string) –

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

    • creationDate (datetime) –

      The date of when the namespace was created.

    • dbName (string) –

      The name of the first database created in the namespace.

    • defaultIamRoleArn (string) –

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

    • iamRoles (list) –

      A list of IAM roles to associate with the namespace.

      • (string) –

    • kmsKeyId (string) –

      The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

    • logExports (list) –

      The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

      • (string) –

    • namespaceArn (string) –

      The Amazon Resource Name (ARN) associated with a namespace.

    • namespaceId (string) –

      The unique identifier of a namespace.

    • namespaceName (string) –

      The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    • status (string) –

      The status of the namespace.

Exceptions

• RedshiftServerless.Client.exceptions.InternalServerException

• RedshiftServerless.Client.exceptions.ResourceNotFoundException

• RedshiftServerless.Client.exceptions.ConflictException

• RedshiftServerless.Client.exceptions.ValidationException