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.

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'
        },
    ],
    'ServiceIntegrations': [
        {
            'Redshift': [
                {
                    'RedshiftConnect': {
                        'Authorization': 'ENABLED'|'DISABLED'
                    }
                },
            ]
        },
    ],
    '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.
- 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 will be set: Redshift. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - 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 will be set: RedshiftConnect. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        RedshiftConnect (dict) –
        
        Configuration for Redshift Connect integration.
        
        Authorization (string) –
        
        The authorization status for Redshift Connect. Valid values are ENABLED or DISABLED.
- 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