RedshiftServerless / Client / update_lakehouse_configuration

update_lakehouse_configuration

RedshiftServerless.Client.update_lakehouse_configuration(**kwargs)

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

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

  • catalogName (string) –

    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_-]*$

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

  • 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 on a namespace enabled with Amazon Redshift federated permissions.

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

  • lakehouseRegistration (string) – Specifies whether to register or deregister the namespace with Amazon Redshift federated permissions. Valid values are Register or Deregister.

  • namespaceName (string) –

    [REQUIRED]

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

Return type:

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.

Exceptions

  • RedshiftServerless.Client.exceptions.InternalServerException

  • RedshiftServerless.Client.exceptions.ResourceNotFoundException

  • RedshiftServerless.Client.exceptions.ConflictException

  • RedshiftServerless.Client.exceptions.ValidationException

  • RedshiftServerless.Client.exceptions.DryRunException