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.

Similarly, an S3 Tables log-publishing update (a request where logDestinationType is s3table) cannot be combined with any other namespace configuration change and must be submitted as its own request.

See also: AWS API Documentation

Request Syntax

response = client.update_namespace(
    adminPasswordSecretKmsKeyId='string',
    adminUserPassword='string',
    adminUsername='string',
    defaultIamRoleArn='string',
    iamRoles=[
        'string',
    ],
    kmsKeyId='string',
    logDestinationType='s3table'|'cloudwatch',
    logExports=[
        'useractivitylog'|'userlog'|'connectionlog',
    ],
    manageAdminPassword=True|False,
    namespaceName='string',
    s3TableAction='Enable'|'Disable',
    s3TableGranularity='namespace'|'account',
    s3TableKmsKeyId='string',
    s3TableNames=[
        '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.

  If your admin user account is locked, this operation also unlocks your account and resets the failed-login counter. This option is available only when account lockout security is enabled for the namespace.

• 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.

• logDestinationType (string) –

  The destination for the log data. Valid values are s3table and cloudwatch.

  Set this to s3table to manage Amazon S3 Tables system-table publishing for the namespace.

• 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.

• s3TableAction (string) –

  Whether to enable or disable Amazon S3 Tables publishing. Valid values are Enable and Disable, matched case-insensitively.

  When omitted, defaults to Enable. Valid only when logDestinationType is s3table.

• s3TableGranularity (string) –

  The scope of the Amazon S3 Tables destination. Valid values are namespace and account, matched case-insensitively. namespace scopes the published tables to this namespace; account scopes them to the Amazon Web Services account.

  Required when enabling. Omitting this parameter or passing a blank value fails with ValidationException. Valid only when logDestinationType is s3table.

• s3TableKmsKeyId (string) –

  The identifier of the Key Management Service key used to encrypt the published Amazon S3 Tables data. When omitted, the data is encrypted with SSE-S3 (Amazon S3 managed keys).

  Valid only when logDestinationType is s3table.

• s3TableNames (list) –

  The system tables to publish (on enable) or to stop publishing (on disable). Each value is either a system table view name that begins with sys_ or the keyword all.

  Omitting this parameter, passing an empty list, or including all each select every current and future system table. Each name must be 1-128 characters, and the list can contain up to 256 names.

  Valid only when logDestinationType is s3table.

  • (string) –

    A system-table view name to publish to S3 Tables (e.g. “sys_query_history”), or the keyword “all” to publish every current and future system table.

Return type:

dict

Returns:

Response Syntax

{
    'namespace': {
        'adminPasswordSecretArn': 'string',
        'adminPasswordSecretKmsKeyId': 'string',
        'adminUsername': 'string',
        'catalogArn': 'string',
        'creationDate': datetime(2015, 1, 1),
        'dbName': 'string',
        'defaultIamRoleArn': 'string',
        'iamRoles': [
            'string',
        ],
        'kmsKeyId': 'string',
        'lakehouseRegistrationStatus': 'string',
        'logExports': [
            'useractivitylog'|'userlog'|'connectionlog',
        ],
        'namespaceArn': 'string',
        'namespaceId': 'string',
        'namespaceName': 'string',
        's3TablePublishStatus': {
            'enabledAll': True|False,
            'lastIngestionTimes': {
                'string': 'string'
            },
            's3TableGranularity': 'namespace'|'account',
            's3TableNamespace': 'string',
            's3Tables': [
                '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.

    • catalogArn (string) –

      The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the namespace enabled with Amazon Redshift federated permissions.

    • 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.

    • lakehouseRegistrationStatus (string) –

      The status of the lakehouse registration for the namespace. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.

    • 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.

    • s3TablePublishStatus (dict) –

      The current Amazon S3 Tables log-publishing status for the namespace. Not returned when S3 Tables publishing has never been configured for the namespace.

      • enabledAll (boolean) –

        true when the namespace is enrolled in every current and future system table rather than an explicit list of tables.

      • lastIngestionTimes (dict) –

        A map of system table name to the time that table last received data, as an ISO-8601 timestamp. A table that has not yet been ingested is absent from the map. Use it to judge data freshness.

        • (string) –

          • (string) –

      • s3TableGranularity (string) –

        The scope currently in effect. Values are namespace or account.

      • s3TableNamespace (string) –

        The identifier of the namespace in the S3 table bucket that holds the published tables.

      • s3Tables (list) –

        The system tables currently being published.

        • (string) –

          A system-table view name to publish to S3 Tables (e.g. “sys_query_history”), or the keyword “all” to publish every current and future system table.

    • status (string) –

      The status of the namespace.

Exceptions

• RedshiftServerless.Client.exceptions.InternalServerException

• RedshiftServerless.Client.exceptions.ResourceNotFoundException

• RedshiftServerless.Client.exceptions.ValidationException

• RedshiftServerless.Client.exceptions.ConflictException