LakeFormation / Client / describe_lake_formation_identity_center_configuration

describe_lake_formation_identity_center_configuration#

LakeFormation.Client.describe_lake_formation_identity_center_configuration(**kwargs)#

Retrieves the instance ARN and application ARN for the connection.

See also: AWS API Documentation

Request Syntax

response = client.describe_lake_formation_identity_center_configuration(
    CatalogId='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, and other control information to manage your Lake Formation environment.

Return type:

dict

Returns:

Response Syntax

{
    'CatalogId': 'string',
    'InstanceArn': 'string',
    'ApplicationArn': 'string',
    'ExternalFiltering': {
        'Status': 'ENABLED'|'DISABLED',
        'AuthorizedTargets': [
            'string',
        ]
    },
    'ShareRecipients': [
        {
            'DataLakePrincipalIdentifier': 'string'
        },
    ],
    'ResourceShare': 'string'
}

Response Structure

  • (dict) –

    • 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, and other control information to manage your Lake Formation environment.

    • InstanceArn (string) –

      The Amazon Resource Name (ARN) of the connection.

    • ApplicationArn (string) –

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

    • ExternalFiltering (dict) –

      Indicates if external filtering is enabled.

      • Status (string) –

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

      • AuthorizedTargets (list) –

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

        • (string) –

    • ShareRecipients (list) –

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

      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.

    • ResourceShare (string) –

      The Amazon Resource Name (ARN) of the RAM share.

Exceptions

  • LakeFormation.Client.exceptions.InvalidInputException

  • LakeFormation.Client.exceptions.EntityNotFoundException

  • LakeFormation.Client.exceptions.InternalServiceException

  • LakeFormation.Client.exceptions.OperationTimeoutException

  • LakeFormation.Client.exceptions.AccessDeniedException