AWS Lake Formation

2023/11/27 - AWS Lake Formation - 4 new api methods

Changes  This release adds four new APIs "DescribeLakeFormationIdentityCenterConfiguration", "CreateLakeFormationIdentityCenterConfiguration", "DescribeLakeFormationIdentityCenterConfiguration", and "DeleteLakeFormationIdentityCenterConfiguration", and also updates the corresponding documentation.

UpdateLakeFormationIdentityCenterConfiguration (new) Link ¶

Updates the IAM Identity Center connection parameters.

See also: AWS API Documentation

Request Syntax

client.update_lake_formation_identity_center_configuration(
    CatalogId='string',
    ApplicationStatus='ENABLED'|'DISABLED',
    ExternalFiltering={
        'Status': 'ENABLED'|'DISABLED',
        'AuthorizedTargets': [
            'string',
        ]
    }
)
type CatalogId:

string

param 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 ApplicationStatus:

string

param ApplicationStatus:

Allows to enable or disable the IAM Identity Center connection.

type ExternalFiltering:

dict

param ExternalFiltering:

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

CreateLakeFormationIdentityCenterConfiguration (new) Link ¶

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

client.create_lake_formation_identity_center_configuration(
    CatalogId='string',
    InstanceArn='string',
    ExternalFiltering={
        'Status': 'ENABLED'|'DISABLED',
        'AuthorizedTargets': [
            'string',
        ]
    }
)
type CatalogId:

string

param 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 InstanceArn:

string

param InstanceArn:

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.

type ExternalFiltering:

dict

param ExternalFiltering:

A list of the account IDs of Amazon Web Services accounts of third-party applications that are allowed to 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) --

rtype:

dict

returns:

Response Syntax

{
    'ApplicationArn': 'string'
}

Response Structure

  • (dict) --

    • ApplicationArn (string) --

      The Amazon Resource Name (ARN) of the integrated application.

DeleteLakeFormationIdentityCenterConfiguration (new) Link ¶

Deletes an IAM Identity Center connection with Lake Formation.

See also: AWS API Documentation

Request Syntax

client.delete_lake_formation_identity_center_configuration(
    CatalogId='string'
)
type CatalogId:

string

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DescribeLakeFormationIdentityCenterConfiguration (new) Link ¶

Retrieves the instance ARN and application ARN for the connection.

See also: AWS API Documentation

Request Syntax

client.describe_lake_formation_identity_center_configuration(
    CatalogId='string'
)
type CatalogId:

string

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

rtype:

dict

returns:

Response Syntax

{
    'CatalogId': 'string',
    'InstanceArn': 'string',
    'ApplicationArn': 'string',
    'ExternalFiltering': {
        'Status': 'ENABLED'|'DISABLED',
        'AuthorizedTargets': [
            '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 integrated application.

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