DescribeCollection - Amazon Rekognition

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

DescribeCollection

指定されたコレクションの説明を表示します。次を使用できます。DescribeCollectionを使用して、コレクションにインデックス付けされた面の数や、コレクションによって顔検出に使用されるモデルのバージョンなどの情報を取得できます。

詳細については、「コレクションの説明」を参照してください。

リクエストの構文

{ "CollectionId": "string" }

リクエストパラメータ

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

CollectionId

説明するコレクションの ID。

Type: 文字列

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

Pattern: [a-zA-Z0-9_.\-]+

必須: はい

レスポンスの構文

{ "CollectionARN": "string", "CreationTimestamp": number, "FaceCount": number, "FaceModelVersion": "string" }

レスポンス要素

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

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

CollectionARN

コレクションの Amazon リソースネーム (ARN)

Type: 文字列

CreationTimestamp

Unix エポック時間からコレクション作成までのミリ秒数。Unix エポック時間は、1970 年 1 月 1 日木曜日の 00:00:00 協定世界時 (UTC) です。

Type: タイムスタンプ

FaceCount

コレクション内でインデックス付けされる顔の数。コレクションにフェースのインデックスを作成するには、IndexFaces

Type: Long

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

FaceModelVersion

顔検出のためにコレクションで使用される顔モデルのバージョン。

詳細については、「モデルのバージョニング」を参照してください。

Type: 文字列

Errors

AccessDeniedException

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

HTTP ステータスコード:HTTP ステータスコード 400

InternalServerError

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

HTTP ステータスコード:HTTP ステータスコード 500

InvalidParameterException

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

HTTP ステータスコード:HTTP ステータスコード 400

ProvisionedThroughputExceededException

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

HTTP ステータスコード:HTTP ステータスコード 400

ResourceNotFoundException

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

HTTP ステータスコード:HTTP ステータスコード 400

ThrottlingException

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

HTTP ステータスコード:HTTP ステータスコード 500

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

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