AWS API Changes

2025/11/21 - Redshift Serverless - 1 new7 updated api methods

Changes Added UpdateLakehouseConfiguration API to manage Amazon Redshift Federated Permissions and AWS IAM Identity Center trusted identity propagation for namespaces.

UpdateLakehouseConfiguration (new)

Link ¶

Modifies the lakehouse configuration for a namespace. This operation allows you to manage Amazon Redshift federated permissions and Amazon Web Services IAM Identity Center trusted identity propagation.

See also: AWS API Documentation

Request Syntax

client.update_lakehouse_configuration(
    catalogName='string',
    dryRun=True|False,
    lakehouseIdcApplicationArn='string',
    lakehouseIdcRegistration='Associate'|'Disassociate',
    lakehouseRegistration='Register'|'Deregister',
    namespaceName='string'
)

type catalogName:

string

param catalogName:

The name of the Glue Data Catalog that will be associated with the namespace enabled with Amazon Redshift federated permissions.

Pattern: ^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$

type dryRun:

boolean

param dryRun:

A boolean value that, if true, validates the request without actually updating the lakehouse configuration. Use this to check for errors before making changes.

type lakehouseIdcApplicationArn:

string

param lakehouseIdcApplicationArn:

The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a namespace enabled with Amazon Redshift federated permissions.

type lakehouseIdcRegistration:

string

param lakehouseIdcRegistration:

Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a namespace enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.

type lakehouseRegistration:

string

param lakehouseRegistration:

Specifies whether to register or deregister the namespace with Amazon Redshift federated permissions. Valid values are Register or Deregister.

type namespaceName:

string

param namespaceName:

[REQUIRED]

The name of the namespace whose lakehouse configuration you want to modify.

rtype:

dict

returns:

Response Syntax

{
    'catalogArn': 'string',
    'lakehouseIdcApplicationArn': 'string',
    'lakehouseRegistrationStatus': 'string',
    'namespaceName': 'string'
}

Response Structure

(dict) --
- catalogArn (string) --
  
  The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the lakehouse configuration.
- lakehouseIdcApplicationArn (string) --
  
  The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation.
- lakehouseRegistrationStatus (string) --
  
  The current status of the lakehouse registration. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.
- namespaceName (string) --
  
  The name of the namespace.

CreateNamespace (updated)

Link ¶
Changes (response)

{'namespace': {'catalogArn': 'string', 'lakehouseRegistrationStatus': 'string'}}

Creates a namespace in Amazon Redshift Serverless.

See also: AWS API Documentation

Request Syntax

client.create_namespace(
    adminPasswordSecretKmsKeyId='string',
    adminUserPassword='string',
    adminUsername='string',
    dbName='string',
    defaultIamRoleArn='string',
    iamRoles=[
        'string',
    ],
    kmsKeyId='string',
    logExports=[
        'useractivitylog'|'userlog'|'connectionlog',
    ],
    manageAdminPassword=True|False,
    namespaceName='string',
    redshiftIdcApplicationArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type adminPasswordSecretKmsKeyId:

string

param adminPasswordSecretKmsKeyId:

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.

type adminUserPassword:

string

param adminUserPassword:

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

You can't use adminUserPassword if manageAdminPassword is true.

type adminUsername:

string

param adminUsername:

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

type dbName:

string

param dbName:

The name of the first database created in the namespace.

type defaultIamRoleArn:

string

param defaultIamRoleArn:

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

type iamRoles:

list

param iamRoles:

A list of IAM roles to associate with the namespace.

(string) --

type kmsKeyId:

string

param kmsKeyId:

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

type logExports:

list

param logExports:

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

(string) --

type manageAdminPassword:

boolean

param manageAdminPassword:

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.

type namespaceName:

string

param namespaceName:

[REQUIRED]

The name of the namespace.

type redshiftIdcApplicationArn:

string

param redshiftIdcApplicationArn:

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

type tags:

list

param tags:

A list of tag instances.

(dict) --

A map of key-value pairs.
- key (string) -- [REQUIRED]
  
  The key to use in the tag.
- value (string) -- [REQUIRED]
  
  The value of the tag.

rtype:

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',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    }
}

Response Structure

(dict) --
- namespace (dict) --
  
  The created namespace object.
  - 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.
  - status (string) --
    
    The status of the namespace.

DeleteNamespace (updated)

Link ¶
Changes (response)

{'namespace': {'catalogArn': 'string', 'lakehouseRegistrationStatus': 'string'}}

Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.

See also: AWS API Documentation

Request Syntax

client.delete_namespace(
    finalSnapshotName='string',
    finalSnapshotRetentionPeriod=123,
    namespaceName='string'
)

type finalSnapshotName:

string

param finalSnapshotName:

The name of the snapshot to be created before the namespace is deleted.

type finalSnapshotRetentionPeriod:

integer

param finalSnapshotRetentionPeriod:

How long to retain the final snapshot.

type namespaceName:

string

param namespaceName:

[REQUIRED]

The name of the namespace to delete.

rtype:

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',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    }
}

Response Structure

(dict) --
- namespace (dict) --
  
  The deleted namespace object.
  - 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.
  - status (string) --
    
    The status of the namespace.

GetNamespace (updated)

Link ¶
Changes (response)

{'namespace': {'catalogArn': 'string', 'lakehouseRegistrationStatus': 'string'}}

Returns information about a namespace in Amazon Redshift Serverless.

See also: AWS API Documentation

Request Syntax

client.get_namespace(
    namespaceName='string'
)

type namespaceName:

string

param namespaceName:

[REQUIRED]

The name of the namespace to retrieve information for.

rtype:

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',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    }
}

Response Structure

(dict) --
- namespace (dict) --
  
  The returned namespace object.
  - 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.
  - status (string) --
    
    The status of the namespace.

ListNamespaces (updated)

Link ¶
Changes (response)

{'namespaces': {'catalogArn': 'string',
                'lakehouseRegistrationStatus': 'string'}}

Returns information about a list of specified namespaces.

See also: AWS API Documentation

Request Syntax

client.list_namespaces(
    maxResults=123,
    nextToken='string'
)

type maxResults:

integer

param maxResults:

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

type nextToken:

string

param nextToken:

If your initial ListNamespaces operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.

rtype:

dict

returns:

Response Syntax

{
    'namespaces': [
        {
            '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',
            'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- namespaces (list) --
  
  The list of returned namespaces.
  - (dict) --
    
    A collection of database objects and users.
    - 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.
    - status (string) --
      
      The status of the namespace.
- nextToken (string) --
  
  When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

RestoreFromRecoveryPoint (updated)

Link ¶
Changes (response)

{'namespace': {'catalogArn': 'string', 'lakehouseRegistrationStatus': 'string'}}

Restore the data from a recovery point.

See also: AWS API Documentation

Request Syntax

client.restore_from_recovery_point(
    namespaceName='string',
    recoveryPointId='string',
    workgroupName='string'
)

type namespaceName:

string

param namespaceName:

[REQUIRED]

The name of the namespace to restore data into.

type recoveryPointId:

string

param recoveryPointId:

[REQUIRED]

The unique identifier of the recovery point to restore from.

type workgroupName:

string

param workgroupName:

[REQUIRED]

The name of the workgroup used to restore data.

rtype:

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',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    },
    'recoveryPointId': 'string'
}

Response Structure

(dict) --
- namespace (dict) --
  
  The namespace that data was restored into.
  - 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.
  - status (string) --
    
    The status of the namespace.
- recoveryPointId (string) --
  
  The unique identifier of the recovery point used for the restore.

RestoreFromSnapshot (updated)

Link ¶
Changes (response)

{'namespace': {'catalogArn': 'string', 'lakehouseRegistrationStatus': 'string'}}

Restores a namespace from a snapshot.

See also: AWS API Documentation

Request Syntax

client.restore_from_snapshot(
    adminPasswordSecretKmsKeyId='string',
    manageAdminPassword=True|False,
    namespaceName='string',
    ownerAccount='string',
    snapshotArn='string',
    snapshotName='string',
    workgroupName='string'
)

type adminPasswordSecretKmsKeyId:

string

param adminPasswordSecretKmsKeyId:

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

type manageAdminPassword:

boolean

param manageAdminPassword:

If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.

type namespaceName:

string

param namespaceName:

[REQUIRED]

The name of the namespace to restore the snapshot to.

type ownerAccount:

string

param ownerAccount:

The Amazon Web Services account that owns the snapshot.

type snapshotArn:

string

param snapshotArn:

The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from a provisioned cluster to Amazon Redshift Serverless. Must not be specified at the same time as snapshotName.

The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.

type snapshotName:

string

param snapshotName:

The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.

type workgroupName:

string

param workgroupName:

[REQUIRED]

The name of the workgroup used to restore the snapshot.

rtype:

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',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    },
    'ownerAccount': 'string',
    'snapshotName': 'string'
}

Response Structure

(dict) --
- namespace (dict) --
  
  A collection of database objects and users.
  - 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.
  - status (string) --
    
    The status of the namespace.
- ownerAccount (string) --
  
  The owner Amazon Web Services; account of the snapshot that was restored.
- snapshotName (string) --
  
  The name of the snapshot used to restore the namespace.

UpdateNamespace (updated)

Link ¶
Changes (response)

{'namespace': {'catalogArn': 'string', 'lakehouseRegistrationStatus': 'string'}}

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

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

type adminPasswordSecretKmsKeyId:

string

param adminPasswordSecretKmsKeyId:

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.

type adminUserPassword:

string

param 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 adminUsername:

string

param adminUsername:

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

type defaultIamRoleArn:

string

param 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 iamRoles:

list

param iamRoles:

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

(string) --

type kmsKeyId:

string

param kmsKeyId:

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

type logExports:

list

param logExports:

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

(string) --

type manageAdminPassword:

boolean

param manageAdminPassword:

type namespaceName:

string

param namespaceName:

[REQUIRED]

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

rtype:

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',
        '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.
  - status (string) --
    
    The status of the namespace.