リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素 Errors 以下の資料も参照してください。

StartTopicsDetectionJob

非同期トピック検出ジョブを開始します。を使用するDescribeTopicDetectionJobオペレーションは、ジョブのステータスを追跡するためです。

リクエストの構文


{
   "ClientRequestToken": "string",
   "DataAccessRoleArn": "string",
   "InputDataConfig": { 
      "DocumentReaderConfig": { 
         "DocumentReadAction": "string",
         "DocumentReadMode": "string",
         "FeatureTypes": [ "string" ]
      },
      "InputFormat": "string",
      "S3Uri": "string"
   },
   "JobName": "string",
   "NumberOfTopics": number,
   "OutputDataConfig": { 
      "KmsKeyId": "string",
      "S3Uri": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VolumeKmsKeyId": "string",
   "VpcConfig": { 
      "SecurityGroupIds": [ "string" ],
      "Subnets": [ "string" ]
   }
}

リクエストパラメータ

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

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

ClientRequestToken

リクエストの一意の識別子。クライアントリクエストトークンを設定しないと、Amazon Comprehend が生成します。

Type: 文字列

制約: 最小長は 1 です｡最大長は 64 です。

Pattern: ^[a-zA-Z0-9-]+$

: 必須いいえ

DataAccessRoleArn

入力データへの 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」を参照してください。

Type: 文字列

制約: 最小長は 20 です｡最大長は 2048 です。

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

: 必須はい

InputDataConfig

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

タイプ: InputDataConfig オブジェクト

: 必須はい

JobName

ジョブの識別子。

Type: 文字列

制約: 最小長は 1 です｡最大長は 256 です。

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

: 必須いいえ

NumberOfTopics

検出するトピックの数。

Type: 整数

有効範囲: 最小値は 1 です。最大値は 100 です。

: 必須いいえ

OutputDataConfig

出力ファイルの送信先を指定します。出力は 2 つのファイルを含む圧縮アーカイブです。topic-terms.csv各トピックに関連する用語の一覧を示します。doc-topics.csv各トピックに関連付けられているドキュメントを一覧表示します。

タイプ: OutputDataConfig オブジェクト

: 必須はい

Tags

トピック検出ジョブに関連付けるタグ。タグは Amazon Comprehend で使用されるリソースにメタデータを追加するキーと値のペアです。たとえば、「Sales」をキーとするタグがリソースに追加され、営業部門による使用を示す場合があります。

Type: 配列配列Tagobjects

: 必須いいえ

VolumeKmsKeyId

分析ジョブを処理する ML コンピューティングインスタンスにアタッチされたストレージボリュームのデータを暗号化するために Amazon Comprehend が使用する 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"

Type: 文字列

制約: 最大長は 2048 です。

Pattern: .*

: 必須いいえ

VpcConfig

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

タイプ: VpcConfig オブジェクト

: 必須いいえ

レスポンスの構文


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

レスポンス要素

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

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

JobArn

トピック検出ジョブの Amazon リソースネーム (ARN)。これは、ジョブの一意の完全修飾識別子です。これには、AWS アカウント、リージョン、およびジョブ ID が含まれます。ARN の形式は次のとおりです。

arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>

ジョブ ARN の例を以下に示します。

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Type: 文字列

制約: 最大長は 256 です。

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

JobId

ジョブ識別子。ジョブのステータスを取得するには、この識別子を使用してDescribeTopicDetectionJobオペレーション.

Type: 文字列

制約: 最小長は 1 です｡最大長は 32 です。

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

JobStatus

ジョブのステータス:

Submited-ジョブが受信され、処理のためにキューに入れられています。
IN_PROGRESS-Amazon Comprehend がジョブを処理しています。
COMPLETED-ジョブが正常に完了し、出力が使用可能になります。
失敗-ジョブを完了できませんでした。詳細を取得するには、DescribeTopicDetectionJobオペレーション.

Type: 文字列

Errors

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

InternalServerException

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

HTTP ステータスコード: 500

InvalidRequestException

リクエストは無効でした。

HTTP ステータスコード: 400

KmsKeyValidationException

入力された KMS カスタマー管理キー (CMK) を検証できません。キーを確認し、もう一度入力してください。

HTTP ステータスコード: 400

TooManyRequestsException

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

HTTP ステータスコード: 400

TooManyTagsException

リクエストには、リソースに関連付けることができるより多くのタグが含まれています (リソースあたり 50 タグ)。タグの最大数には、既存のタグと現在のリクエストに含まれるタグの両方が含まれます。

HTTP ステータスコード: 400

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

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

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

StartSentimentDetectionJob

StopDominantLanguageDetectionJob