認証 APIs

次の APIs を使用すると、Amazon Location Service の API キーを管理できます。これらのオペレーションを使用して、キーの作成、制限の設定、キーの更新、キーインベントリのモニタリングを行います。

• CreateKey: 指定された制限とオプションの有効期限を持つ新しい API キーを作成します。後続の API リクエストの認証に使用されるキー値を返します。詳細については、Amazon Location Service API リファレンスのCreateKey」を参照してください。

• DescribeKey: 制限、有効期限、キー値など、既存の API キーの詳細を取得します。詳細については、Amazon Location Service API リファレンスのDescribeKey」を参照してください。

• UpdateKey: 既存の API キーの制限、有効期限、または説明を変更します。このオペレーションを使用して、アクセス許可を厳しくする、有効期限を延長または設定する、またはキーを非アクティブ化します。詳細については、Amazon Location Service API リファレンスのUpdateKey」を参照してください。

• DeleteKey: API キーを完全に削除します。少なくとも 90 日間非アクティブだったキーのみを削除できます。詳細については、Amazon Location Service API リファレンスのDeleteKey」を参照してください。

• ListKeys: キー名、ステータス、有効期限などのメタデータを含む、アカウントとリージョンの API キーのリストを返します。詳細については、Amazon Location Service API リファレンスのListKeys」を参照してください。

一般的なユースケース

API キー管理オペレーションの一般的なユースケースを次に示します。

• マップアプリケーションのキーを作成する: デフォルトのマッププロバイダーリソースのgeo-maps:*アクションに制限されたキーを作成します。これは、マップのみをレンダリングするウェブページに適しています。

• マップと場所のキーを作成する: 1 つのキーで複数の許可されたアクションとリソースを指定することで、マップのレンダリングとジオコーディングの両方を許可するキーを作成します。

• API キーのローテーション: 新しいキーを作成し、それを使用するようにアプリケーションを更新してから、 を使用して有効期限を過去の日付に設定して古いキーを非アクティブ化しますUpdateKey。

• ドメイン制限の追加: 既存のキーを更新して、リファラーベースのクライアント制限を使用して特定のウェブドメインの使用を制限します。

• 監査キーインベントリ: を使用してアカウントのすべてのキーを一覧表示ListKeysし、クリーンアップのために未使用または期限切れのキーを特定します。

• 侵害されたキーを取り消す: ステータスを に更新してすぐにキーを非アクティブ化しUpdateKey、 を使用して 90 日後に削除しますDeleteKey。