CreateCollection - Amazon Rekognition

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

CreateCollection

AWS リージョンでコレクションを作成します。コレクションに顔を追加するには、 IndexFaces オペレーション.

たとえば、アプリケーションユーザーごとに 1 つのコレクションを作成できます。その後、ユーザはフェースをインデックス化できます。IndexFaces操作を実行し、結果を特定のコレクションに保持します。その後、ユーザは、ユーザ固有のコンテナ内のフェースをコレクションで検索できます。

コレクションを作成すると、最新バージョンの顔モデルバージョンに関連付けられます。

注記

コレクション名では大文字と小文字が区別されます。

このオペレーションには rekognition:CreateCollection アクションを実行するアクセス許可が必要です。コレクションにタグを付けたい場合は、rekognition:TagResourceオペレーション.

リクエストの構文

{ "CollectionId": "string", "Tags": { "string" : "string" } }

リクエストパラメータ

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

CollectionId

作成するコレクションの ID。

Type: 文字列

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

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

必須: はい

Tags

コレクションにアタッチするタグのセット (キーと値のペア)。

Type: 文字列から文字列へのマッピング

マップエントリ: 最小項目数は 0 です。最大数は 200 項目です。

キー長制限: 最小長は 1 です。 最大長は 128 です。

キーパターン: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

値の長さ制約: 最小長は 0 です。最大長は 256 です。

値パターン:^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

必須: いいえ

レスポンスの構文

{ "CollectionArn": "string", "FaceModelVersion": "string", "StatusCode": number }

レスポンス要素

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

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

CollectionArn

コレクションの Amazon リソースネーム (ARN) これを使用して、リソースのアクセス許可を管理できます。

Type: 文字列

FaceModelVersion

作成するコレクションに関連付けられている面検出モデルのバージョン番号。

Type: 文字列

StatusCode

操作の結果を示す HTTP ステータスコード。

Type: 整数

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

Errors

AccessDeniedException

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

HTTP ステータスコード: 400

InternalServerError

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

HTTP ステータスコード: 500

InvalidParameterException

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

HTTP ステータスコード: 400

ProvisionedThroughputExceededException

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

HTTP ステータスコード: 400

ResourceAlreadyExistsException

指定された ID のリソースはすでに存在しています。

HTTP ステータスコード: 400

ServiceQuotaExceededException

リソースサイズが制限文字数を超えています。詳細については、「Amazon Rekognition のガイドラインとクォータ」を参照してください。

HTTP ステータスコード: 400

ThrottlingException

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

HTTP ステータスコード: 500

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

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