AWS サービスの API キー
AWS CLI または AWS API を使用して、AWS マネジメントコンソール を通じてプログラムで AWS サービスにアクセスできます。Amazon Bedrock や Amazon CloudWatch Logs などのサービスに対してプログラムによるリクエストを行う場合は、IAM 認証情報 (一時的なセキュリティ認証情報や長期アクセスキーなど) または API キーを使用して認証できます。API キーには 2 つのタイプがあります。
-
長期 API キー – 長期 API キーは IAM ユーザーに関連付けられ、IAM サービス固有の認証情報を使用して生成されます。これらの認証情報は 単一の AWS サービスでのみ使用するように設計されており、認証情報の適用範囲を制限することでセキュリティを強化しています。長期 API キーの有効期限を設定できます。IAM またはサービス固有のコンソール (Amazon Bedrock または CloudWatch Logs コンソールなど)、AWS CLI、または AWS API を使用して、長期的な API キーを生成できます。
-
短期 API キー (Amazon Bedrock のみでサポート) – 短期 API キーは、AWS 署名バージョン 4 を使用する署名付き URL です。短期 API キーは、API キーを生成する ID の認証情報と同じアクセス許可と有効期限を共有し、最大 12 時間またはコンソールセッションの残り時間の短い方の時間まで有効です。Amazon Bedrock コンソール、Python パッケージ
aws-bedrock-token-generator、および他のプログラミング言語用のパッケージを使用して、短期 API キーを生成できます。詳細については、「Amazon Bedrock ユーザーガイド」の「Generate Amazon Bedrock API keys for easy access to the Amazon Bedrock API」を参照してください。
注記
長期 API キーは、短期 API キーと比較してセキュリティリスクが高くなります。可能であれば、短期 API キーまたは一時的なセキュリティ認証情報を使用することをお勧めします。長期 API キーを使用する場合は、定期的なキーローテーションプラクティスを実施することをお勧めします。
サポートされるサービス
次の表に、API キーをサポートする AWS サービスと、各サービスがサポートする API キーのタイプを示します。
| # | サービス | 長期 API キー | 短期 API キー | 管理ポリシーの自動アタッチ |
|---|---|---|---|---|
| 1 | Amazon Bedrock | はい | はい | AmazonBedrockLimitedAccess |
| 2 | Amazon CloudWatch Logs | はい | 該当なし | CloudWatchLogsAPIKeyAccess |
サービスの長期 API キーを生成すると、対応する AWS マネージドポリシーが IAM ユーザーに自動的にアタッチされ、そのサービスのコアオペレーションへのアクセスが許可されます。追加のアクセスが必要な場合は、IAM ユーザーのアクセス許可を変更できます。許可の変更については、「IAM ID のアクセス許可の追加および削除」を参照してください。Amazon Bedrock キーの使用方法の詳細については、「Amazon Bedrock ユーザーガイド」の「Amazon Bedrock API キーを使用する」を参照してください。Amazon CloudWatch Logs にベアラートークンを使用する方法の詳細については、「CloudWatch Logs ユーザーガイド」の「ベアラートークン認証」を参照してください。
長期 API キーの前提条件
IAM コンソールで長期 API キーを生成する前に、次の前提条件を満たす必要があります。
-
長期 API キーに関連付ける IAM ユーザー。IAM ユーザーの作成手順については、「AWS アカウント で IAM ユーザーを作成する」を参照してください。
-
IAM ユーザーのサービス固有の認証情報を管理するには、次の IAM ポリシーのアクセス許可がなければなりません。このポリシー例では、サービス固有の認証情報を作成、一覧表示、更新、削除、およびリセットするアクセス許可を付与します。Resource 要素の
値を、長期 API キーを生成する IAM ユーザーの名前に置き換えます。username
長期 API キーの生成 (コンソール)
IAM コンソールで特定のサービスの長期 API キーを生成するには
AWS マネジメントコンソール にサインインして、IAM コンソール https://console.aws.amazon.com/iam/
を開きます。 -
IAM コンソールのナビゲーションペインで [ユーザー] を選択します。
-
長期 API キーを生成する IAM ユーザーを選択します。
-
[Security credentials]タブを選択します。
-
[API キー] セクションで、[API キーを生成] を選択します。
-
[AWS サービス] ドロップダウンリストから、API キーを認証するサービスを選択します。
-
API キーの有効期限について、以下のいずれかを実行します。
-
API キーの有効期限として 1、5、30、90、または 365 日を選択します。
-
カスタム期間を選択して、カスタム API キーの有効期限を指定します。
-
[有効期限なし] (推奨されません) を選択します。
-
-
[API キーの生成] を選択します。
-
API キーをコピーまたはダウンロードします。API キー値を表示できるのは今回だけです。
重要
API キーを安全に保存してください。ダイアログボックスを閉じた後は、API キーを再度取得することはできません。API キーがわからない場合または忘れた場合、取得することはできません。代わりに、新しい API キーを生成し、古いキーを非アクティブにします。
長期 API キーの生成 (AWS CLI)
AWS CLI を使用して長期 API キーを生成するには、次の手順を実行します。
-
create-user
コマンドを使用して、Amazon Bedrock または Amazon CloudWatch Logs を使用するために必要な IAM ユーザーを作成します。 aws iam create-user \ --user-nameAPIKeyUser_1 -
attach-user-policy
コマンドを使用して、AWS マネージドポリシーを IAM ユーザーにアタッチします。 Amazon Bedrock の場合:
aws iam attach-user-policy --user-nameAPIKeyUser_1\ --policy-arn arn:aws:iam::aws:policy/AmazonBedrockLimitedAccessAmazon CloudWatch Logs の場合:
aws iam attach-user-policy --user-nameAPIKeyUser_1\ --policy-arn arn:aws:iam::aws:policy/CloudWatchLogsAPIKeyAccess -
create-service-specific-credential
コマンドを使用して、長期 API キーを生成します。 Amazon Bedrock の場合:
aws iam create-service-specific-credential \ --user-nameAPIKeyUser_1\ --service-name bedrock.amazonaws.com \ --credential-age-days30Amazon CloudWatch Logs の場合:
aws iam create-service-specific-credential \ --user-nameAPIKeyUser_1\ --service-name logs.amazonaws.com \ --credential-age-days30注記
--credential-age-daysパラメータはオプションです。1〜36600 までの日数を指定できます。このパラメータを省略しても、API キーは期限切れになりません。
レスポンスで返される ServiceApiKeyValue は、それぞれのサービスの長期 API キーです。ServiceApiKeyValue 値は後で取得できないため、安全に保管してください。
長期 API キーを一覧表示する (AWS CLI)
特定のユーザーの長期 API キーメタデータを一覧表示するには、list-service-specific-credentials--user-name パラメータを使用します。
aws iam list-service-specific-credentials \ --service-name bedrock.amazonaws.com \ --user-nameAPIKeyUser_1
注記
bedrock.amazonaws.com を適切なサービス名 (Amazon CloudWatch Logs の場合 logs.amazonaws.com など) に置き換えます。
アカウント内のすべての長期 API キーメタデータを一覧表示するには、list-service-specific-credentials--all-usersパラメータを使用します。
aws iam list-service-specific-credentials \ --service-name bedrock.amazonaws.com \ --all-users
長期 API キーステータスを更新する (AWS CLI)
長期 API キーのステータスを更新するには、update-service-specific-credential
aws iam update-service-specific-credential \ --user-name "APIKeyUser_1" \ --service-specific-credential-id "ACCA1234EXAMPLE1234" \ --statusInactive|Active
長期 API キーの生成 (AWS API)
次の IAM API オペレーションを使用して、サポートされているサービスの長期 API キーを管理できます。
短期 API キー (Amazon Bedrock)
現在、短期 API キーは Amazon Bedrock でのみサポートされています。短期 API キーの生成と使用の詳細については、「Amazon Bedrock ユーザーガイド」の「API キーを生成する」を参照してください。
サービス固有の情報
-
Amazon Bedrock を使用した API キーの使用方法の詳細については、「Amazon Bedrock ユーザーガイド」の「Amazon Bedrock API キーを使用する」を参照してください。
-
Amazon CloudWatch Logs で API キーを使用する方法の詳細については、「Amazon CloudWatch Logs ユーザーガイド」の「HTTP エンドポイントを介したログ取り込み」を参照してください。