Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateLakehouseConfiguration

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

Request Syntax


{
   "catalogName": "string",
   "dryRun": boolean,
   "lakehouseIdcApplicationArn": "string",
   "lakehouseIdcRegistration": "string",
   "lakehouseRegistration": "string",
   "namespaceName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

catalogName

The name of the AWS 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: String

Length Constraints: Minimum length of 1. Maximum length of 64.

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

Required: No

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: Boolean

Required: No

lakehouseIdcApplicationArn

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

Type: String

Required: No

lakehouseIdcRegistration

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

Type: String

Valid Values: Associate | Disassociate

Required: No

lakehouseRegistration

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

Type: String

Valid Values: Register | Deregister

Required: No

namespaceName

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

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: [a-z0-9-]+

Required: Yes

Response Syntax


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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

catalogArn

The Amazon Resource Name (ARN) of the AWS Glue Data Catalog associated with the lakehouse configuration.

Type: String

lakehouseIdcApplicationArn

The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling AWS IAM Identity Center trusted identity propagation.

Type: String

lakehouseRegistrationStatus

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

Type: String

namespaceName

The name of the namespace.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: [a-z0-9-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The submitted action has conflicts.

HTTP Status Code: 400

DryRunException

This exception is thrown when the request was successful, but dry run was enabled so no action was taken.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

resourceName: The name of the resource that could not be found.

HTTP Status Code: 400

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400