Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# を使用した Lake Formation の例 AWS CLI
次のコード例は、Lake Formation AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `add-lf-tags-to-resource`
次のコード例は、`add-lf-tags-to-resource` を使用する方法を示しています。
**AWS CLI**
**1 つまたは複数の LF タグを既存のリソースにアタッチするには**
次の `add-lf-tags-to-resource` の例では、特定の LF タグをテーブルリソースにアタッチします。
```
aws lakeformation add-lf-tags-to-resource \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_promotion"
}
},
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"analyst"
]
}]
}
```
出力:
```
{
"Failures": []
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Assigning LF-Tags to Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-assigning-tags.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddLfTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/add-lf-tags-to-resource.html)」を参照してください。
### `batch-grant-permissions`
次のコード例は、`batch-grant-permissions` を使用する方法を示しています。
**AWS CLI**
**リソースに対するアクセス許可をプリンシパルに一括で付与するには**
次の `batch-grant-permissions` の例では、指定されたリソースに対するアクセス許可をプリンシパルに一括で付与します。
```
aws lakeformation batch-grant-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Entries": [{
"Id": "1",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer"
},
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_promotion"
}
},
"Permissions": [
"ALL"
],
"PermissionsWithGrantOption": [
"ALL"
]
},
{
"Id": "2",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer"
},
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_customer"
}
},
"Permissions": [
"ALL"
],
"PermissionsWithGrantOption": [
"ALL"
]
},
{
"Id": "3",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-business-analyst"
},
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_promotion"
}
},
"Permissions": [
"ALL"
],
"PermissionsWithGrantOption": [
"ALL"
]
},
{
"Id": "4",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer"
},
"Resource": {
"DataCellsFilter": {
"TableCatalogId": "123456789111",
"DatabaseName": "tpc",
"TableName": "dl_tpc_item",
"Name": "developer_item"
}
},
"Permissions": [
"SELECT"
],
"PermissionsWithGrantOption": []
}
]
}
```
出力:
```
{
"Failures": []
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGrantPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/batch-grant-permissions.html)」を参照してください。
### `batch-revoke-permissions`
次のコード例は、`batch-revoke-permissions` を使用する方法を示しています。
**AWS CLI**
**リソースに対するアクセス許可をプリンシパルから一括で取り消すには**
次の `batch-revoke-permissions` の例では、指定されたリソースに対するアクセス許可をプリンシパルから一括で取り消します。
```
aws lakeformation batch-revoke-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Entries": [{
"Id": "1",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer"
},
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_promotion"
}
},
"Permissions": [
"ALL"
],
"PermissionsWithGrantOption": [
"ALL"
]
},
{
"Id": "2",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-business-analyst"
},
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_promotion"
}
},
"Permissions": [
"ALL"
],
"PermissionsWithGrantOption": [
"ALL"
]
}
]
}
```
出力:
```
{
"Failures": []
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchRevokePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/batch-revoke-permissions.html)」を参照してください。
### `cancel-transaction`
次のコード例は、`cancel-transaction` を使用する方法を示しています。
**AWS CLI**
**トランザクションをキャンセルするには**
次の `cancel-transaction` の例では、トランザクションをキャンセルします。
```
aws lakeformation cancel-transaction \
--transaction-id='b014d972ca8347b89825e33c5774aec4'
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/cancel-transaction.html)」を参照してください。
### `commit-transaction`
次のコード例は、`commit-transaction` を使用する方法を示しています。
**AWS CLI**
**トランザクションをコミットするには**
次の `commit-transaction` の例では、トランザクションをコミットします。
```
aws lakeformation commit-transaction \
--transaction-id='b014d972ca8347b89825e33c5774aec4'
```
出力:
```
{
"TransactionStatus": "committed"
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CommitTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/commit-transaction.html)」を参照してください。
### `create-data-cells-filter`
次のコード例は、`create-data-cells-filter` を使用する方法を示しています。
**AWS CLI**
**例 1: データセルフィルターを作成するには**
次の `create-data-cells-filter` の例では、データセルフィルターを作成し、行の条件に基づいて特定の列へのアクセス許可を付与できるようにします。
```
aws lakeformation create-data-cells-filter \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"TableData": {
"ColumnNames": ["p_channel_details", "p_start_date_sk", "p_promo_name"],
"DatabaseName": "tpc",
"Name": "developer_promotion",
"RowFilter": {
"FilterExpression": "p_promo_name='ese'"
},
"TableCatalogId": "123456789111",
"TableName": "dl_tpc_promotion"
}
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Data filtering and cell-level security in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html)」を参照してください。
**例 2: 列フィルターを作成するには**
次の `create-data-cells-filter` の例では、データフィルターを作成し、特定の列へのアクセス許可を付与できるようにします。
```
aws lakeformation create-data-cells-filter \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"TableData": {
"ColumnNames": ["p_channel_details", "p_start_date_sk", "p_promo_name"],
"DatabaseName": "tpc",
"Name": "developer_promotion_allrows",
"RowFilter": {
"AllRowsWildcard": {}
},
"TableCatalogId": "123456789111",
"TableName": "dl_tpc_promotion"
}
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Data filtering and cell-level security in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html)」を参照してください。
**例 3: 列を除外するデータフィルターを作成するには**
次の `create-data-cells-filter` の例では、データフィルターを作成し、指定された列を除くすべてへのアクセス許可を付与できるようにします。
```
aws lakeformation create-data-cells-filter \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"TableData": {
"ColumnWildcard": {
"ExcludedColumnNames": ["p_channel_details", "p_start_date_sk"]
},
"DatabaseName": "tpc",
"Name": "developer_promotion_excludecolumn",
"RowFilter": {
"AllRowsWildcard": {}
},
"TableCatalogId": "123456789111",
"TableName": "dl_tpc_promotion"
}
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Data filtering and cell-level security in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDataCellsFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/create-data-cells-filter.html)」を参照してください。
### `create-lf-tag`
次のコード例は、`create-lf-tag` を使用する方法を示しています。
**AWS CLI**
**LF タグを作成するには**
次の `create-lf-tag` の例では、指定された名前とキーを持つ LF タグを作成します。
```
aws lakeformation create-lf-tag \
--catalog-id '123456789111' \
--tag-key 'usergroup' \
--tag-values '["developer","analyst","campaign"]'
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Managing LF-Tags for metadata access control](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/create-lf-tag.html)」を参照してください。
### `delete-data-cells-filter`
次のコード例は、`delete-data-cells-filter` を使用する方法を示しています。
**AWS CLI**
**データセルフィルターを削除するには**
次の `delete-data-cells-filter` の例では、指定されたデータセルフィルターを削除します。
```
aws lakeformation delete-data-cells-filter \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"TableCatalogId": "123456789111",
"DatabaseName": "tpc",
"TableName": "dl_tpc_promotion",
"Name": "developer_promotion"
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Data filtering and cell-level security in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDataCellsFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/delete-data-cells-filter.html)」を参照してください。
### `delete-lf-tag`
次のコード例は、`delete-lf-tag` を使用する方法を示しています。
**AWS CLI**
**LF タグ定義を削除するには**
次の `delete-lf-tag` の例では、LF タグ定義を削除します。
```
aws lakeformation delete-lf-tag \
--catalog-id '123456789111' \
--tag-key 'usergroup'
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Managing LF-Tags for metadata access control](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/delete-lf-tag.html)」を参照してください。
### `delete-objects-on-cancel`
次のコード例は、`delete-objects-on-cancel` を使用する方法を示しています。
**AWS CLI**
**トランザクションがキャンセルされたときにオブジェクトを削除するには**
次の `delete-objects-on-cancel` の例では、トランザクションがキャンセルされたときに、一覧表示されている S3 オブジェクトを削除します。
```
aws lakeformation delete-objects-on-cancel \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "012345678901",
"DatabaseName": "tpc",
"TableName": "dl_tpc_household_demographics_gov",
"TransactionId": "1234d972ca8347b89825e33c5774aec4",
"Objects": [{
"Uri": "s3://lf-data-lake-012345678901/target/dl_tpc_household_demographics_gov/run-unnamed-1-part-block-0-r-00000-snappy-ff26b17504414fe88b302cd795eabd00.parquet",
"ETag": "1234ab1fc50a316b149b4e1f21a73800"
}]
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteObjectsOnCancel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/delete-objects-on-cancel.html)」を参照してください。
### `deregister-resource`
次のコード例は、`deregister-resource` を使用する方法を示しています。
**AWS CLI**
**データレイクストレージの登録を解除するには**
次の `deregister-resource` の例では、Lake Formation によって管理されるリソースの登録を解除します。
```
aws lakeformation deregister-resource \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"ResourceArn": "arn:aws:s3:::lf-emr-athena-result-123"
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Adding an Amazon S3 location to your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/register-data-lake.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/deregister-resource.html)」を参照してください。
### `describe-transaction`
次のコード例は、`describe-transaction` を使用する方法を示しています。
**AWS CLI**
**トランザクションの詳細を取得するには**
次の `describe-transaction` の例では、単一のトランザクションの詳細を返します。
```
aws lakeformation describe-transaction \
--transaction-id='8cb4b1a7cc8d486fbaca9a64e7d9f5ce'
```
出力:
```
{
"TransactionDescription": {
"TransactionId": "12345972ca8347b89825e33c5774aec4",
"TransactionStatus": "committed",
"TransactionStartTime": "2022-08-10T14:29:04.046000+00:00",
"TransactionEndTime": "2022-08-10T14:29:09.681000+00:00"
}
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/describe-transaction.html)」を参照してください。
### `extend-transaction`
次のコード例は、`extend-transaction` を使用する方法を示しています。
**AWS CLI**
**トランザクションを拡張するには**
次の `extend-transaction` の例では、トランザクションを拡張します。
```
aws lakeformation extend-transaction \
--transaction-id='8cb4b1a7cc8d486fbaca9a64e7d9f5ce'
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExtendTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/extend-transaction.html)」を参照してください。
### `get-data-lake-settings`
次の例は、`get-data-lake-settings` を使用する方法を説明しています。
**AWS CLI**
** AWS Lake Formation が管理するデータレイク設定を取得するには**
次の `get-data-lake-settings` の例では、データレイク管理者およびその他のデータレイク設定のリストを取得します。
```
aws lakeformation get-data-lake-settings \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111"
}
```
出力:
```
{
"DataLakeSettings": {
"DataLakeAdmins": [{
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin"
}],
"CreateDatabaseDefaultPermissions": [],
"CreateTableDefaultPermissions": [
{
"Principal": {
"DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS"
},
"Permissions": [
"ALL"
]
}
],
"TrustedResourceOwners": [],
"AllowExternalDataFiltering": true,
"ExternalDataFilteringAllowList": [{
"DataLakePrincipalIdentifier": "123456789111"
}],
"AuthorizedSessionTagValueList": [
"Amazon EMR"
]
}
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Changing the default security settings for your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDataLakeSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-data-lake-settings.html)」を参照してください。
### `get-effective-permissions-for-path`
次のコード例は、`get-effective-permissions-for-path` を使用する方法を示しています。
**AWS CLI**
**特定のパスにあるリソースに対するアクセス許可を取得するには**
次の `get-effective-permissions-for-path` の例では、Amazon S3 のパスにある指定されたテーブルまたはデータベースリソースに対する Lake Formation アクセス許可を返します。
```
aws lakeformation get-effective-permissions-for-path \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"ResourceArn": "arn:aws:s3:::lf-data-lake-123456789111"
}
```
出力:
```
{
"Permissions": [{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-campaign-manager"
},
"Resource": {
"Database": {
"Name": "tpc"
}
},
"Permissions": [
"DESCRIBE"
],
"PermissionsWithGrantOption": []
},
{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:role/EMR-RuntimeRole"
},
"Resource": {
"Database": {
"Name": "tpc"
}
},
"Permissions": [
"ALL"
],
"PermissionsWithGrantOption": []
},
{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:saml-provider/oktaSAMLProvider:user/emr-developer"
},
"Resource": {
"Database": {
"Name": "tpc"
}
},
"Permissions": [
"ALL",
"DESCRIBE"
],
"PermissionsWithGrantOption": []
},
{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin"
},
"Resource": {
"Database": {
"Name": "tpc"
}
},
"Permissions": [
"ALL",
"ALTER",
"CREATE_TABLE",
"DESCRIBE",
"DROP"
],
"PermissionsWithGrantOption": [
"ALL",
"ALTER",
"CREATE_TABLE",
"DESCRIBE",
"DROP"
]
},
{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:role/LF-GlueServiceRole"
},
"Resource": {
"Database": {
"Name": "tpc"
}
},
"Permissions": [
"CREATE_TABLE"
],
"PermissionsWithGrantOption": []
}
],
"NextToken": "E5SlJDSTZleUp6SWpvaU9UQTNORE0zTXpFeE5Ua3pJbjE5TENKbGVIQnBjbUYwYVc5dUlqcDdJbk5sWTI5dVpITWlPakUyTm=="
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Lake Formation アクセス許可の管理](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEffectivePermissionsForPath](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-effective-permissions-for-path.html)」を参照してください。
### `get-lf-tag`
次のコード例は、`get-lf-tag` を使用する方法を示しています。
**AWS CLI**
**LF タグ定義を取得するには**
次の `get-lf-tag` の例では、LF タグ定義を取得します。
```
aws lakeformation get-lf-tag \
--catalog-id '123456789111' \
--tag-key 'usergroup'
```
出力:
```
{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"analyst",
"campaign",
"developer"
]
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Managing LF-Tags for metadata access control](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-lf-tag.html)」を参照してください。
### `get-query-state`
次のコード例は、`get-query-state` を使用する方法を示しています。
**AWS CLI**
**送信されたクエリの状態を取得するには**
次の `get-query-state` の例では、以前に送信されたクエリの状態を返します。
```
aws lakeformation get-query-state \
--query-id='1234273f-4a62-4cda-8d98-69615ee8be9b'
```
出力:
```
{
"State": "FINISHED"
}
```
詳細については、「*AWS Developer Guide*」の「[Transactional data operations](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetQueryState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-query-state.html)」を参照してください。
### `get-query-statistics`
次のコード例は、`get-query-statistics` を使用する方法を示しています。
**AWS CLI**
**クエリ統計を取得するには**
次の `get-query-statistics` の例では、クエリの計画と実行に関する統計を取得します。
```
aws lakeformation get-query-statistics \
--query-id='1234273f-4a62-4cda-8d98-69615ee8be9b'
```
出力:
```
{
"ExecutionStatistics": {
"AverageExecutionTimeMillis": 0,
"DataScannedBytes": 0,
"WorkUnitsExecutedCount": 0
},
"PlanningStatistics": {
"EstimatedDataToScanBytes": 43235,
"PlanningTimeMillis": 2377,
"QueueTimeMillis": 440,
"WorkUnitsGeneratedCount": 1
},
"QuerySubmissionTime": "2022-08-11T02:14:38.641870+00:00"
}
```
詳細については、「*AWS Developer Guide*」の「[Transactional data operations](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetQueryStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-query-statistics.html)」を参照してください。
### `get-resource-lf-tags`
次のコード例は、`get-resource-lf-tags` を使用する方法を示しています。
**AWS CLI**
**LF タグを一覧表示するには**
次の `list-lf-tags` の例では、リクエストしたユーザーが閲覧アクセス許可を持っている LF タグのリストを返します。
```
aws lakeformation list-lf-tags \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"ResourceShareType": "ALL",
"MaxResults": 2
}
```
出力:
```
{
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "category",
"TagValues": [
"private",
"public"
]
},
{
"CatalogId": "123456789111",
"TagKey": "group",
"TagValues": [
"analyst",
"campaign",
"developer"
]
}],
"NextToken": "kIiwiZXhwaXJhdGlvbiI6eyJzZWNvbmRzIjoxNjYwMDY4dCI6ZmFsc2V9"
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Managing LF-Tags for metadata access control](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResourceLfTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-resource-lf-tags.html)」を参照してください。
### `get-table-objects`
次のコード例は、`get-table-objects` を使用する方法を示しています。
**AWS CLI**
**管理対象テーブルのオブジェクトを一覧表示するには**
次の `get-table-objects` の例では、指定された管理対象テーブルを構成する Amazon S3 オブジェクトのセットを返します。
```
aws lakeformation get-table-objects \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "012345678901",
"DatabaseName": "tpc",
"TableName": "dl_tpc_household_demographics_gov",
"QueryAsOfTime": "2022-08-10T15:00:00"
}
```
出力:
```
{
"Objects": [{
"PartitionValues": [],
"Objects": [{
"Uri": "s3://lf-data-lake-012345678901/target/dl_tpc_household_demographics_gov/run-unnamed-1-part-block-0-r-00000-snappy-ff26b17504414fe88b302cd795eabd00.parquet",
"ETag": "12345b1fc50a316b149b4e1f21a73800",
"Size": 43235
}]
}]
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTableObjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-table-objects.html)」を参照してください。
### `get-work-unit-results`
次のコード例は、`get-work-unit-results` を使用する方法を示しています。
**AWS CLI**
**特定のクエリの作業単位を取得するには**
次の `get-work-unit-results` の例では、クエリから得られた作業単位を返します。
```
aws lakeformation get-work-units \
--query-id='1234273f-4a62-4cda-8d98-69615ee8be9b' \
--work-unit-id '0' \
--work-unit-token 'B2fMSdmQXe9umX8Ux8XCo4=' outfile
```
出力:
```
outfile with Blob content.
```
詳細については、「*AWS Developer Guide*」の「[Transactional data operations](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWorkUnitResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-work-unit-results.html)」を参照してください。
### `get-work-units`
次のコード例は、`get-work-units` を使用する方法を示しています。
**AWS CLI**
**作業単位を取得するには**
次の `get-work-units` の例では、StartQueryPlanning オペレーションによって生成された作業単位を取得します。
```
aws lakeformation get-work-units \
--query-id='1234273f-4a62-4cda-8d98-69615ee8be9b'
```
出力:
```
{
"WorkUnitRanges": [{
"WorkUnitIdMax": 0,
"WorkUnitIdMin": 0,
"WorkUnitToken": "1234eMAk4kLO4umqEL4Z5WuxL04AXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREEwYm9QbkhINmFYTWphbmMxZW1PQmEyMGlUb0JFbXNlWmRYc0NmckRIR1dmQ0hjY2YzNFdMcmNXb2JGZmhEK0QvZz09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLWVhc3QtMTo3MDkxNTAyNDkyNDk6a2V5L2VmYmI3NDUyLTY1MjYtNGJiOS1iNmZhLTEzYzJkMTM3MmU2OQC4AQIBAHg6eWNF2ZrQATTAuPDJVCEAQSyIF67vX+f88jzGrYq22gE6jkQlpOB+Oet2eqNUmFudAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMCOEWRdafowek3RUmAgEQgDsYZZE84nnnbNmvsqCBPLh19nLQ10mUWOg9IfiaOwefEn6L920V0x1LpJACo7MtIBLXnbGcz2dFDZjFygIAAAAADAAAEAAAAAAAAAAAAAAAAAAQSQf8XDSI5pvR4Fx4JsrS/////wAAAAEAAAAAAAAAAAAAAAEAAACX3/w5h75QAPomfKH+cyEKYU1yccUmBl+VSojiGOtdsUk7vcjYXUUboYm3dvqRqX2s4gROMOn+Ij8R0/8jYmnHkpvyAFNVRPyETyIKg7k5Z9+5I1c2d3446Jw/moWGGxjH8AEG9h27ytmOhozxDOEi/F2ZoXz6wlGDfGUo/2WxCkYOhTyNaw6TM+7drTM7yrW4iNVLUM0LX0xnFjIAhLhooWJek6vjQZUAZzBlAjBH8okRtYP8R7AY2Wls/hqFBhG0V4l42AC0LxsuZbMQrE2SzWZUZ0E9Uew7/n0cyX4CMQDR79INyv4ysMByW9kKGGKyba+cCNklExMR+btBQBmMuB2fMSdmQXe9umX8Ux8XCo4="
}],
"QueryId": "1234273f-4a62-4cda-8d98-69615ee8be9b"
}
```
詳細については、「*AWS Developer Guide*」の「[Transactional data operations](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWorkUnits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-work-units.html)」を参照してください。
### `grant-permissions`
次のコード例は、`grant-permissions` を使用する方法を示しています。
**AWS CLI**
**例 1: LF タグを使用してリソースに対するアクセス許可をプリンシパルに付与するには**
次の `grant-permissions` の例では、LF タグポリシーに一致するデータベースリソースに対する ALL アクセス許可をプリンシパルに付与します。
```
aws lakeformation grant-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin"
},
"Resource": {
"LFTagPolicy": {
"CatalogId": "123456789111",
"ResourceType": "DATABASE",
"Expression": [{
"TagKey": "usergroup",
"TagValues": [
"analyst",
"developer"
]
}]
}
},
"Permissions": [
"ALL"
],
"PermissionsWithGrantOption": [
"ALL"
]
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。
**例 2: 列レベルのアクセス許可をプリンシパルに付与するには**
次の `grant-permissions` の例では、特定の列を選択するアクセス許可をプリンシパルに付与します。
```
aws lakeformation grant-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer"
},
"Resource": {
"TableWithColumns": {
"CatalogId": "123456789111",
"ColumnNames": ["p_end_date_sk"],
"DatabaseName": "tpc",
"Name": "dl_tpc_promotion"
}
},
"Permissions": [
"SELECT"
],
"PermissionsWithGrantOption": []
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。
**例 3: テーブルのアクセス許可をプリンシパルに付与するには**
次の `grant-permissions` の例では、特定のデータベースのすべてのテーブルに対する選択アクセス許可をプリンシパルに付与します。
```
aws lakeformation grant-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer"
},
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"TableWildcard": {}
}
},
"Permissions": [
"SELECT"
],
"PermissionsWithGrantOption": []
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。
**例 4: LF タグに対するアクセス許可をプリンシパルに付与するには**
次の `grant-permissions` の例では、LF タグに対する関連付けアクセス許可をプリンシパルに付与します。
```
aws lakeformation grant-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer"
},
"Resource": {
"LFTag": {
"CatalogId": "123456789111",
"TagKey": "category",
"TagValues": [
"private", "public"
]
}
},
"Permissions": [
"ASSOCIATE"
],
"PermissionsWithGrantOption": []
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。
**例 5: データロケーションに対するアクセス許可をプリンシパルに付与するには**
次の `grant-permissions` の例では、データロケーションに対するアクセス許可をプリンシパルに付与します。
```
aws lakeformation grant-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer"
},
"Resource": {
"DataLocation": {
"CatalogId": "123456789111",
"ResourceArn": "arn:aws:s3:::lf-data-lake-123456789111"
}
},
"Permissions": [
"DATA_LOCATION_ACCESS"
],
"PermissionsWithGrantOption": []
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GrantPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/grant-permissions.html)」を参照してください。
### `list-data-cells-filter`
次のコード例は、`list-data-cells-filter` を使用する方法を示しています。
**AWS CLI**
**データセルフィルターを一覧表示するには**
次の `list-data-cells-filter` の例では、特定のテーブルのデータセルフィルターを一覧表示します。
```
aws lakeformation list-data-cells-filter \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"MaxResults": 2,
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_promotion"
}
}
```
出力:
```
{
"DataCellsFilters": [{
"TableCatalogId": "123456789111",
"DatabaseName": "tpc",
"TableName": "dl_tpc_promotion",
"Name": "developer_promotion",
"RowFilter": {
"FilterExpression": "p_promo_name='ese'"
},
"ColumnNames": [
"p_channel_details",
"p_start_date_sk",
"p_purpose",
"p_promo_id",
"p_promo_name",
"p_end_date_sk",
"p_discount_active"
]
},
{
"TableCatalogId": "123456789111",
"DatabaseName": "tpc",
"TableName": "dl_tpc_promotion",
"Name": "developer_promotion_allrows",
"RowFilter": {
"FilterExpression": "TRUE",
"AllRowsWildcard": {}
},
"ColumnNames": [
"p_channel_details",
"p_start_date_sk",
"p_promo_name"
]
}
],
"NextToken": "2MDA2MTgwNiwibmFub3MiOjE0MDAwMDAwMH19"
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Data filtering and cell-level security in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDataCellsFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-data-cells-filter.html)」を参照してください。
### `list-permissions`
次のコード例は、`list-permissions` を使用する方法を示しています。
**AWS CLI**
**例 1: リソースに対するプリンシパルアクセス許可のリストを取得するには**
次の `list-permissions` の例では、データベースリソースに対するプリンシパルアクセス許可のリストを返します。
```
aws lakeformation list-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"ResourceType": "DATABASE",
"MaxResults": 2
}
```
出力:
```
{
"PrincipalResourcePermissions": [{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-campaign-manager"
},
"Resource": {
"Database": {
"CatalogId": "123456789111",
"Name": "tpc"
}
},
"Permissions": [
"DESCRIBE"
],
"PermissionsWithGrantOption": []
}],
"NextToken": "E5SlJDSTZleUp6SWpvaU9UQTNORE0zTXpFeE5Ua3pJbjE5TENKbGVIQnBjbUYwYVc5dUlqcDdJbk5sWTI5dVpITWlPakUyTm"
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Lake Formation アクセス許可の管理](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html)」を参照してください。
**例 2: データフィルターを使用してテーブルに対するプリンシパルアクセス許可のリストを取得するには**
次の `list-permissions` の例では、プリンシパルに付与された関連するデータフィルターを使用して、テーブルに対するアクセス許可を一覧表示します。
```
aws lakeformation list-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_customer"
}
},
"IncludeRelated": "TRUE",
"MaxResults": 10
}
```
出力:
```
{
"PrincipalResourcePermissions": [{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:role/Admin"
},
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "customer",
"Name": "customer_invoice"
}
},
"Permissions": [
"ALL",
"ALTER",
"DELETE",
"DESCRIBE",
"DROP",
"INSERT"
],
"PermissionsWithGrantOption": [
"ALL",
"ALTER",
"DELETE",
"DESCRIBE",
"DROP",
"INSERT"
]
},
{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:role/Admin"
},
"Resource": {
"TableWithColumns": {
"CatalogId": "123456789111",
"DatabaseName": "customer",
"Name": "customer_invoice",
"ColumnWildcard": {}
}
},
"Permissions": [
"SELECT"
],
"PermissionsWithGrantOption": [
"SELECT"
]
},
{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:role/Admin"
},
"Resource": {
"DataCellsFilter": {
"TableCatalogId": "123456789111",
"DatabaseName": "customer",
"TableName": "customer_invoice",
"Name": "dl_us_customer"
}
},
"Permissions": [
"DESCRIBE",
"SELECT",
"DROP"
],
"PermissionsWithGrantOption": []
}
],
"NextToken": "VyeUFjY291bnRQZXJtaXNzaW9ucyI6ZmFsc2V9"
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Lake Formation アクセス許可の管理](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html)」を参照してください。
**例 3: LF タグに対するプリンシパルアクセス許可のリストを取得するには**
次の `list-permissions` の例では、プリンシパルに付与された LF タグに対するアクセス許可を一覧表示します。
```
aws lakeformation list-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Resource": {
"LFTag": {
"CatalogId": "123456789111",
"TagKey": "category",
"TagValues": [
"private"
]
}
},
"MaxResults": 10
}
```
出力:
```
{
"PrincipalResourcePermissions": [{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin"
},
"Resource": {
"LFTag": {
"CatalogId": "123456789111",
"TagKey": "category",
"TagValues": [
"*"
]
}
},
"Permissions": [
"DESCRIBE"
],
"PermissionsWithGrantOption": [
"DESCRIBE"
]
},
{
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin"
},
"Resource": {
"LFTag": {
"CatalogId": "123456789111",
"TagKey": "category",
"TagValues": [
"*"
]
}
},
"Permissions": [
"ASSOCIATE"
],
"PermissionsWithGrantOption": [
"ASSOCIATE"
]
}
],
"NextToken": "EJwY21GMGFXOXVJanA3SW5Ocm1pc3Npb25zIjpmYWxzZX0="
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Lake Formation アクセス許可の管理](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-permissions.html)」を参照してください。
### `list-resources`
次のコード例は、`list-resources` を使用する方法を示しています。
**AWS CLI**
**Lake Formation によって管理されるリソースを一覧表示するには**
次の `list-resources` の例では、Lake Formation によって管理される条件に一致するリソースを一覧表示します。
```
aws lakeformation list-resources \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"FilterConditionList": [{
"Field": "ROLE_ARN",
"ComparisonOperator": "CONTAINS",
"StringValueList": [
"123456789111"
]
}],
"MaxResults": 10
}
```
出力:
```
{
"ResourceInfoList": [{
"ResourceArn": "arn:aws:s3:::lf-data-lake-123456789111",
"RoleArn": "arn:aws:iam::123456789111:role/LF-GlueServiceRole",
"LastModified": "2022-07-21T02:12:46.669000+00:00"
},
{
"ResourceArn": "arn:aws:s3:::lf-emr-test-123456789111",
"RoleArn": "arn:aws:iam::123456789111:role/EMRLFS3Role",
"LastModified": "2022-07-29T16:22:03.211000+00:00"
}
]
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Lake Formation アクセス許可の管理](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-resources.html)」を参照してください。
### `list-transactions`
次のコード例は、`list-transactions` を使用する方法を示しています。
**AWS CLI**
**すべてのトランザクションの詳細を一覧表示するには**
次の `list-transactions` の例では、トランザクションとそのステータスに関するメタデータを返します。
```
aws lakeformation list-transactions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"StatusFilter": "ALL",
"MaxResults": 3
}
```
出力:
```
{
"Transactions": [{
"TransactionId": "1234569f08804cb790d950d4d0fe485e",
"TransactionStatus": "committed",
"TransactionStartTime": "2022-08-10T14:32:29.220000+00:00",
"TransactionEndTime": "2022-08-10T14:32:33.751000+00:00"
},
{
"TransactionId": "12345972ca8347b89825e33c5774aec4",
"TransactionStatus": "committed",
"TransactionStartTime": "2022-08-10T14:29:04.046000+00:00",
"TransactionEndTime": "2022-08-10T14:29:09.681000+00:00"
},
{
"TransactionId": "12345daf6cb047dbba8ad9b0414613b2",
"TransactionStatus": "committed",
"TransactionStartTime": "2022-08-10T13:56:51.261000+00:00",
"TransactionEndTime": "2022-08-10T13:56:51.547000+00:00"
}
],
"NextToken": "77X1ebypsI7os+X2lhHsZLGNCDK3nNGpwRdFpicSOHgcX1/QMoniUAKcpR3kj3ts3PVdMA=="
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTransactions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-transactions.html)」を参照してください。
### `put-data-lake-settings`
次の例は、`put-data-lake-settings` を使用する方法を説明しています。
**AWS CLI**
** AWS Lake Formation が管理するデータレイクの設定を行うには**
次の `put-data-lake-settings` の例では、データレイク管理者およびその他のデータレイク設定のリストを設定します。
```
aws lakeformation put-data-lake-settings \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"DataLakeSettings": {
"DataLakeAdmins": [{
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin"
}
],
"CreateDatabaseDefaultPermissions": [],
"CreateTableDefaultPermissions": [],
"TrustedResourceOwners": [],
"AllowExternalDataFiltering": true,
"ExternalDataFilteringAllowList": [{
"DataLakePrincipalIdentifier ": "123456789111"
}],
"AuthorizedSessionTagValueList": ["Amazon EMR"]
}
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Changing the default security settings for your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutDataLakeSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/put-data-lake-settings.html)」を参照してください。
### `register-resource`
次のコード例は、`register-resource` を使用する方法を示しています。
**AWS CLI**
**例 1: サービスリンクロールを使用してデータレイクストレージを登録するには**
次の `register-resource` の例では、サービスリンクロールを使用して Lake Formation によって管理されるリソースを登録します。
```
aws lakeformation register-resource \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"ResourceArn": "arn:aws:s3:::lf-emr-athena-result-123",
"UseServiceLinkedRole": true
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Adding an Amazon S3 location to your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/register-data-lake.html)」を参照してください。
**例 2: カスタムロールを使用してデータレイクストレージを登録するには**
次の `register-resource` の例では、カスタムロールを使用して Lake Formation によって管理されるリソースを登録します。
```
aws lakeformation register-resource \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"ResourceArn": "arn:aws:s3:::lf-emr-athena-result-123",
"UseServiceLinkedRole": false,
"RoleArn": "arn:aws:iam::123456789111:role/LF-GlueServiceRole"
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Adding an Amazon S3 location to your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/register-data-lake.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/register-resource.html)」を参照してください。
### `remove-lf-tags-from-resource`
次のコード例は、`remove-lf-tags-from-resource` を使用する方法を示しています。
**AWS CLI**
**リソースから LF タグを削除するには**
次の `remove-lf-tags-from-resource` の例では、LF タグとテーブルリソースとの関連付けを削除します。
```
aws lakeformation remove-lf-tags-from-resource \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_promotion"
}
},
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
}
```
出力:
```
{
"Failures": []
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Assigning LF-Tags to Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-assigning-tags.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveLfTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/remove-lf-tags-from-resource.html)」を参照してください。
### `revoke-permissions`
次のコード例は、`revoke-permissions` を使用する方法を示しています。
**AWS CLI**
**リソースに対するアクセス許可をプリンシパルから取り消すには**
次の `revoke-permissions` の例では、指定されたデータベースの特定のテーブルへのプリンシパルアクセス許可を取り消します。
```
aws lakeformation revoke-permissions \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "123456789111",
"Principal": {
"DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer"
},
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_promotion"
}
},
"Permissions": [
"ALL"
],
"PermissionsWithGrantOption": []
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RevokePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/revoke-permissions.html)」を参照してください。
### `search-databases-by-lf-tags`
次のコード例は、`search-databases-by-lf-tags` を使用する方法を示しています。
**AWS CLI**
**LFTags でデータベースリソースの検索を行うには**
次の `search-databases-by-lf-tags` の例では、LFTag 式に一致するデータベースリソースの検索を行います。
```
aws lakeformation search-databases-by-lf-tags \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"MaxResults": 1,
"CatalogId": "123456789111",
"Expression": [{
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
}
```
出力:
```
{
"DatabaseList": [{
"Database": {
"CatalogId": "123456789111",
"Name": "tpc"
},
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
}]
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Viewing the resources that a LF-Tag is assigned to](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-view-tag-resources.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchDatabasesByLfTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/search-databases-by-lf-tags.html)」を参照してください。
### `search-tables-by-lf-tags`
次のコード例は、`search-tables-by-lf-tags` を使用する方法を示しています。
**AWS CLI**
**LFTags でテーブルリソースの検索を行うには**
次の `search-tables-by-lf-tags` の例では、LFTag 式に一致するテーブルリソースの検索を行います。
```
aws lakeformation search-tables-by-lf-tags \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"MaxResults": 2,
"CatalogId": "123456789111",
"Expression": [{
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
}
```
出力:
```
{
"NextToken": "c2VhcmNoQWxsVGFnc0luVGFibGVzIjpmYWxzZX0=",
"TableList": [{
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_item"
},
"LFTagOnDatabase": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}],
"LFTagsOnTable": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}],
"LFTagsOnColumns": [{
"Name": "i_item_desc",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_container",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_wholesale_cost",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_manufact_id",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_brand_id",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_formulation",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_current_price",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_size",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_rec_start_date",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_manufact",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_item_sk",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_manager_id",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_item_id",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_class_id",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_class",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_category",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_category_id",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_brand",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_units",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_rec_end_date",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_color",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
},
{
"Name": "i_product_name",
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
}
]
}]
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Viewing the resources that a LF-Tag is assigned to](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-view-tag-resources.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchTablesByLfTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/search-tables-by-lf-tags.html)」を参照してください。
### `start-query-planning`
次のコード例は、`start-query-planning` を使用する方法を示しています。
**AWS CLI**
**クエリステートメントを処理するには**
次の `start-query-planning` の例では、クエリステートメントを処理するリクエストを送信します。
```
aws lakeformation start-query-planning \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"QueryPlanningContext": {
"CatalogId": "012345678901",
"DatabaseName": "tpc"
},
"QueryString": "select * from dl_tpc_household_demographics_gov where hd_income_band_sk=9"
}
```
出力:
```
{
"QueryId": "772a273f-4a62-4cda-8d98-69615ee8be9b"
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartQueryPlanning](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/start-query-planning.html)」を参照してください。
### `start-transaction`
次のコード例は、`start-transaction` を使用する方法を示しています。
**AWS CLI**
**新しいトランザクションを開始するには**
次の `start-transaction` の例では、新しいトランザクションを開始し、そのトランザクション ID を返します。
```
aws lakeformation start-transaction \
--transaction-type = 'READ_AND_WRITE'
```
出力:
```
{
"TransactionId": "b014d972ca8347b89825e33c5774aec4"
}
```
詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/start-transaction.html)」を参照してください。
### `update-lf-tag`
次のコード例は、`update-lf-tag` を使用する方法を示しています。
**AWS CLI**
**LF タグ定義を更新するには**
次の `update-lf-tag` の例では、LF タグ定義を更新します。
```
aws lakeformation update-lf-tag \
--catalog-id '123456789111' \
--tag-key 'usergroup' \
--tag-values-to-add '["admin"]'
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Managing LF-Tags for metadata access control](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/update-lf-tag.html)」を参照してください。
### `update-table-objects`
次のコード例は、`update-table-objects` を使用する方法を示しています。
**AWS CLI**
**管理対象テーブルのオブジェクトを変更するには**
次の `update-table-objects` の例では、指定された管理対象テーブルに、提供された S3 オブジェクトを追加します。
```
aws lakeformation update-table-objects \
--cli-input-json file://input.json
```
`input.json` の内容:
```
{
"CatalogId": "012345678901",
"DatabaseName": "tpc",
"TableName": "dl_tpc_household_demographics_gov",
"TransactionId": "12347a9f75424b9b915f6ff201d2a190",
"WriteOperations": [{
"AddObject": {
"Uri": "s3://lf-data-lake-012345678901/target/dl_tpc_household_demographics_gov/run-unnamed-1-part-block-0-r-00000-snappy-ff26b17504414fe88b302cd795eabd00.parquet",
"ETag": "1234ab1fc50a316b149b4e1f21a73800",
"Size": 42200
}
}]
}
```
このコマンドは何も出力しません。
詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateTableObjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/update-table-objects.html)」を参照してください。