LakeFormation / Client / update_lake_formation_identity_center_configuration

update_lake_formation_identity_center_configuration

LakeFormation.Client.update_lake_formation_identity_center_configuration(**kwargs)

Updates the IAM Identity Center connection parameters.

See also: AWS API Documentation

Request Syntax

response = client.update_lake_formation_identity_center_configuration(
    CatalogId='string',
    ShareRecipients=[
        {
            'DataLakePrincipalIdentifier': 'string'
        },
    ],
    ServiceIntegrations=[
        {
            'Redshift': [
                {
                    'RedshiftConnect': {
                        'Authorization': 'ENABLED'|'DISABLED'
                    }
                },
            ]
        },
    ],
    ApplicationStatus='ENABLED'|'DISABLED',
    ExternalFiltering={
        'Status': 'ENABLED'|'DISABLED',
        'AuthorizedTargets': [
            'string',
        ]
    }
)

Parameters:

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

• ShareRecipients (list) –

  A list of Amazon Web Services account IDs or Amazon Web Services 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.

  • (dict) –

    The Lake Formation principal. Supported principals are IAM users or IAM roles.

    • DataLakePrincipalIdentifier (string) –

      An identifier for the Lake Formation principal.

• ServiceIntegrations (list) –

  A list of service integrations for enabling trusted identity propagation with external services such as Redshift.

  • (dict) –

    A union structure representing different service integration types.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: Redshift.

    • Redshift (list) –

      Redshift service integration configuration.

      • (dict) –

        A union structure representing different Redshift integration scopes.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: RedshiftConnect.

        • RedshiftConnect (dict) –

          Configuration for Redshift Connect integration.

          • Authorization (string) – [REQUIRED]

            The authorization status for Redshift Connect. Valid values are ENABLED or DISABLED.

• ApplicationStatus (string) – Allows to enable or disable the IAM Identity Center connection.

• ExternalFiltering (dict) –

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

  • Status (string) – [REQUIRED]

    Allows to enable or disable the third-party applications that are allowed to access data managed by Lake Formation.

  • AuthorizedTargets (list) – [REQUIRED]

    List of third-party application ARNs integrated with Lake Formation.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• LakeFormation.Client.exceptions.InvalidInputException

• LakeFormation.Client.exceptions.EntityNotFoundException

• LakeFormation.Client.exceptions.InternalServiceException

• LakeFormation.Client.exceptions.OperationTimeoutException

• LakeFormation.Client.exceptions.AccessDeniedException

• LakeFormation.Client.exceptions.ConcurrentModificationException