ListFaces - Amazon Rekognition

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ListFaces

指定したコレクション内の顔のメタデータを返します。このメタデータには、境界ボックスの座標、信頼度 (境界ボックス内に顔が含まれていること)、顔 ID などの情報が含まれます。例については、コレクション内の顔を一覧表示する を参照してください。

このオペレーションには rekognition:ListFaces アクションを実行するアクセス許可が必要です。

リクエストの構文

{ "CollectionId": "string", "MaxResults": number, "NextToken": "string" }

リクエストパラメータ

リクエストは以下の JSON 形式のデータを受け入れます。

CollectionId

顔をリストするコレクションの ID。

Type: 文字列

長さの制約: 最小長は 1 です。 最大長は 255 です。

パターン: [a-zA-Z0-9_.\-]+

: 必須 はい

MaxResults

返される顔の最大数。

Type: 整数

有効範囲: 最小値は 0 です。最大値は 4096 です。

: 必須 いいえ

NextToken

前のレスポンスが不完全だった場合 (取得するデータが多いため)、Amazon Rekognition はレスポンスでページ割りトークンを返します。このページ割りトークンを使用して、次の顔のセットを取得できます。

Type: 文字列

長さの制約: 最大長は 255 です。

: 必須 いいえ

レスポンスの構文

{ "FaceModelVersion": "string", "Faces": [ { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Confidence": number, "ExternalImageId": "string", "FaceId": "string", "ImageId": "string", "IndexFacesModelVersion": "string" } ], "NextToken": "string" }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

FaceModelVersion

入力コレクションに関連付けられている顔検出モデルのバージョン番号 (CollectionId).

Type: 文字列

Faces

Face オブジェクトの配列。

Type: の配列Faceオブジェクト

NextToken

レスポンスが切り捨てられると、Amazon Rekognition はこのトークンを返します。このトークンを後続のリクエストで使用して、次の顔のセットを取得できます。

Type: 文字列

エラー

AccessDeniedException

アクションを実行する権限がありません。

HTTP ステータスコード: 400

InternalServerError

Amazon Rekognition でサービスの問題が発生しました。もう一度やり直してください。

HTTP ステータスコード: 500

InvalidPaginationTokenException

リクエストのページ分割トークンが有効ではありません。

HTTP ステータスコード: 400

InvalidParameterException

入力パラメータが制約に違反しています。API オペレーションを再度呼び出す前にパラメータを検証します。

HTTP ステータスコード: 400

ProvisionedThroughputExceededException

お客様のスループット制限を超えたリクエストの数。この上限を引き上げる場合は、Amazon Rekognition までお問い合わせください。

HTTP ステータスコード: 400

ResourceNotFoundException

リクエストで指定されたリソースが見つかりません。

HTTP ステータスコード: 400

ThrottlingException

Amazon Rekognition は一時的にリクエストを処理できませんでした。もう一度やり直してください。

HTTP ステータスコード: 500

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください: