LakeFormation / Client / create_lake_formation_identity_center_configuration

create_lake_formation_identity_center_configuration#

LakeFormation.Client.create_lake_formation_identity_center_configuration(**kwargs)#

Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.

See also: AWS API Documentation

Request Syntax

response = client.create_lake_formation_identity_center_configuration(
    CatalogId='string',
    InstanceArn='string',
    ExternalFiltering={
        'Status': 'ENABLED'|'DISABLED',
        'AuthorizedTargets': [
            'string',
        ]
    },
    ShareRecipients=[
        {
            'DataLakePrincipalIdentifier': '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.

  • InstanceArn (string) – The ARN of the IAM Identity Center instance for which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • 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) –

  • ShareRecipients (list) –

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

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

    If the ShareRecipients value is null or the list is empty, no resource share is created.

    • (dict) –

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

      • DataLakePrincipalIdentifier (string) –

        An identifier for the Lake Formation principal.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationArn': 'string'
}

Response Structure

  • (dict) –

    • ApplicationArn (string) –

      The Amazon Resource Name (ARN) of the Lake Formation application integrated with IAM Identity Center.

Exceptions

  • LakeFormation.Client.exceptions.InvalidInputException

  • LakeFormation.Client.exceptions.AlreadyExistsException

  • LakeFormation.Client.exceptions.InternalServiceException

  • LakeFormation.Client.exceptions.OperationTimeoutException

  • LakeFormation.Client.exceptions.AccessDeniedException

  • LakeFormation.Client.exceptions.ConcurrentModificationException