AddLFTagsToResource

$result = $client->addLFTagsToResource([/* ... */]);
$promise = $client->addLFTagsToResourceAsync([/* ... */]);

Attaches one or more LF-tags to an existing resource.

Parameter Syntax

$result = $client->addLFTagsToResource([
    'CatalogId' => '<string>',
    'LFTags' => [ // REQUIRED
        [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Resource' => [ // REQUIRED
        'Catalog' => [
            'Id' => '<string>',
        ],
        'DataCellsFilter' => [
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'TableCatalogId' => '<string>',
            'TableName' => '<string>',
        ],
        'DataLocation' => [
            'CatalogId' => '<string>',
            'ResourceArn' => '<string>', // REQUIRED
        ],
        'Database' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTag' => [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        'LFTagExpression' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTagPolicy' => [
            'CatalogId' => '<string>',
            'Expression' => [
                [
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ExpressionName' => '<string>',
            'ResourceType' => 'DATABASE|TABLE', // REQUIRED
        ],
        'Table' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>',
            'TableWildcard' => [
            ],
        ],
        'TableWithColumns' => [
            'CatalogId' => '<string>',
            'ColumnNames' => ['<string>', ...],
            'ColumnWildcard' => [
                'ExcludedColumnNames' => ['<string>', ...],
            ],
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Failures' => [
        [
            'Error' => [
                'ErrorCode' => '<string>',
                'ErrorMessage' => '<string>',
            ],
            'LFTag' => [
                'CatalogId' => '<string>',
                'TagKey' => '<string>',
                'TagValues' => ['<string>', ...],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

AssumeDecoratedRoleWithSAML

$result = $client->assumeDecoratedRoleWithSAML([/* ... */]);
$promise = $client->assumeDecoratedRoleWithSAMLAsync([/* ... */]);

Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.

This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API GetDataAccess. Therefore, all SAML roles that can be assumed via AssumeDecoratedRoleWithSAML must at a minimum include lakeformation:GetDataAccess in their role policies. A typical IAM policy attached to such a role would look as follows:

Parameter Syntax

$result = $client->assumeDecoratedRoleWithSAML([
    'DurationSeconds' => <integer>,
    'PrincipalArn' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'SAMLAssertion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccessKeyId' => '<string>',
    'Expiration' => <DateTime>,
    'SecretAccessKey' => '<string>',
    'SessionToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

EntityNotFoundException:

A specified entity does not exist.

AccessDeniedException:

Access to a resource was denied.

BatchGrantPermissions

$result = $client->batchGrantPermissions([/* ... */]);
$promise = $client->batchGrantPermissionsAsync([/* ... */]);

Batch operation to grant permissions to the principal.

Parameter Syntax

$result = $client->batchGrantPermissions([
    'CatalogId' => '<string>',
    'Entries' => [ // REQUIRED
        [
            'Id' => '<string>', // REQUIRED
            'Permissions' => ['<string>', ...],
            'PermissionsWithGrantOption' => ['<string>', ...],
            'Principal' => [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            'Resource' => [
                'Catalog' => [
                    'Id' => '<string>',
                ],
                'DataCellsFilter' => [
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                    'TableCatalogId' => '<string>',
                    'TableName' => '<string>',
                ],
                'DataLocation' => [
                    'CatalogId' => '<string>',
                    'ResourceArn' => '<string>', // REQUIRED
                ],
                'Database' => [
                    'CatalogId' => '<string>',
                    'Name' => '<string>', // REQUIRED
                ],
                'LFTag' => [
                    'CatalogId' => '<string>',
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                'LFTagExpression' => [
                    'CatalogId' => '<string>',
                    'Name' => '<string>', // REQUIRED
                ],
                'LFTagPolicy' => [
                    'CatalogId' => '<string>',
                    'Expression' => [
                        [
                            'TagKey' => '<string>', // REQUIRED
                            'TagValues' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                    'ExpressionName' => '<string>',
                    'ResourceType' => 'DATABASE|TABLE', // REQUIRED
                ],
                'Table' => [
                    'CatalogId' => '<string>',
                    'DatabaseName' => '<string>', // REQUIRED
                    'Name' => '<string>',
                    'TableWildcard' => [
                    ],
                ],
                'TableWithColumns' => [
                    'CatalogId' => '<string>',
                    'ColumnNames' => ['<string>', ...],
                    'ColumnWildcard' => [
                        'ExcludedColumnNames' => ['<string>', ...],
                    ],
                    'DatabaseName' => '<string>', // REQUIRED
                    'Name' => '<string>', // REQUIRED
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Failures' => [
        [
            'Error' => [
                'ErrorCode' => '<string>',
                'ErrorMessage' => '<string>',
            ],
            'RequestEntry' => [
                'Id' => '<string>',
                'Permissions' => ['<string>', ...],
                'PermissionsWithGrantOption' => ['<string>', ...],
                'Principal' => [
                    'DataLakePrincipalIdentifier' => '<string>',
                ],
                'Resource' => [
                    'Catalog' => [
                        'Id' => '<string>',
                    ],
                    'DataCellsFilter' => [
                        'DatabaseName' => '<string>',
                        'Name' => '<string>',
                        'TableCatalogId' => '<string>',
                        'TableName' => '<string>',
                    ],
                    'DataLocation' => [
                        'CatalogId' => '<string>',
                        'ResourceArn' => '<string>',
                    ],
                    'Database' => [
                        'CatalogId' => '<string>',
                        'Name' => '<string>',
                    ],
                    'LFTag' => [
                        'CatalogId' => '<string>',
                        'TagKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    'LFTagExpression' => [
                        'CatalogId' => '<string>',
                        'Name' => '<string>',
                    ],
                    'LFTagPolicy' => [
                        'CatalogId' => '<string>',
                        'Expression' => [
                            [
                                'TagKey' => '<string>',
                                'TagValues' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'ExpressionName' => '<string>',
                        'ResourceType' => 'DATABASE|TABLE',
                    ],
                    'Table' => [
                        'CatalogId' => '<string>',
                        'DatabaseName' => '<string>',
                        'Name' => '<string>',
                        'TableWildcard' => [
                        ],
                    ],
                    'TableWithColumns' => [
                        'CatalogId' => '<string>',
                        'ColumnNames' => ['<string>', ...],
                        'ColumnWildcard' => [
                            'ExcludedColumnNames' => ['<string>', ...],
                        ],
                        'DatabaseName' => '<string>',
                        'Name' => '<string>',
                    ],
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

OperationTimeoutException:

The operation timed out.

BatchRevokePermissions

$result = $client->batchRevokePermissions([/* ... */]);
$promise = $client->batchRevokePermissionsAsync([/* ... */]);

Batch operation to revoke permissions from the principal.

Parameter Syntax

$result = $client->batchRevokePermissions([
    'CatalogId' => '<string>',
    'Entries' => [ // REQUIRED
        [
            'Id' => '<string>', // REQUIRED
            'Permissions' => ['<string>', ...],
            'PermissionsWithGrantOption' => ['<string>', ...],
            'Principal' => [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            'Resource' => [
                'Catalog' => [
                    'Id' => '<string>',
                ],
                'DataCellsFilter' => [
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                    'TableCatalogId' => '<string>',
                    'TableName' => '<string>',
                ],
                'DataLocation' => [
                    'CatalogId' => '<string>',
                    'ResourceArn' => '<string>', // REQUIRED
                ],
                'Database' => [
                    'CatalogId' => '<string>',
                    'Name' => '<string>', // REQUIRED
                ],
                'LFTag' => [
                    'CatalogId' => '<string>',
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                'LFTagExpression' => [
                    'CatalogId' => '<string>',
                    'Name' => '<string>', // REQUIRED
                ],
                'LFTagPolicy' => [
                    'CatalogId' => '<string>',
                    'Expression' => [
                        [
                            'TagKey' => '<string>', // REQUIRED
                            'TagValues' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                    'ExpressionName' => '<string>',
                    'ResourceType' => 'DATABASE|TABLE', // REQUIRED
                ],
                'Table' => [
                    'CatalogId' => '<string>',
                    'DatabaseName' => '<string>', // REQUIRED
                    'Name' => '<string>',
                    'TableWildcard' => [
                    ],
                ],
                'TableWithColumns' => [
                    'CatalogId' => '<string>',
                    'ColumnNames' => ['<string>', ...],
                    'ColumnWildcard' => [
                        'ExcludedColumnNames' => ['<string>', ...],
                    ],
                    'DatabaseName' => '<string>', // REQUIRED
                    'Name' => '<string>', // REQUIRED
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Failures' => [
        [
            'Error' => [
                'ErrorCode' => '<string>',
                'ErrorMessage' => '<string>',
            ],
            'RequestEntry' => [
                'Id' => '<string>',
                'Permissions' => ['<string>', ...],
                'PermissionsWithGrantOption' => ['<string>', ...],
                'Principal' => [
                    'DataLakePrincipalIdentifier' => '<string>',
                ],
                'Resource' => [
                    'Catalog' => [
                        'Id' => '<string>',
                    ],
                    'DataCellsFilter' => [
                        'DatabaseName' => '<string>',
                        'Name' => '<string>',
                        'TableCatalogId' => '<string>',
                        'TableName' => '<string>',
                    ],
                    'DataLocation' => [
                        'CatalogId' => '<string>',
                        'ResourceArn' => '<string>',
                    ],
                    'Database' => [
                        'CatalogId' => '<string>',
                        'Name' => '<string>',
                    ],
                    'LFTag' => [
                        'CatalogId' => '<string>',
                        'TagKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    'LFTagExpression' => [
                        'CatalogId' => '<string>',
                        'Name' => '<string>',
                    ],
                    'LFTagPolicy' => [
                        'CatalogId' => '<string>',
                        'Expression' => [
                            [
                                'TagKey' => '<string>',
                                'TagValues' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'ExpressionName' => '<string>',
                        'ResourceType' => 'DATABASE|TABLE',
                    ],
                    'Table' => [
                        'CatalogId' => '<string>',
                        'DatabaseName' => '<string>',
                        'Name' => '<string>',
                        'TableWildcard' => [
                        ],
                    ],
                    'TableWithColumns' => [
                        'CatalogId' => '<string>',
                        'ColumnNames' => ['<string>', ...],
                        'ColumnWildcard' => [
                            'ExcludedColumnNames' => ['<string>', ...],
                        ],
                        'DatabaseName' => '<string>',
                        'Name' => '<string>',
                    ],
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

OperationTimeoutException:

The operation timed out.

CancelTransaction

$result = $client->cancelTransaction([/* ... */]);
$promise = $client->cancelTransactionAsync([/* ... */]);

Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.

Parameter Syntax

$result = $client->cancelTransaction([
    'TransactionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

TransactionCommittedException:

Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.

TransactionCommitInProgressException:

Contains details about an error related to a transaction commit that was in progress.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

CommitTransaction

$result = $client->commitTransaction([/* ... */]);
$promise = $client->commitTransactionAsync([/* ... */]);

Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.

Parameter Syntax

$result = $client->commitTransaction([
    'TransactionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TransactionStatus' => 'ACTIVE|COMMITTED|ABORTED|COMMIT_IN_PROGRESS',
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

TransactionCanceledException:

Contains details about an error related to a transaction that was cancelled.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

CreateDataCellsFilter

$result = $client->createDataCellsFilter([/* ... */]);
$promise = $client->createDataCellsFilterAsync([/* ... */]);

Creates a data cell filter to allow one to grant access to certain columns on certain rows.

Parameter Syntax

$result = $client->createDataCellsFilter([
    'TableData' => [ // REQUIRED
        'ColumnNames' => ['<string>', ...],
        'ColumnWildcard' => [
            'ExcludedColumnNames' => ['<string>', ...],
        ],
        'DatabaseName' => '<string>', // REQUIRED
        'Name' => '<string>', // REQUIRED
        'RowFilter' => [
            'AllRowsWildcard' => [
            ],
            'FilterExpression' => '<string>',
        ],
        'TableCatalogId' => '<string>', // REQUIRED
        'TableName' => '<string>', // REQUIRED
        'VersionId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AlreadyExistsException:

A resource to be created or added already exists.

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

ResourceNumberLimitExceededException:

A resource numerical limit was exceeded.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

CreateLFTag

$result = $client->createLFTag([/* ... */]);
$promise = $client->createLFTagAsync([/* ... */]);

Creates an LF-tag with the specified name and values.

Parameter Syntax

$result = $client->createLFTag([
    'CatalogId' => '<string>',
    'TagKey' => '<string>', // REQUIRED
    'TagValues' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

ResourceNumberLimitExceededException:

A resource numerical limit was exceeded.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

CreateLFTagExpression

$result = $client->createLFTagExpression([/* ... */]);
$promise = $client->createLFTagExpressionAsync([/* ... */]);

Creates a new LF-Tag expression with the provided name, description, catalog ID, and expression body. This call fails if a LF-Tag expression with the same name already exists in the caller’s account or if the underlying LF-Tags don't exist. To call this API operation, caller needs the following Lake Formation permissions:

CREATE_LF_TAG_EXPRESSION on the root catalog resource.

GRANT_WITH_LF_TAG_EXPRESSION on all underlying LF-Tag key:value pairs included in the expression.

Parameter Syntax

$result = $client->createLFTagExpression([
    'CatalogId' => '<string>',
    'Description' => '<string>',
    'Expression' => [ // REQUIRED
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

ResourceNumberLimitExceededException:

A resource numerical limit was exceeded.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

EntityNotFoundException:

A specified entity does not exist.

CreateLakeFormationIdentityCenterConfiguration

$result = $client->createLakeFormationIdentityCenterConfiguration([/* ... */]);
$promise = $client->createLakeFormationIdentityCenterConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createLakeFormationIdentityCenterConfiguration([
    'CatalogId' => '<string>',
    'ExternalFiltering' => [
        'AuthorizedTargets' => ['<string>', ...], // REQUIRED
        'Status' => 'ENABLED|DISABLED', // REQUIRED
    ],
    'InstanceArn' => '<string>',
    'ShareRecipients' => [
        [
            'DataLakePrincipalIdentifier' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ApplicationArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

AlreadyExistsException:

A resource to be created or added already exists.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

CreateLakeFormationOptIn

$result = $client->createLakeFormationOptIn([/* ... */]);
$promise = $client->createLakeFormationOptInAsync([/* ... */]);

Enforce Lake Formation permissions for the given databases, tables, and principals.

Parameter Syntax

$result = $client->createLakeFormationOptIn([
    'Principal' => [ // REQUIRED
        'DataLakePrincipalIdentifier' => '<string>',
    ],
    'Resource' => [ // REQUIRED
        'Catalog' => [
            'Id' => '<string>',
        ],
        'DataCellsFilter' => [
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'TableCatalogId' => '<string>',
            'TableName' => '<string>',
        ],
        'DataLocation' => [
            'CatalogId' => '<string>',
            'ResourceArn' => '<string>', // REQUIRED
        ],
        'Database' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTag' => [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        'LFTagExpression' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTagPolicy' => [
            'CatalogId' => '<string>',
            'Expression' => [
                [
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ExpressionName' => '<string>',
            'ResourceType' => 'DATABASE|TABLE', // REQUIRED
        ],
        'Table' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>',
            'TableWildcard' => [
            ],
        ],
        'TableWithColumns' => [
            'CatalogId' => '<string>',
            'ColumnNames' => ['<string>', ...],
            'ColumnWildcard' => [
                'ExcludedColumnNames' => ['<string>', ...],
            ],
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

EntityNotFoundException:

A specified entity does not exist.

AccessDeniedException:

Access to a resource was denied.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

DeleteDataCellsFilter

$result = $client->deleteDataCellsFilter([/* ... */]);
$promise = $client->deleteDataCellsFilterAsync([/* ... */]);

Deletes a data cell filter.

Parameter Syntax

$result = $client->deleteDataCellsFilter([
    'DatabaseName' => '<string>',
    'Name' => '<string>',
    'TableCatalogId' => '<string>',
    'TableName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

DeleteLFTag

$result = $client->deleteLFTag([/* ... */]);
$promise = $client->deleteLFTagAsync([/* ... */]);

Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the LFTagPolicy attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be applied to the resource.

Parameter Syntax

$result = $client->deleteLFTag([
    'CatalogId' => '<string>',
    'TagKey' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

DeleteLFTagExpression

$result = $client->deleteLFTagExpression([/* ... */]);
$promise = $client->deleteLFTagExpressionAsync([/* ... */]);

Deletes the LF-Tag expression. The caller must be a data lake admin or have DROP permissions on the LF-Tag expression. Deleting a LF-Tag expression will also delete all LFTagPolicy permissions referencing the LF-Tag expression.

Parameter Syntax

$result = $client->deleteLFTagExpression([
    'CatalogId' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

DeleteLakeFormationIdentityCenterConfiguration

$result = $client->deleteLakeFormationIdentityCenterConfiguration([/* ... */]);
$promise = $client->deleteLakeFormationIdentityCenterConfigurationAsync([/* ... */]);

Deletes an IAM Identity Center connection with Lake Formation.

Parameter Syntax

$result = $client->deleteLakeFormationIdentityCenterConfiguration([
    'CatalogId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

DeleteLakeFormationOptIn

$result = $client->deleteLakeFormationOptIn([/* ... */]);
$promise = $client->deleteLakeFormationOptInAsync([/* ... */]);

Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.

Parameter Syntax

$result = $client->deleteLakeFormationOptIn([
    'Principal' => [ // REQUIRED
        'DataLakePrincipalIdentifier' => '<string>',
    ],
    'Resource' => [ // REQUIRED
        'Catalog' => [
            'Id' => '<string>',
        ],
        'DataCellsFilter' => [
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'TableCatalogId' => '<string>',
            'TableName' => '<string>',
        ],
        'DataLocation' => [
            'CatalogId' => '<string>',
            'ResourceArn' => '<string>', // REQUIRED
        ],
        'Database' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTag' => [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        'LFTagExpression' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTagPolicy' => [
            'CatalogId' => '<string>',
            'Expression' => [
                [
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ExpressionName' => '<string>',
            'ResourceType' => 'DATABASE|TABLE', // REQUIRED
        ],
        'Table' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>',
            'TableWildcard' => [
            ],
        ],
        'TableWithColumns' => [
            'CatalogId' => '<string>',
            'ColumnNames' => ['<string>', ...],
            'ColumnWildcard' => [
                'ExcludedColumnNames' => ['<string>', ...],
            ],
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

EntityNotFoundException:

A specified entity does not exist.

AccessDeniedException:

Access to a resource was denied.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

DeleteObjectsOnCancel

$result = $client->deleteObjectsOnCancel([/* ... */]);
$promise = $client->deleteObjectsOnCancelAsync([/* ... */]);

For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.

The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically call DeleteObjectsOnCancel before writes. For more information, see Rolling Back Amazon S3 Writes.

Parameter Syntax

$result = $client->deleteObjectsOnCancel([
    'CatalogId' => '<string>',
    'DatabaseName' => '<string>', // REQUIRED
    'Objects' => [ // REQUIRED
        [
            'ETag' => '<string>',
            'Uri' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TableName' => '<string>', // REQUIRED
    'TransactionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

OperationTimeoutException:

The operation timed out.

EntityNotFoundException:

A specified entity does not exist.

TransactionCommittedException:

Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.

TransactionCanceledException:

Contains details about an error related to a transaction that was cancelled.

ResourceNotReadyException:

Contains details about an error related to a resource which is not ready for a transaction.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

DeregisterResource

$result = $client->deregisterResource([/* ... */]);
$promise = $client->deregisterResourceAsync([/* ... */]);

Deregisters the resource as managed by the Data Catalog.

When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.

Parameter Syntax

$result = $client->deregisterResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

EntityNotFoundException:

A specified entity does not exist.

DescribeLakeFormationIdentityCenterConfiguration

$result = $client->describeLakeFormationIdentityCenterConfiguration([/* ... */]);
$promise = $client->describeLakeFormationIdentityCenterConfigurationAsync([/* ... */]);

Retrieves the instance ARN and application ARN for the connection.

Parameter Syntax

$result = $client->describeLakeFormationIdentityCenterConfiguration([
    'CatalogId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApplicationArn' => '<string>',
    'CatalogId' => '<string>',
    'ExternalFiltering' => [
        'AuthorizedTargets' => ['<string>', ...],
        'Status' => 'ENABLED|DISABLED',
    ],
    'InstanceArn' => '<string>',
    'ResourceShare' => '<string>',
    'ShareRecipients' => [
        [
            'DataLakePrincipalIdentifier' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

DescribeResource

$result = $client->describeResource([/* ... */]);
$promise = $client->describeResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ResourceInfo' => [
        'HybridAccessEnabled' => true || false,
        'LastModified' => <DateTime>,
        'ResourceArn' => '<string>',
        'RoleArn' => '<string>',
        'WithFederation' => true || false,
    ],
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

EntityNotFoundException:

A specified entity does not exist.

DescribeTransaction

$result = $client->describeTransaction([/* ... */]);
$promise = $client->describeTransactionAsync([/* ... */]);

Returns the details of a single transaction.

Parameter Syntax

$result = $client->describeTransaction([
    'TransactionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TransactionDescription' => [
        'TransactionEndTime' => <DateTime>,
        'TransactionId' => '<string>',
        'TransactionStartTime' => <DateTime>,
        'TransactionStatus' => 'ACTIVE|COMMITTED|ABORTED|COMMIT_IN_PROGRESS',
    ],
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

ExtendTransaction

$result = $client->extendTransaction([/* ... */]);
$promise = $client->extendTransactionAsync([/* ... */]);

Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.

Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.

Parameter Syntax

$result = $client->extendTransaction([
    'TransactionId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

TransactionCommittedException:

Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.

TransactionCanceledException:

Contains details about an error related to a transaction that was cancelled.

TransactionCommitInProgressException:

Contains details about an error related to a transaction commit that was in progress.

GetDataCellsFilter

$result = $client->getDataCellsFilter([/* ... */]);
$promise = $client->getDataCellsFilterAsync([/* ... */]);

Returns a data cells filter.

Parameter Syntax

$result = $client->getDataCellsFilter([
    'DatabaseName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'TableCatalogId' => '<string>', // REQUIRED
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DataCellsFilter' => [
        'ColumnNames' => ['<string>', ...],
        'ColumnWildcard' => [
            'ExcludedColumnNames' => ['<string>', ...],
        ],
        'DatabaseName' => '<string>',
        'Name' => '<string>',
        'RowFilter' => [
            'AllRowsWildcard' => [
            ],
            'FilterExpression' => '<string>',
        ],
        'TableCatalogId' => '<string>',
        'TableName' => '<string>',
        'VersionId' => '<string>',
    ],
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

OperationTimeoutException:

The operation timed out.

InternalServiceException:

An internal service error occurred.

AccessDeniedException:

Access to a resource was denied.

GetDataLakePrincipal

$result = $client->getDataLakePrincipal([/* ... */]);
$promise = $client->getDataLakePrincipalAsync([/* ... */]);

Returns the identity of the invoking principal.

Parameter Syntax

$result = $client->getDataLakePrincipal([
]);

Parameter Details

Result Syntax

[
    'Identity' => '<string>',
]

Result Details

Errors

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

GetDataLakeSettings

$result = $client->getDataLakeSettings([/* ... */]);
$promise = $client->getDataLakeSettingsAsync([/* ... */]);

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

Parameter Syntax

$result = $client->getDataLakeSettings([
    'CatalogId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DataLakeSettings' => [
        'AllowExternalDataFiltering' => true || false,
        'AllowFullTableExternalDataAccess' => true || false,
        'AuthorizedSessionTagValueList' => ['<string>', ...],
        'CreateDatabaseDefaultPermissions' => [
            [
                'Permissions' => ['<string>', ...],
                'Principal' => [
                    'DataLakePrincipalIdentifier' => '<string>',
                ],
            ],
            // ...
        ],
        'CreateTableDefaultPermissions' => [
            [
                'Permissions' => ['<string>', ...],
                'Principal' => [
                    'DataLakePrincipalIdentifier' => '<string>',
                ],
            ],
            // ...
        ],
        'DataLakeAdmins' => [
            [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            // ...
        ],
        'ExternalDataFilteringAllowList' => [
            [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            // ...
        ],
        'Parameters' => ['<string>', ...],
        'ReadOnlyAdmins' => [
            [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            // ...
        ],
        'TrustedResourceOwners' => ['<string>', ...],
    ],
]

Result Details

Errors

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

GetEffectivePermissionsForPath

$result = $client->getEffectivePermissionsForPath([/* ... */]);
$promise = $client->getEffectivePermissionsForPathAsync([/* ... */]);

Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.

Parameter Syntax

$result = $client->getEffectivePermissionsForPath([
    'CatalogId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Permissions' => [
        [
            'AdditionalDetails' => [
                'ResourceShare' => ['<string>', ...],
            ],
            'Condition' => [
                'Expression' => '<string>',
            ],
            'LastUpdated' => <DateTime>,
            'LastUpdatedBy' => '<string>',
            'Permissions' => ['<string>', ...],
            'PermissionsWithGrantOption' => ['<string>', ...],
            'Principal' => [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            'Resource' => [
                'Catalog' => [
                    'Id' => '<string>',
                ],
                'DataCellsFilter' => [
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                    'TableCatalogId' => '<string>',
                    'TableName' => '<string>',
                ],
                'DataLocation' => [
                    'CatalogId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                'Database' => [
                    'CatalogId' => '<string>',
                    'Name' => '<string>',
                ],
                'LFTag' => [
                    'CatalogId' => '<string>',
                    'TagKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                'LFTagExpression' => [
                    'CatalogId' => '<string>',
                    'Name' => '<string>',
                ],
                'LFTagPolicy' => [
                    'CatalogId' => '<string>',
                    'Expression' => [
                        [
                            'TagKey' => '<string>',
                            'TagValues' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'ExpressionName' => '<string>',
                    'ResourceType' => 'DATABASE|TABLE',
                ],
                'Table' => [
                    'CatalogId' => '<string>',
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                    'TableWildcard' => [
                    ],
                ],
                'TableWithColumns' => [
                    'CatalogId' => '<string>',
                    'ColumnNames' => ['<string>', ...],
                    'ColumnWildcard' => [
                        'ExcludedColumnNames' => ['<string>', ...],
                    ],
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

OperationTimeoutException:

The operation timed out.

InternalServiceException:

An internal service error occurred.

GetLFTag

$result = $client->getLFTag([/* ... */]);
$promise = $client->getLFTagAsync([/* ... */]);

Returns an LF-tag definition.

Parameter Syntax

$result = $client->getLFTag([
    'CatalogId' => '<string>',
    'TagKey' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CatalogId' => '<string>',
    'TagKey' => '<string>',
    'TagValues' => ['<string>', ...],
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

GetLFTagExpression

$result = $client->getLFTagExpression([/* ... */]);
$promise = $client->getLFTagExpressionAsync([/* ... */]);

Returns the details about the LF-Tag expression. The caller must be a data lake admin or must have DESCRIBE permission on the LF-Tag expression resource.

Parameter Syntax

$result = $client->getLFTagExpression([
    'CatalogId' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CatalogId' => '<string>',
    'Description' => '<string>',
    'Expression' => [
        [
            'TagKey' => '<string>',
            'TagValues' => ['<string>', ...],
        ],
        // ...
    ],
    'Name' => '<string>',
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

GetQueryState

$result = $client->getQueryState([/* ... */]);
$promise = $client->getQueryStateAsync([/* ... */]);

Returns the state of a query previously submitted. Clients are expected to poll GetQueryState to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to StartQueryPlanning.

Parameter Syntax

$result = $client->getQueryState([
    'QueryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Error' => '<string>',
    'State' => 'PENDING|WORKUNITS_AVAILABLE|ERROR|FINISHED|EXPIRED',
]

Result Details

Errors

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

AccessDeniedException:

Access to a resource was denied.

GetQueryStatistics

$result = $client->getQueryStatistics([/* ... */]);
$promise = $client->getQueryStatisticsAsync([/* ... */]);

Retrieves statistics on the planning and execution of a query.

Parameter Syntax

$result = $client->getQueryStatistics([
    'QueryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ExecutionStatistics' => [
        'AverageExecutionTimeMillis' => <integer>,
        'DataScannedBytes' => <integer>,
        'WorkUnitsExecutedCount' => <integer>,
    ],
    'PlanningStatistics' => [
        'EstimatedDataToScanBytes' => <integer>,
        'PlanningTimeMillis' => <integer>,
        'QueueTimeMillis' => <integer>,
        'WorkUnitsGeneratedCount' => <integer>,
    ],
    'QuerySubmissionTime' => <DateTime>,
]

Result Details

Errors

StatisticsNotReadyYetException:

Contains details about an error related to statistics not being ready.

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

AccessDeniedException:

Access to a resource was denied.

ExpiredException:

Contains details about an error where the query request expired.

ThrottledException:

Contains details about an error where the query request was throttled.

GetResourceLFTags

$result = $client->getResourceLFTags([/* ... */]);
$promise = $client->getResourceLFTagsAsync([/* ... */]);

Returns the LF-tags applied to a resource.

Parameter Syntax

$result = $client->getResourceLFTags([
    'CatalogId' => '<string>',
    'Resource' => [ // REQUIRED
        'Catalog' => [
            'Id' => '<string>',
        ],
        'DataCellsFilter' => [
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'TableCatalogId' => '<string>',
            'TableName' => '<string>',
        ],
        'DataLocation' => [
            'CatalogId' => '<string>',
            'ResourceArn' => '<string>', // REQUIRED
        ],
        'Database' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTag' => [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        'LFTagExpression' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTagPolicy' => [
            'CatalogId' => '<string>',
            'Expression' => [
                [
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ExpressionName' => '<string>',
            'ResourceType' => 'DATABASE|TABLE', // REQUIRED
        ],
        'Table' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>',
            'TableWildcard' => [
            ],
        ],
        'TableWithColumns' => [
            'CatalogId' => '<string>',
            'ColumnNames' => ['<string>', ...],
            'ColumnWildcard' => [
                'ExcludedColumnNames' => ['<string>', ...],
            ],
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
    ],
    'ShowAssignedLFTags' => true || false,
]);

Parameter Details

Result Syntax

[
    'LFTagOnDatabase' => [
        [
            'CatalogId' => '<string>',
            'TagKey' => '<string>',
            'TagValues' => ['<string>', ...],
        ],
        // ...
    ],
    'LFTagsOnColumns' => [
        [
            'LFTags' => [
                [
                    'CatalogId' => '<string>',
                    'TagKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                // ...
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'LFTagsOnTable' => [
        [
            'CatalogId' => '<string>',
            'TagKey' => '<string>',
            'TagValues' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

GlueEncryptionException:

An encryption operation failed.

AccessDeniedException:

Access to a resource was denied.

GetTableObjects

$result = $client->getTableObjects([/* ... */]);
$promise = $client->getTableObjectsAsync([/* ... */]);

Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.

Parameter Syntax

$result = $client->getTableObjects([
    'CatalogId' => '<string>',
    'DatabaseName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PartitionPredicate' => '<string>',
    'QueryAsOfTime' => <integer || string || DateTime>,
    'TableName' => '<string>', // REQUIRED
    'TransactionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Objects' => [
        [
            'Objects' => [
                [
                    'ETag' => '<string>',
                    'Size' => <integer>,
                    'Uri' => '<string>',
                ],
                // ...
            ],
            'PartitionValues' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

OperationTimeoutException:

The operation timed out.

TransactionCommittedException:

Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.

TransactionCanceledException:

Contains details about an error related to a transaction that was cancelled.

ResourceNotReadyException:

Contains details about an error related to a resource which is not ready for a transaction.

GetTemporaryGluePartitionCredentials

$result = $client->getTemporaryGluePartitionCredentials([/* ... */]);
$promise = $client->getTemporaryGluePartitionCredentialsAsync([/* ... */]);

This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix.

Parameter Syntax

$result = $client->getTemporaryGluePartitionCredentials([
    'AuditContext' => [
        'AdditionalAuditContext' => '<string>',
    ],
    'DurationSeconds' => <integer>,
    'Partition' => [ // REQUIRED
        'Values' => ['<string>', ...], // REQUIRED
    ],
    'Permissions' => ['<string>', ...],
    'SupportedPermissionTypes' => ['<string>', ...],
    'TableArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccessKeyId' => '<string>',
    'Expiration' => <DateTime>,
    'SecretAccessKey' => '<string>',
    'SessionToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

EntityNotFoundException:

A specified entity does not exist.

AccessDeniedException:

Access to a resource was denied.

PermissionTypeMismatchException:

The engine does not support filtering data based on the enforced permissions. For example, if you call the GetTemporaryGlueTableCredentials operation with SupportedPermissionType equal to ColumnPermission, but cell-level permissions exist on the table, this exception is thrown.

GetTemporaryGlueTableCredentials

$result = $client->getTemporaryGlueTableCredentials([/* ... */]);
$promise = $client->getTemporaryGlueTableCredentialsAsync([/* ... */]);

Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.

To call this API, the role that the service assumes must have lakeformation:GetDataAccess permission on the resource.

Parameter Syntax

$result = $client->getTemporaryGlueTableCredentials([
    'AuditContext' => [
        'AdditionalAuditContext' => '<string>',
    ],
    'DurationSeconds' => <integer>,
    'Permissions' => ['<string>', ...],
    'QuerySessionContext' => [
        'AdditionalContext' => ['<string>', ...],
        'ClusterId' => '<string>',
        'QueryAuthorizationId' => '<string>',
        'QueryId' => '<string>',
        'QueryStartTime' => <integer || string || DateTime>,
    ],
    'S3Path' => '<string>',
    'SupportedPermissionTypes' => ['<string>', ...],
    'TableArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccessKeyId' => '<string>',
    'Expiration' => <DateTime>,
    'SecretAccessKey' => '<string>',
    'SessionToken' => '<string>',
    'VendedS3Path' => ['<string>', ...],
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

EntityNotFoundException:

A specified entity does not exist.

AccessDeniedException:

Access to a resource was denied.

PermissionTypeMismatchException:

The engine does not support filtering data based on the enforced permissions. For example, if you call the GetTemporaryGlueTableCredentials operation with SupportedPermissionType equal to ColumnPermission, but cell-level permissions exist on the table, this exception is thrown.

GetWorkUnitResults

$result = $client->getWorkUnitResults([/* ... */]);
$promise = $client->getWorkUnitResultsAsync([/* ... */]);

Returns the work units resulting from the query. Work units can be executed in any order and in parallel.

Parameter Syntax

$result = $client->getWorkUnitResults([
    'QueryId' => '<string>', // REQUIRED
    'WorkUnitId' => <integer>, // REQUIRED
    'WorkUnitToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ResultStream' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

AccessDeniedException:

Access to a resource was denied.

ExpiredException:

Contains details about an error where the query request expired.

ThrottledException:

Contains details about an error where the query request was throttled.

GetWorkUnits

$result = $client->getWorkUnits([/* ... */]);
$promise = $client->getWorkUnitsAsync([/* ... */]);

Retrieves the work units generated by the StartQueryPlanning operation.

Parameter Syntax

$result = $client->getWorkUnits([
    'NextToken' => '<string>',
    'PageSize' => <integer>,
    'QueryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'QueryId' => '<string>',
    'WorkUnitRanges' => [
        [
            'WorkUnitIdMax' => <integer>,
            'WorkUnitIdMin' => <integer>,
            'WorkUnitToken' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

WorkUnitsNotReadyYetException:

Contains details about an error related to work units not being ready.

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

AccessDeniedException:

Access to a resource was denied.

ExpiredException:

Contains details about an error where the query request expired.

GrantPermissions

$result = $client->grantPermissions([/* ... */]);
$promise = $client->grantPermissionsAsync([/* ... */]);

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

For information about permissions, see Security and Access Control to Metadata and Data.

Parameter Syntax

$result = $client->grantPermissions([
    'CatalogId' => '<string>',
    'Permissions' => ['<string>', ...], // REQUIRED
    'PermissionsWithGrantOption' => ['<string>', ...],
    'Principal' => [ // REQUIRED
        'DataLakePrincipalIdentifier' => '<string>',
    ],
    'Resource' => [ // REQUIRED
        'Catalog' => [
            'Id' => '<string>',
        ],
        'DataCellsFilter' => [
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'TableCatalogId' => '<string>',
            'TableName' => '<string>',
        ],
        'DataLocation' => [
            'CatalogId' => '<string>',
            'ResourceArn' => '<string>', // REQUIRED
        ],
        'Database' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTag' => [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        'LFTagExpression' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTagPolicy' => [
            'CatalogId' => '<string>',
            'Expression' => [
                [
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ExpressionName' => '<string>',
            'ResourceType' => 'DATABASE|TABLE', // REQUIRED
        ],
        'Table' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>',
            'TableWildcard' => [
            ],
        ],
        'TableWithColumns' => [
            'CatalogId' => '<string>',
            'ColumnNames' => ['<string>', ...],
            'ColumnWildcard' => [
                'ExcludedColumnNames' => ['<string>', ...],
            ],
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

ListDataCellsFilter

$result = $client->listDataCellsFilter([/* ... */]);
$promise = $client->listDataCellsFilterAsync([/* ... */]);

Lists all the data cell filters on a table.

Parameter Syntax

$result = $client->listDataCellsFilter([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Table' => [
        'CatalogId' => '<string>',
        'DatabaseName' => '<string>', // REQUIRED
        'Name' => '<string>',
        'TableWildcard' => [
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'DataCellsFilters' => [
        [
            'ColumnNames' => ['<string>', ...],
            'ColumnWildcard' => [
                'ExcludedColumnNames' => ['<string>', ...],
            ],
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'RowFilter' => [
                'AllRowsWildcard' => [
                ],
                'FilterExpression' => '<string>',
            ],
            'TableCatalogId' => '<string>',
            'TableName' => '<string>',
            'VersionId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

OperationTimeoutException:

The operation timed out.

InternalServiceException:

An internal service error occurred.

AccessDeniedException:

Access to a resource was denied.

ListLFTagExpressions

$result = $client->listLFTagExpressions([/* ... */]);
$promise = $client->listLFTagExpressionsAsync([/* ... */]);

Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions. Data Lake and read only admins implicitly can see all tag expressions in their account, else caller needs DESCRIBE permissions on tag expression.

Parameter Syntax

$result = $client->listLFTagExpressions([
    'CatalogId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LFTagExpressions' => [
        [
            'CatalogId' => '<string>',
            'Description' => '<string>',
            'Expression' => [
                [
                    'TagKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                // ...
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

ListLFTags

$result = $client->listLFTags([/* ... */]);
$promise = $client->listLFTagsAsync([/* ... */]);

Lists LF-tags that the requester has permission to view.

Parameter Syntax

$result = $client->listLFTags([
    'CatalogId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceShareType' => 'FOREIGN|ALL',
]);

Parameter Details

Result Syntax

[
    'LFTags' => [
        [
            'CatalogId' => '<string>',
            'TagKey' => '<string>',
            'TagValues' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

ListLakeFormationOptIns

$result = $client->listLakeFormationOptIns([/* ... */]);
$promise = $client->listLakeFormationOptInsAsync([/* ... */]);

Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.

Parameter Syntax

$result = $client->listLakeFormationOptIns([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Principal' => [
        'DataLakePrincipalIdentifier' => '<string>',
    ],
    'Resource' => [
        'Catalog' => [
            'Id' => '<string>',
        ],
        'DataCellsFilter' => [
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'TableCatalogId' => '<string>',
            'TableName' => '<string>',
        ],
        'DataLocation' => [
            'CatalogId' => '<string>',
            'ResourceArn' => '<string>', // REQUIRED
        ],
        'Database' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTag' => [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        'LFTagExpression' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTagPolicy' => [
            'CatalogId' => '<string>',
            'Expression' => [
                [
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ExpressionName' => '<string>',
            'ResourceType' => 'DATABASE|TABLE', // REQUIRED
        ],
        'Table' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>',
            'TableWildcard' => [
            ],
        ],
        'TableWithColumns' => [
            'CatalogId' => '<string>',
            'ColumnNames' => ['<string>', ...],
            'ColumnWildcard' => [
                'ExcludedColumnNames' => ['<string>', ...],
            ],
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'LakeFormationOptInsInfoList' => [
        [
            'Condition' => [
                'Expression' => '<string>',
            ],
            'LastModified' => <DateTime>,
            'LastUpdatedBy' => '<string>',
            'Principal' => [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            'Resource' => [
                'Catalog' => [
                    'Id' => '<string>',
                ],
                'DataCellsFilter' => [
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                    'TableCatalogId' => '<string>',
                    'TableName' => '<string>',
                ],
                'DataLocation' => [
                    'CatalogId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                'Database' => [
                    'CatalogId' => '<string>',
                    'Name' => '<string>',
                ],
                'LFTag' => [
                    'CatalogId' => '<string>',
                    'TagKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                'LFTagExpression' => [
                    'CatalogId' => '<string>',
                    'Name' => '<string>',
                ],
                'LFTagPolicy' => [
                    'CatalogId' => '<string>',
                    'Expression' => [
                        [
                            'TagKey' => '<string>',
                            'TagValues' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'ExpressionName' => '<string>',
                    'ResourceType' => 'DATABASE|TABLE',
                ],
                'Table' => [
                    'CatalogId' => '<string>',
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                    'TableWildcard' => [
                    ],
                ],
                'TableWithColumns' => [
                    'CatalogId' => '<string>',
                    'ColumnNames' => ['<string>', ...],
                    'ColumnWildcard' => [
                        'ExcludedColumnNames' => ['<string>', ...],
                    ],
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

ListPermissions

$result = $client->listPermissions([/* ... */]);
$promise = $client->listPermissionsAsync([/* ... */]);

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

This operation returns only those permissions that have been explicitly granted.

For information about permissions, see Security and Access Control to Metadata and Data.

Parameter Syntax

$result = $client->listPermissions([
    'CatalogId' => '<string>',
    'IncludeRelated' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Principal' => [
        'DataLakePrincipalIdentifier' => '<string>',
    ],
    'Resource' => [
        'Catalog' => [
            'Id' => '<string>',
        ],
        'DataCellsFilter' => [
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'TableCatalogId' => '<string>',
            'TableName' => '<string>',
        ],
        'DataLocation' => [
            'CatalogId' => '<string>',
            'ResourceArn' => '<string>', // REQUIRED
        ],
        'Database' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTag' => [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        'LFTagExpression' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTagPolicy' => [
            'CatalogId' => '<string>',
            'Expression' => [
                [
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ExpressionName' => '<string>',
            'ResourceType' => 'DATABASE|TABLE', // REQUIRED
        ],
        'Table' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>',
            'TableWildcard' => [
            ],
        ],
        'TableWithColumns' => [
            'CatalogId' => '<string>',
            'ColumnNames' => ['<string>', ...],
            'ColumnWildcard' => [
                'ExcludedColumnNames' => ['<string>', ...],
            ],
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
    ],
    'ResourceType' => 'CATALOG|DATABASE|TABLE|DATA_LOCATION|LF_TAG|LF_TAG_POLICY|LF_TAG_POLICY_DATABASE|LF_TAG_POLICY_TABLE|LF_NAMED_TAG_EXPRESSION',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PrincipalResourcePermissions' => [
        [
            'AdditionalDetails' => [
                'ResourceShare' => ['<string>', ...],
            ],
            'Condition' => [
                'Expression' => '<string>',
            ],
            'LastUpdated' => <DateTime>,
            'LastUpdatedBy' => '<string>',
            'Permissions' => ['<string>', ...],
            'PermissionsWithGrantOption' => ['<string>', ...],
            'Principal' => [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            'Resource' => [
                'Catalog' => [
                    'Id' => '<string>',
                ],
                'DataCellsFilter' => [
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                    'TableCatalogId' => '<string>',
                    'TableName' => '<string>',
                ],
                'DataLocation' => [
                    'CatalogId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                'Database' => [
                    'CatalogId' => '<string>',
                    'Name' => '<string>',
                ],
                'LFTag' => [
                    'CatalogId' => '<string>',
                    'TagKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                'LFTagExpression' => [
                    'CatalogId' => '<string>',
                    'Name' => '<string>',
                ],
                'LFTagPolicy' => [
                    'CatalogId' => '<string>',
                    'Expression' => [
                        [
                            'TagKey' => '<string>',
                            'TagValues' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'ExpressionName' => '<string>',
                    'ResourceType' => 'DATABASE|TABLE',
                ],
                'Table' => [
                    'CatalogId' => '<string>',
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                    'TableWildcard' => [
                    ],
                ],
                'TableWithColumns' => [
                    'CatalogId' => '<string>',
                    'ColumnNames' => ['<string>', ...],
                    'ColumnWildcard' => [
                        'ExcludedColumnNames' => ['<string>', ...],
                    ],
                    'DatabaseName' => '<string>',
                    'Name' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

OperationTimeoutException:

The operation timed out.

InternalServiceException:

An internal service error occurred.

ListResources

$result = $client->listResources([/* ... */]);
$promise = $client->listResourcesAsync([/* ... */]);

Lists the resources registered to be managed by the Data Catalog.

Parameter Syntax

$result = $client->listResources([
    'FilterConditionList' => [
        [
            'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT|CONTAINS|NOT_CONTAINS|BEGINS_WITH|IN|BETWEEN',
            'Field' => 'RESOURCE_ARN|ROLE_ARN|LAST_MODIFIED',
            'StringValueList' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceInfoList' => [
        [
            'HybridAccessEnabled' => true || false,
            'LastModified' => <DateTime>,
            'ResourceArn' => '<string>',
            'RoleArn' => '<string>',
            'WithFederation' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

ListTableStorageOptimizers

$result = $client->listTableStorageOptimizers([/* ... */]);
$promise = $client->listTableStorageOptimizersAsync([/* ... */]);

Returns the configuration of all storage optimizers associated with a specified table.

Parameter Syntax

$result = $client->listTableStorageOptimizers([
    'CatalogId' => '<string>',
    'DatabaseName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StorageOptimizerType' => 'COMPACTION|GARBAGE_COLLECTION|ALL',
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'StorageOptimizerList' => [
        [
            'Config' => ['<string>', ...],
            'ErrorMessage' => '<string>',
            'LastRunDetails' => '<string>',
            'StorageOptimizerType' => 'COMPACTION|GARBAGE_COLLECTION|ALL',
            'Warnings' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

AccessDeniedException:

Access to a resource was denied.

InternalServiceException:

An internal service error occurred.

ListTransactions

$result = $client->listTransactions([/* ... */]);
$promise = $client->listTransactionsAsync([/* ... */]);

Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.

This operation can help you identify uncommitted transactions or to get information about transactions.

Parameter Syntax

$result = $client->listTransactions([
    'CatalogId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StatusFilter' => 'ALL|COMPLETED|ACTIVE|COMMITTED|ABORTED',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Transactions' => [
        [
            'TransactionEndTime' => <DateTime>,
            'TransactionId' => '<string>',
            'TransactionStartTime' => <DateTime>,
            'TransactionStatus' => 'ACTIVE|COMMITTED|ABORTED|COMMIT_IN_PROGRESS',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

PutDataLakeSettings

$result = $client->putDataLakeSettings([/* ... */]);
$promise = $client->putDataLakeSettingsAsync([/* ... */]);

Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.

This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.

Parameter Syntax

$result = $client->putDataLakeSettings([
    'CatalogId' => '<string>',
    'DataLakeSettings' => [ // REQUIRED
        'AllowExternalDataFiltering' => true || false,
        'AllowFullTableExternalDataAccess' => true || false,
        'AuthorizedSessionTagValueList' => ['<string>', ...],
        'CreateDatabaseDefaultPermissions' => [
            [
                'Permissions' => ['<string>', ...],
                'Principal' => [
                    'DataLakePrincipalIdentifier' => '<string>',
                ],
            ],
            // ...
        ],
        'CreateTableDefaultPermissions' => [
            [
                'Permissions' => ['<string>', ...],
                'Principal' => [
                    'DataLakePrincipalIdentifier' => '<string>',
                ],
            ],
            // ...
        ],
        'DataLakeAdmins' => [
            [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            // ...
        ],
        'ExternalDataFilteringAllowList' => [
            [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            // ...
        ],
        'Parameters' => ['<string>', ...],
        'ReadOnlyAdmins' => [
            [
                'DataLakePrincipalIdentifier' => '<string>',
            ],
            // ...
        ],
        'TrustedResourceOwners' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

RegisterResource

$result = $client->registerResource([/* ... */]);
$promise = $client->registerResourceAsync([/* ... */]);

Registers the resource as managed by the Data Catalog.

To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.

The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.

ResourceArn = arn:aws:s3:::my-bucket/ UseServiceLinkedRole = true

If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:

arn:aws:iam::12345:role/my-data-access-role

Parameter Syntax

$result = $client->registerResource([
    'HybridAccessEnabled' => true || false,
    'ResourceArn' => '<string>', // REQUIRED
    'RoleArn' => '<string>',
    'UseServiceLinkedRole' => true || false,
    'WithFederation' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AlreadyExistsException:

A resource to be created or added already exists.

EntityNotFoundException:

A specified entity does not exist.

ResourceNumberLimitExceededException:

A resource numerical limit was exceeded.

AccessDeniedException:

Access to a resource was denied.

RemoveLFTagsFromResource

$result = $client->removeLFTagsFromResource([/* ... */]);
$promise = $client->removeLFTagsFromResourceAsync([/* ... */]);

Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input.

Parameter Syntax

$result = $client->removeLFTagsFromResource([
    'CatalogId' => '<string>',
    'LFTags' => [ // REQUIRED
        [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Resource' => [ // REQUIRED
        'Catalog' => [
            'Id' => '<string>',
        ],
        'DataCellsFilter' => [
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'TableCatalogId' => '<string>',
            'TableName' => '<string>',
        ],
        'DataLocation' => [
            'CatalogId' => '<string>',
            'ResourceArn' => '<string>', // REQUIRED
        ],
        'Database' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTag' => [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        'LFTagExpression' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTagPolicy' => [
            'CatalogId' => '<string>',
            'Expression' => [
                [
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ExpressionName' => '<string>',
            'ResourceType' => 'DATABASE|TABLE', // REQUIRED
        ],
        'Table' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>',
            'TableWildcard' => [
            ],
        ],
        'TableWithColumns' => [
            'CatalogId' => '<string>',
            'ColumnNames' => ['<string>', ...],
            'ColumnWildcard' => [
                'ExcludedColumnNames' => ['<string>', ...],
            ],
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Failures' => [
        [
            'Error' => [
                'ErrorCode' => '<string>',
                'ErrorMessage' => '<string>',
            ],
            'LFTag' => [
                'CatalogId' => '<string>',
                'TagKey' => '<string>',
                'TagValues' => ['<string>', ...],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

GlueEncryptionException:

An encryption operation failed.

AccessDeniedException:

Access to a resource was denied.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

RevokePermissions

$result = $client->revokePermissions([/* ... */]);
$promise = $client->revokePermissionsAsync([/* ... */]);

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

Parameter Syntax

$result = $client->revokePermissions([
    'CatalogId' => '<string>',
    'Permissions' => ['<string>', ...], // REQUIRED
    'PermissionsWithGrantOption' => ['<string>', ...],
    'Principal' => [ // REQUIRED
        'DataLakePrincipalIdentifier' => '<string>',
    ],
    'Resource' => [ // REQUIRED
        'Catalog' => [
            'Id' => '<string>',
        ],
        'DataCellsFilter' => [
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'TableCatalogId' => '<string>',
            'TableName' => '<string>',
        ],
        'DataLocation' => [
            'CatalogId' => '<string>',
            'ResourceArn' => '<string>', // REQUIRED
        ],
        'Database' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTag' => [
            'CatalogId' => '<string>',
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        'LFTagExpression' => [
            'CatalogId' => '<string>',
            'Name' => '<string>', // REQUIRED
        ],
        'LFTagPolicy' => [
            'CatalogId' => '<string>',
            'Expression' => [
                [
                    'TagKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'ExpressionName' => '<string>',
            'ResourceType' => 'DATABASE|TABLE', // REQUIRED
        ],
        'Table' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>',
            'TableWildcard' => [
            ],
        ],
        'TableWithColumns' => [
            'CatalogId' => '<string>',
            'ColumnNames' => ['<string>', ...],
            'ColumnWildcard' => [
                'ExcludedColumnNames' => ['<string>', ...],
            ],
            'DatabaseName' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

SearchDatabasesByLFTags

$result = $client->searchDatabasesByLFTags([/* ... */]);
$promise = $client->searchDatabasesByLFTagsAsync([/* ... */]);

This operation allows a search on DATABASE resources by TagCondition. This operation is used by admins who want to grant user permissions on certain TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared.

Parameter Syntax

$result = $client->searchDatabasesByLFTags([
    'CatalogId' => '<string>',
    'Expression' => [ // REQUIRED
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DatabaseList' => [
        [
            'Database' => [
                'CatalogId' => '<string>',
                'Name' => '<string>',
            ],
            'LFTags' => [
                [
                    'CatalogId' => '<string>',
                    'TagKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

OperationTimeoutException:

The operation timed out.

GlueEncryptionException:

An encryption operation failed.

AccessDeniedException:

Access to a resource was denied.

SearchTablesByLFTags

$result = $client->searchTablesByLFTags([/* ... */]);
$promise = $client->searchTablesByLFTagsAsync([/* ... */]);

This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify whether the returned resources can be shared.

Parameter Syntax

$result = $client->searchTablesByLFTags([
    'CatalogId' => '<string>',
    'Expression' => [ // REQUIRED
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TableList' => [
        [
            'LFTagOnDatabase' => [
                [
                    'CatalogId' => '<string>',
                    'TagKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                // ...
            ],
            'LFTagsOnColumns' => [
                [
                    'LFTags' => [
                        [
                            'CatalogId' => '<string>',
                            'TagKey' => '<string>',
                            'TagValues' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'Name' => '<string>',
                ],
                // ...
            ],
            'LFTagsOnTable' => [
                [
                    'CatalogId' => '<string>',
                    'TagKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                // ...
            ],
            'Table' => [
                'CatalogId' => '<string>',
                'DatabaseName' => '<string>',
                'Name' => '<string>',
                'TableWildcard' => [
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

OperationTimeoutException:

The operation timed out.

GlueEncryptionException:

An encryption operation failed.

AccessDeniedException:

Access to a resource was denied.

StartQueryPlanning

$result = $client->startQueryPlanning([/* ... */]);
$promise = $client->startQueryPlanningAsync([/* ... */]);

Submits a request to process a query statement.

This operation generates work units that can be retrieved with the GetWorkUnits operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.

Parameter Syntax

$result = $client->startQueryPlanning([
    'QueryPlanningContext' => [ // REQUIRED
        'CatalogId' => '<string>',
        'DatabaseName' => '<string>', // REQUIRED
        'QueryAsOfTime' => <integer || string || DateTime>,
        'QueryParameters' => ['<string>', ...],
        'TransactionId' => '<string>',
    ],
    'QueryString' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'QueryId' => '<string>',
]

Result Details

Errors

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

AccessDeniedException:

Access to a resource was denied.

ThrottledException:

Contains details about an error where the query request was throttled.

StartTransaction

$result = $client->startTransaction([/* ... */]);
$promise = $client->startTransactionAsync([/* ... */]);

Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.

Parameter Syntax

$result = $client->startTransaction([
    'TransactionType' => 'READ_AND_WRITE|READ_ONLY',
]);

Parameter Details

Result Syntax

[
    'TransactionId' => '<string>',
]

Result Details

Errors

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

UpdateDataCellsFilter

$result = $client->updateDataCellsFilter([/* ... */]);
$promise = $client->updateDataCellsFilterAsync([/* ... */]);

Updates a data cell filter.

Parameter Syntax

$result = $client->updateDataCellsFilter([
    'TableData' => [ // REQUIRED
        'ColumnNames' => ['<string>', ...],
        'ColumnWildcard' => [
            'ExcludedColumnNames' => ['<string>', ...],
        ],
        'DatabaseName' => '<string>', // REQUIRED
        'Name' => '<string>', // REQUIRED
        'RowFilter' => [
            'AllRowsWildcard' => [
            ],
            'FilterExpression' => '<string>',
        ],
        'TableCatalogId' => '<string>', // REQUIRED
        'TableName' => '<string>', // REQUIRED
        'VersionId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

UpdateLFTag

$result = $client->updateLFTag([/* ... */]);
$promise = $client->updateLFTagAsync([/* ... */]);

Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.

Parameter Syntax

$result = $client->updateLFTag([
    'CatalogId' => '<string>',
    'TagKey' => '<string>', // REQUIRED
    'TagValuesToAdd' => ['<string>', ...],
    'TagValuesToDelete' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

AccessDeniedException:

Access to a resource was denied.

UpdateLFTagExpression

$result = $client->updateLFTagExpression([/* ... */]);
$promise = $client->updateLFTagExpressionAsync([/* ... */]);

Updates the name of the LF-Tag expression to the new description and expression body provided. Updating a LF-Tag expression immediately changes the permission boundaries of all existing LFTagPolicy permission grants that reference the given LF-Tag expression.

Parameter Syntax

$result = $client->updateLFTagExpression([
    'CatalogId' => '<string>',
    'Description' => '<string>',
    'Expression' => [ // REQUIRED
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValues' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

ResourceNumberLimitExceededException:

A resource numerical limit was exceeded.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

UpdateLakeFormationIdentityCenterConfiguration

$result = $client->updateLakeFormationIdentityCenterConfiguration([/* ... */]);
$promise = $client->updateLakeFormationIdentityCenterConfigurationAsync([/* ... */]);

Updates the IAM Identity Center connection parameters.

Parameter Syntax

$result = $client->updateLakeFormationIdentityCenterConfiguration([
    'ApplicationStatus' => 'ENABLED|DISABLED',
    'CatalogId' => '<string>',
    'ExternalFiltering' => [
        'AuthorizedTargets' => ['<string>', ...], // REQUIRED
        'Status' => 'ENABLED|DISABLED', // REQUIRED
    ],
    'ShareRecipients' => [
        [
            'DataLakePrincipalIdentifier' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

EntityNotFoundException:

A specified entity does not exist.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

AccessDeniedException:

Access to a resource was denied.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

UpdateResource

$result = $client->updateResource([/* ... */]);
$promise = $client->updateResourceAsync([/* ... */]);

Updates the data access role used for vending access to the given (registered) resource in Lake Formation.

Parameter Syntax

$result = $client->updateResource([
    'HybridAccessEnabled' => true || false,
    'ResourceArn' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'WithFederation' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input provided was not valid.

InternalServiceException:

An internal service error occurred.

OperationTimeoutException:

The operation timed out.

EntityNotFoundException:

A specified entity does not exist.

UpdateTableObjects

$result = $client->updateTableObjects([/* ... */]);
$promise = $client->updateTableObjectsAsync([/* ... */]);

Updates the manifest of Amazon S3 objects that make up the specified governed table.

Parameter Syntax

$result = $client->updateTableObjects([
    'CatalogId' => '<string>',
    'DatabaseName' => '<string>', // REQUIRED
    'TableName' => '<string>', // REQUIRED
    'TransactionId' => '<string>',
    'WriteOperations' => [ // REQUIRED
        [
            'AddObject' => [
                'ETag' => '<string>', // REQUIRED
                'PartitionValues' => ['<string>', ...],
                'Size' => <integer>, // REQUIRED
                'Uri' => '<string>', // REQUIRED
            ],
            'DeleteObject' => [
                'ETag' => '<string>',
                'PartitionValues' => ['<string>', ...],
                'Uri' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceException:

An internal service error occurred.

InvalidInputException:

The input provided was not valid.

OperationTimeoutException:

The operation timed out.

EntityNotFoundException:

A specified entity does not exist.

TransactionCommittedException:

Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.

TransactionCanceledException:

Contains details about an error related to a transaction that was cancelled.

TransactionCommitInProgressException:

Contains details about an error related to a transaction commit that was in progress.

ResourceNotReadyException:

Contains details about an error related to a resource which is not ready for a transaction.

ConcurrentModificationException:

Two processes are trying to modify a resource simultaneously.

UpdateTableStorageOptimizer

$result = $client->updateTableStorageOptimizer([/* ... */]);
$promise = $client->updateTableStorageOptimizerAsync([/* ... */]);

Updates the configuration of the storage optimizers for a table.

Parameter Syntax

$result = $client->updateTableStorageOptimizer([
    'CatalogId' => '<string>',
    'DatabaseName' => '<string>', // REQUIRED
    'StorageOptimizerConfig' => [ // REQUIRED
        '<OptimizerType>' => ['<string>', ...],
        // ...
    ],
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Result' => '<string>',
]

Result Details

Errors

EntityNotFoundException:

A specified entity does not exist.

InvalidInputException:

The input provided was not valid.

AccessDeniedException:

Access to a resource was denied.

InternalServiceException:

An internal service error occurred.