Redshift / Client / modify_lakehouse_configuration

modify_lakehouse_configuration

Redshift.Client.modify_lakehouse_configuration(**kwargs)

Modifies the lakehouse configuration for a cluster. 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.modify_lakehouse_configuration(
    ClusterIdentifier='string',
    LakehouseRegistration='Register'|'Deregister',
    CatalogName='string',
    LakehouseIdcRegistration='Associate'|'Disassociate',
    LakehouseIdcApplicationArn='string',
    DryRun=True|False
)
Parameters:

  • ClusterIdentifier (string) –

    [REQUIRED]

    The unique identifier of the cluster whose lakehouse configuration you want to modify.

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

  • CatalogName (string) –

    The name of the Glue data catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions.

    Constraints:

    • Must contain at least one lowercase letter.

    • Can only contain lowercase letters (a-z), numbers (0-9), underscores (_), and hyphens (-).

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

    Example: my-catalog_01

  • LakehouseIdcRegistration (string) – Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'ClusterIdentifier': 'string',
    'LakehouseIdcApplicationArn': 'string',
    'LakehouseRegistrationStatus': 'string',
    'CatalogArn': 'string'
}

Response Structure

  • (dict) –

    Contains configuration information for lakehouse integration, including the cluster identifier, catalog ARN, and registration status.

    • ClusterIdentifier (string) –

      The unique identifier of the cluster associated with this 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 on a cluster enabled with Amazon Redshift federated permissions.

    • LakehouseRegistrationStatus (string) –

      The current status of the lakehouse registration. Indicates whether the cluster is successfully registered with the lakehouse.

    • CatalogArn (string) –

      The Amazon Resource Name (ARN) of the Glue data catalog associated with the lakehouse configuration.

Exceptions

  • Redshift.Client.exceptions.ClusterNotFoundFault

  • Redshift.Client.exceptions.InvalidClusterStateFault

  • Redshift.Client.exceptions.UnsupportedOperationFault

  • Redshift.Client.exceptions.UnauthorizedOperation

  • Redshift.Client.exceptions.RedshiftIdcApplicationNotExistsFault

  • Redshift.Client.exceptions.DependentServiceUnavailableFault

  • Redshift.Client.exceptions.DependentServiceAccessDeniedFault