Request Syntax Request Parameters Response Elements Errors See Also

UpdateLakeFormationIdentityCenterConfiguration

Updates the IAM Identity Center connection parameters.

Request Syntax


{
   "ApplicationStatus": "string",
   "CatalogId": "string",
   "ExternalFiltering": { 
      "AuthorizedTargets": [ "string" ],
      "Status": "string"
   },
   "ShareRecipients": [ 
      { 
         "DataLakePrincipalIdentifier": "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.

ApplicationStatus

Allows to enable or disable the IAM Identity Center connection.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

CatalogId

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, view definitions, and other control information to manage your Lake Formation environment.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

ExternalFiltering

A list of the account IDs of AWS accounts of third-party applications that are allowed to access data managed by Lake Formation.

Type: ExternalFilteringConfiguration object

Required: No

ShareRecipients

A list of AWS account IDs or AWS organization/organizational unit ARNs that are allowed to access to access data managed by Lake Formation.

If the ShareRecipients list includes valid values, then the resource share is updated with the principals you want to have access to the resources.

If the ShareRecipients value is null, both the list of share recipients and the resource share remain unchanged.

If the ShareRecipients value is an empty list, then the existing share recipients list will be cleared, and the resource share will be deleted.

Type: Array of DataLakePrincipal objects

Array Members: Minimum number of 0 items. Maximum number of 30 items.

Required: No

Response Elements

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

Errors

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

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

ConcurrentModificationException

Two processes are trying to modify a resource simultaneously.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400