LakeFormation / Client / describe_resource

describe_resource

LakeFormation.Client.describe_resource(**kwargs)

Retrieves the current data access role for the given resource registered in Lake Formation.

See also: AWS API Documentation

Request Syntax

response = client.describe_resource(
    ResourceArn='string'
)
Parameters:

ResourceArn (string) –

[REQUIRED]

The resource ARN.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceInfo': {
        'ResourceArn': 'string',
        'RoleArn': 'string',
        'LastModified': datetime(2015, 1, 1),
        'WithFederation': True|False,
        'HybridAccessEnabled': True|False,
        'WithPrivilegedAccess': True|False,
        'VerificationStatus': 'VERIFIED'|'VERIFICATION_FAILED'|'NOT_VERIFIED',
        'ExpectedResourceOwnerAccount': 'string'
    }
}

Response Structure

  • (dict) –

    • ResourceInfo (dict) –

      A structure containing information about an Lake Formation resource.

      • ResourceArn (string) –

        The Amazon Resource Name (ARN) of the resource.

      • RoleArn (string) –

        The IAM role that registered a resource.

      • LastModified (datetime) –

        The date and time the resource was last modified.

      • WithFederation (boolean) –

        Whether or not the resource is a federated resource.

      • HybridAccessEnabled (boolean) –

        Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.

      • WithPrivilegedAccess (boolean) –

        Grants the calling principal the permissions to perform all supported Lake Formation operations on the registered data location.

      • VerificationStatus (string) –

        Indicates whether the registered role has sufficient permissions to access registered Amazon S3 location. Verification Status can be one of the following:

        • VERIFIED - Registered role has sufficient permissions to access registered Amazon S3 location.

        • NOT_VERIFIED - Registered role does not have sufficient permissions to access registered Amazon S3 location.

        • VERIFICATION_FAILED - Unable to verify if the registered role can access the registered Amazon S3 location.

      • ExpectedResourceOwnerAccount (string) –

        The Amazon Web Services account that owns the Glue tables associated with specific Amazon S3 locations.

Exceptions

  • LakeFormation.Client.exceptions.InvalidInputException

  • LakeFormation.Client.exceptions.InternalServiceException

  • LakeFormation.Client.exceptions.OperationTimeoutException

  • LakeFormation.Client.exceptions.EntityNotFoundException