ListCallAnalyticsJobs - Transcribe

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

ListCallAnalyticsJobs

指定された条件に一致する Call Analytics ジョブのリストを提供します。条件が指定されなかった場合は、すべての Call Analytics ジョブが返されます。

特定の Call Analytics ジョブに関する詳細情報を表示するには、GetCallAnalyticsJobオペレーションを使用します。

リクエストの構文

{ "JobNameContains": "string", "MaxResults": number, "NextToken": "string", "Status": "string" }

リクエストパラメータ

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

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

JobNameContains

指定された文字列を含む Call Analytics ジョブだけが返されます。検索では、大文字と小文字が区別されません。

タイプ: 文字列

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

Pattern: ^[0-9a-zA-Z._-]+

必須: いいえ

MaxResults

結果の各ページで返される Call Analytics ジョブの最大数です。指定した値より結果が少ない場合は、実際の結果のみが返されます。値を指定しない場合、デフォルトの 5 が使用されます。

型: 整数

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

必須: いいえ

NextToken

ListCallAnalyticsJobsリクエストから返される結果が表示可能な数よりも多い場合は、NextTokenが関連する文字列とともにレスポンスに表示されます。結果の次のページを表示するには、この文字列をコピーし、NextTokenコピーした文字列の値を含めてリクエストを繰り返します。必要に応じて繰り返して、すべての結果を表示します。

タイプ: 文字列

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

パターン: .+

必須: いいえ

Status

指定されたステータスの Call Analytics ジョブだけが返されます。ジョブは作成日順に並べられ、最新のジョブが最初に並びます。含めない場合はStatus、すべての Call Analytics ジョブが返されます。

タイプ: 文字列

有効な値: QUEUED | IN_PROGRESS | FAILED | COMPLETED

必須: いいえ

レスポンスの構文

{ "CallAnalyticsJobSummaries": [ { "CallAnalyticsJobName": "string", "CallAnalyticsJobStatus": "string", "CompletionTime": number, "CreationTime": number, "FailureReason": "string", "LanguageCode": "string", "StartTime": number } ], "NextToken": "string", "Status": "string" }

レスポンス要素

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

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

CallAnalyticsJobSummaries

各結果に関する情報の要約を提供します。

型: CallAnalyticsJobSummary オブジェクトの配列

NextToken

NextTokenが回答に含まれている場合は、すべての結果が表示されていないことを示しています。次の結果セットを表示するには、NextToken結果出力のパラメータに関連する文字列をコピーし、NextTokenコピーした文字列の値を含めてリクエストを再実行します。必要に応じて繰り返して、すべての結果を表示します。

タイプ: 文字列

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

パターン: .+

Status

リクエストで指定されたステータスのすべての Call Analytics ジョブを一覧表示します。ジョブは作成日順に並べられ、最新のジョブが最初に並びます。

タイプ: 文字列

有効な値: QUEUED | IN_PROGRESS | FAILED | COMPLETED

エラー

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

BadRequestException

リクエストは 1 つ以上の検証テストに合格しませんでした。これは、削除しようとしているエンティティが存在しない場合、または非終端状態 (例:IN PROGRESS) の場合。詳細については、例外の処理を参照してください。

HTTP ステータスコード: 400

InternalFailureException

インターナルエラーが発生しました。エラーメッセージを確認して、問題を修正して、リクエストを再試行してください。

HTTP ステータスコード: 500

LimitExceededException

送信されたリクエストが多すぎるか、または入力ファイルが長すぎます。リクエストを再試行する前に待つか、またはサイズの小さいファイルを使用してリクエストを再試行してください。

HTTP ステータスコード: 400

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

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