StartEntitiesDetectionJob - Amazon Comprehend

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

StartEntitiesDetectionJob

ドキュメントのコレクション用に非同期のエンティティ検出ジョブを開始します。DescribeEntitiesDetectionJob オペレーションを使用して、ジョブのステータスを追跡します。

この API は、標準エンティティ検出またはカスタムエンティティ認識に使用できます。カスタムエンティティ認識に使用するには、カスタムエンティティの検出に使用されるレコグナイザーへのアクセスを提供するために、 オプションEntityRecognizerArnを使用する必要があります。

リクエストの構文

{ "ClientRequestToken": "string", "DataAccessRoleArn": "string", "EntityRecognizerArn": "string", "InputDataConfig": { "InputFormat": "string", "S3Uri": "string" }, "JobName": "string", "LanguageCode": "string", "OutputDataConfig": { "KmsKeyId": "string", "S3Uri": "string" }, "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

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

ClientRequestToken

リクエストの一意の識別子。クライアントリクエストトークンを設定しない場合 Amazon Comprehend によってトークンが生成されます。

型: 文字列

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

パターン: ^[a-zA-Z0-9-]+$

必須: いいえ

DataAccessRoleArn

入力データへの Amazon Amazon Comprehend 読み取りアクセスを許可する AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN)。詳細については、「 」を参照してくださいhttps://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions

型: 文字列

長さの制限: 最小長は 20 です。最大長は 2048 です。

パターン: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

必須: はい

EntityRecognizerArn

が使用する特定のエンティティレコグナイザーを識別する Amazon リソースネーム (StartEntitiesDetectionJobARN)。この ARN はオプションであり、カスタムエンティティ認識ジョブにのみ使用されます。

型: 文字列

長さの制限: 最大長は 256 です。

パターン: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*

必須: いいえ

InputDataConfig

ジョブの入力データの形式と場所を指定します。

タイプ: InputDataConfig オブジェクト

必須: はい

JobName

ジョブの識別子。

型: 文字列

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

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

必須: いいえ

LanguageCode

入力ドキュメントの言語。すべてのドキュメントは同じ言語である必要があります。Amazon Comprehend でサポートされている任意の言語を指定できます。カスタムエンティティ認識が使用されている場合、このパラメータは無視されます。代わりに、モデルのトレーニングに使用される言語が使用されます。

型: 文字列

有効な値: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW

必須: はい

OutputDataConfig

出力ファイルを送信する場所を指定します。

タイプ: OutputDataConfig オブジェクト

必須: はい

VolumeKmsKeyId

分析ジョブを処理する ML コンピューティングインスタンスにアタッチされたストレージボリュームのデータを暗号化するために Amazon Comprehend が使用する AWS AWS Key Management Service (KMS)) キーの ID。VolumeKmsKeyId は、次のいずれかの形式になります。

  • KMS キー ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS キーの Amazon リソースネーム (ARN): "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

型: 文字列

長さの制限: 最大長は 2048 です。

必須: いいえ

VpcConfig

エンティティ検出ジョブに使用するリソースを含むオプションのプライベート Virtual Private Cloud (VPC) の設定パラメータ。詳細については、「Amazon VPC 」を参照してください。

タイプ: VpcConfig オブジェクト

必須: いいえ

レスポンスの構文

{ "JobId": "string", "JobStatus": "string" }

レスポンス要素

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

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

JobId

ジョブ用に生成された識別子。ジョブのステータスを取得するには、 DescribeEntitiesDetectionJob オペレーションでこの識別子を使用します。

型: 文字列

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

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

JobStatus

ジョブのステータス。

  • SUBMITTED - ジョブは受信され、処理のためにキューに入れられます。

  • IN_PROGRESS - Amazon Comprehend はジョブを処理しています。

  • COMPLETED - ジョブは正常に完了し、出力が利用可能になりました。

  • FAILED - ジョブが完了しませんでした。詳細を取得するには、 DescribeEntitiesDetectionJob オペレーションを使用します。

  • STOP_REQUESTED - Amazon Comprehend がジョブの停止リクエストを受け取り、リクエストを処理しています。

  • STOPPED - ジョブは完了せずに正常に停止しました。

型: 文字列

有効な値: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED

Errors

すべてのアクションに共通のエラーについては、「一般的なエラー」を参照してください。

InternalServerException

内部サーバーエラーが発生しました。リクエストを再実行します。

HTTP ステータスコード: 500

InvalidRequestException

リクエストが無効です。

HTTP ステータスコード: 400

KmsKeyValidationException

入力した KMS カスタマー管理キー (CMK) を検証できません。キーを確認し、再入力します。

HTTP ステータスコード: 400

ResourceNotFoundException

指定されたリソース ARN が見つかりませんでした。ARN を確認して、リクエストを再試行してください。

HTTP ステータスコード: 400

ResourceUnavailableException

指定されたリソースは使用できません。リソースを確認して、リクエストを再試行してください。

HTTP ステータスコード: 400

TooManyRequestsException

リクエストの数が制限を超えています。リクエストを後で再送信します。

HTTP ステータスコード: 400

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

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