ListDatasetImportJobs - Amazon Forecast

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

ListDatasetImportJobs

CreateDatasetImportJob オペレーションを使用して作成されたデータセットのインポートジョブのリストを返します。このオペレーションは、各インポートジョブについて、Amazon リソースネーム (ARN) を含むプロパティの概要を返します。DescribeDatasetImportJob オペレーションで ARN を使用すると、プロパティの完全なセットを取得できます。Filter オブジェクトの配列を提供することにより、リストをフィルタリングできます。

リクエストの構文

{ "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" }

リクエストパラメータ

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

Filters

フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は IS または IS_NOT のいずれかであり、それぞれについて、ステートメントに一致するデータセットをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。

フィルタープロパティ

  • Condition - 適用する条件。有効な値は、IS および IS_NOT です。ステートメントに一致するデータセットを含めるには、IS を指定します。一致するデータセットを除外するには、IS_NOT を指定します。

  • Key - フィルタリングするパラメータの名前。有効な値は、DatasetArn および Status です。

  • Value - 照合する値。

例えば、ステータスが [ACTIVE] であるすべてのデータセットのインポートジョブを一覧表示するには、次のフィルターを指定します。

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

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

必須: いいえ

MaxResults

レスポンスで返される項目の数。

タイプ:整数

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

必須: いいえ

NextToken

前のリクエストの結果が切り捨てられた場合、レスポンスには NextToken が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。

型: 文字列

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

Pattern: .+

必須: いいえ

レスポンスの構文

{ "DatasetImportJobs": [ { "CreationTime": number, "DatasetImportJobArn": "string", "DatasetImportJobName": "string", "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ImportMode": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string" }

レスポンス要素

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

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

DatasetImportJobs

各データセットのインポートジョブのプロパティを要約するオブジェクトの配列。

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

NextToken

レスポンスが切り捨てられた場合、Amazon Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。

型: 文字列

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

パターン:.+

エラー

InvalidInputException

無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。

HTTP ステータスコード:400

InvalidNextTokenException

トークンが無効です。トークンの有効期間は 24 時間です。

HTTP ステータスコード:400

その他の参照資料

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