ワークグループの作成ワークグループの編集ワークグループの詳細の表示ワークグループの削除ワークグループを切り替えるワークグループの有効化および無効化クエリを実行するワークグループの指定

ワークグループの管理

https://console.aws.amazon.com/athena/ で、以下のタスクを実行できます。

Statement	説明
ワークグループの作成	新しいワークグループを作成します。
ワークグループの編集	ワークグループを編集して設定を変更します。ワークグループの名前を変更することはできませんが、同じ設定と別の名前で新しいワークグループを作成することはできます。
ワークグループの詳細の表示	名前、説明、データ使用量の制限、クエリ結果の場所、暗号化など、ワークグループの詳細を表示します。[Override client-side settings (クライアント側設定の上書き)] がオンになっている場合、このワークグループがその設定を強制しているかどうかも確認できます。
ワークグループの削除	ワークグループを削除します。ワークグループ、クエリ履歴、保存されたクエリを削除すると、ワークグループの設定とクエリごとのデータ制限コントロールが削除されます。ワークグループ全体のデータ制限コントロールは CloudWatch に保持され、個別に削除することができます。プライマリワークグループは削除できません。
ワークグループを切り替える	アクセス権があるワークグループを切り替えます。
ワークグループの有効化および無効化	ワークグループを有効または無効にします。ワークグループを無効にすると、そのユーザーはクエリを実行したり、新しい名前付きクエリを作成したりできません。アクセスできる場合でも、メトリクス、データ使用制限コントロール、ワークグループの設定、クエリ履歴、保存されたクエリを表示できます。
クエリを実行するワークグループの指定	クエリを実行する前に、使用するワークグループを Athena に指定する必要があります。ワークグループに対するアクセス権限が必要です。

ワークグループの作成

ワークグループを作成するには、CreateWorkgroup API アクションへのアクセス権限が必要です。Athena ワークグループへのアクセスおよびワークグループにアクセスするための IAM ポリシーを参照してください。タグを追加する場合は、TagResource にアクセス権限を追加する必要もあります。「ワークグループのタグポリシーの例」を参照してください。

コンソールでワークグループを作成するには

Athena コンソールで、[Workgroup (ワークグループ)<workgroup_name>] タブを選択します。[Workgroups (ワークグループ)] パネルが表示されます。
[Workgroups (ワークグループ)] パネルで、[Create workgroup (ワークグループの作成)] を選択します。

[Create workgroup (ワークグループの作成)] ダイアログボックスで、以下のようにフィールドに入力します。

フィールド	説明
ワークグループ名	必須。ワークグループの一意の名前を入力します。1～128 文字で入力してください。(A～Z、a～z、0～9、_、-、.)。この名前は変更できません。
説明	省略可能。ワークグループの説明を入力します。最大 1024 文字を含めることができます。
クエリ結果の場所	省略可能。Amazon S3 バケットまたはプレフィックスへのパスを入力します。このバケットとプレフィックスは、指定する前に存在している必要があります。注記コンソールでクエリを実行する場合、クエリ結果の場所の指定はオプションです。ワークグループまたは [Settings (設定)] で指定しない場合、Athena はデフォルトのクエリ結果の場所を使用します。API またはドライバーを使用してクエリを実行する場合、クエリ結果の場所を、 OutputLocation を使用した個々のクエリ、または WorkGroupConfiguration を使用したワークグループの 2 つの場所の少なくとも 1 つに指定する必要があります。
クエリ結果の暗号化	省略可能。Amazon S3 に保存されている結果を暗号化します。選択すると、ワークグループのすべてのクエリは暗号化されます。選択すると、[Encryption type (暗号化タイプ)]、[Encryption key (暗号化キー)] を選択して、[KMS Key ARN (KMS キー ARN)] を入力できます。キーがない場合は、AWS KMS コンソールを開いて作成します。詳細については、『https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html』の「AWS Key Management Service Developer Guideキーの作成」を参照してください。
クエリエンジンの更新	新しい Athena エンジンバージョンがリリースされたときにワークグループを更新する方法を選択します。にワークグループをいつ更新するかを決定させたり、エンジンのバージョンを手動で選択させることができます。Athena詳細については、「Athena エンジンバージョニング」を参照してください。
メトリクス	このフィールドは、デフォルトで選択されています。クエリメトリクスを CloudWatch に発行します。クエリメトリクスの表示を参照してください。
[Override client-side settings (クライアント側設定の上書き)]	このフィールドは、デフォルトでは選択されていません。選択すると、ワークグループ設定はワークグループのすべてのクエリに適用され、クライアント側の設定を上書きします。詳細については、「ワークグループ設定がクライアント側の設定を上書きする」を参照してください。
タグ	省略可能。ワークグループに 1 つ以上のタグを追加します。タグは、Athena ワークグループリソースに割り当てるラベルです。キーと値から構成されます。AWS タグ付け戦略のベストプラクティスを使用して、一貫性のあるタグのセットを作成し、目的、所有者、環境に基づいてワークグループを分類します。IAM ポリシーでタグを使用したり、課金コストを管理することもできます。同じワークグループに重複したタグキーを使用しないでください。詳細については、「リソースのタグ付け」を参照してください。
リクエスタ支払い S3 バケット	省略可能。ワークグループのユーザーがリクエスタ支払いとして設定されているバケットに保存されているデータに対してクエリを実行する場合は、[Enable queries on Requester Pays buckets in Amazon S3 (Amazon S3 でリクエスタ支払いバケットに対するクエリを有効にする)Amazon S3] を選択します。クエリを実行しているユーザーのアカウントには、クエリに関連付けられた該当するデータアクセスの料金とデータ転送料金が請求されます。詳細については、https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.htmlの「Amazon Simple Storage Service 開発者ガイドリクエスタ支払いバケット」を参照してください。

[Create workgroup (ワークグループの作成)] を選択します。ワークグループが [Workgroups (ワークグループ)] パネルのリストに表示されます。

または、API オペレーションを使用してワークグループを作成します。

重要

ワークグループを作成したら、ワークグループ関連のアクションを実行できるワークグループの IAM ポリシー IAM を作成します。

ワークグループの編集

ワークグループを編集するには、UpdateWorkgroup API オペレーションへのアクセス権限が必要です。Athena ワークグループへのアクセスおよびワークグループにアクセスするための IAM ポリシーを参照してください。タグを追加または編集している場合は、TagResource へのアクセス権限も必要です。「ワークグループのタグポリシーの例」を参照してください。

コンソールでワークグループを編集するには

Athena コンソールで、[Workgroup (ワークグループ)<workgroup_name>] タブを選択します。[Workgroups (ワークグループ)] パネルが表示され、アカウントのすべてのワークグループが一覧表示されます。
[Workgroups (ワークグループ)] パネルで、編集するワークグループを選択します。ワークグループの [View details (詳細の表示)] パネルが表示され、[Overview (概要)] タブが選択された状態になります。
[Edit workgroup (ワークグループの編集)] を選択します。
必要に応じて、フィールドの値を変更します。フィールドのリストについては、「ワークグループの作成」を参照してください。ワークグループの名前を除くすべてのフィールドを変更できます。名前を変更する必要がある場合は、新しい名前と同じ設定で別のワークグループを作成してください。
[Save] を選択します。更新されたワークグループが [Workgroups (ワークグループ)] パネルのリストに表示されます。

ワークグループの詳細の表示

各ワークグループの詳細を表示できます。詳細には、ワークグループの名前、説明、有効になっているか無効になっているか、ワークグループで実行されるクエリに使用される設定 (クエリ結果の場所や暗号化設定など) が含まれます。ワークグループにデータ使用量の制限がある場合は、それらも表示されます。

ワークグループの詳細を表示するには

[Workgroups (ワークグループ)] パネルで、編集するワークグループを選択します。ワークグループの [View details (詳細の表示)] パネルが表示され、[Overview (概要)] タブが選択された状態になります。次の例のように、ワークグループの詳細が表示されます。

ワークグループの削除

アクセス権限がある場合は、ワークグループを削除できます。プライマリワークグループは削除できません。

アクセス権限がある場合は、いつでも空のワークグループを削除できます。保存したクエリが含まれているワークグループを削除することもできます。この場合、ワークグループの削除に進む前に、Athena は保存されたクエリが削除されることを警告します。

ワークグループにいる間にワークグループを削除した場合、コンソールは焦点をプライマリワークグループに切り替えます。アクセスできる場合は、クエリを実行して設定を表示します。

ワークグループを削除すると、その設定とクエリごとのデータ制限コントロールは削除されます。ワークグループ全体のデータ制限コントロールは、CloudWatch に保持され、必要に応じて削除できます。

重要

ワークグループを削除する前に、そのユーザーが引き続きクエリを実行できる他のワークグループに属していることを確認してください。ユーザーの IAM ポリシーにより、このワークグループでのみクエリを実行できる場合、ワークグループを削除すると、ユーザーはクエリを実行するアクセス権限を失います。詳細については、「Example Policy for Running Queries in the Primary Workgroup」を参照してください。

コンソールでワークグループを削除するには

Athena コンソールで、[Workgroup (ワークグループ)<workgroup_name>] タブを選択します。[Workgroups (ワークグループ)] パネルが表示されます。
[Workgroups (ワークグループ)] パネルで、削除するワークグループを選択します。ワークグループの [View details (詳細の表示)] パネルが表示され、[Overview (概要)] タブが選択された状態になります。
[Delete workgroup (ワークグループの削除)] を選択して、削除を確認します。

API オペレーションでワークグループを削除するには、DeleteWorkGroup アクションを使用します。

ワークグループを切り替える

両方のワークグループにアクセス権限がある場合は、あるワークグループから別のワークグループに切り替えることができます。

各ワークグループで最大 10 個のクエリタブを開くことができます。ワークグループを切り替えると、クエリタブは最大 3 つのワークグループに対して開いたままになります。

ワークグループを切り替えるには

Athena コンソールで、[Workgroup (ワークグループ)<workgroup_name>] タブを選択します。[Workgroups (ワークグループ)] パネルが表示されます。
[Workgroups (ワークグループ)] パネルで、切り替えるワークグループを選択し、次に [Switch workgroup (ワークグループの切り替え)] を選択します。
[Switch (切り替え)] を選択します。コンソールには、切り替えたワークグループの名前の [Workgroup: (ワークグループ:)<workgroup_name>] タブが表示されます。これで、このワークグループでクエリを実行できます。

ワークグループの有効化および無効化

アクセス権限がある場合は、API オペレーションを使用するか、JDBC および ODBC ドライバーを使用して、コンソールでワークグループを有効化または無効化できます。

ワークグループを有効化または無効化するには

Athena コンソールで、[Workgroup (ワークグループ)<workgroup_name>] タブを選択します。[Workgroups (ワークグループ)] パネルが表示されます。
[Workgroups (ワークグループ)] パネルで、ワークグループを選択し、[Enable workgroup (ワークグループの有効化)] または [Disable workgroup (ワークグループの無効化)] を選択します。ワークグループを無効にすると、そのユーザーはその中でクエリを実行したり、新しい名前付きクエリを作成したりできません。ワークグループを有効にした場合、ユーザーはそれを使用してクエリを実行できます。

クエリを実行するワークグループの指定

クエリを実行する前に、使用するワークグループを Athena に指定する必要があります。ワークグループに対するアクセス権限が必要です。

ワークグループを Athena に指定するには

使用する予定のワークグループでクエリを実行できるアクセス権限であることを確認します。詳細については、「ワークグループにアクセスするための IAM ポリシー」を参照してください。
ワークグループを Athena に指定するには、次のいずれかのオプションを使用してください。
- コンソールを使用して Athena にアクセスしている場合は、ワークグループの切り替えでワークグループを設定します。
- Athena API オペレーションを使用している場合は、API アクションのワークグループ名を指定します。たとえば、次のように、StartQueryExecution でワークグループ名を設定できます。
```
StartQueryExecutionRequest startQueryExecutionRequest = new StartQueryExecutionRequest()
              .withQueryString(ExampleConstants.ATHENA_SAMPLE_QUERY)
              .withQueryExecutionContext(queryExecutionContext)
              .withWorkGroup(WorkgroupName)
```
- JDBC または ODBC ドライバーを使用している場合、Workgroup 設定パラメータを使用して接続文字列にワークグループ名を設定します。ドライバーはワークグループ名を Athena に渡します。次の例のように、接続文字列にワークグループパラメータを指定します。
```
jdbc:awsathena://AwsRegion=<AWSREGION>;UID=<ACCESSKEY>;
PWD=<SECRETKEY>;S3OutputLocation=s3://<athena-output>-<AWSREGION>/;
Workgroup=<WORKGROUPNAME>;
```
  詳細については、JDBC ドライバーのドキュメントに含まれているドライバーのドキュメントリンクで、「Workgroup」を検索してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

ワークグループ設定がクライアント側の設定を上書きする

Athena ワークグループ APIs