DescribeDataset - Amazon Forecast

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

DescribeDataset

Amazon Forecast データセットについて説明します。 CreateDataset オペレーション.

で指定されているパラメーターを一覧表示することに加えて、CreateDatasetリクエストの場合、この操作には次のデータセットプロパティが含まれます。

  • CreationTime

  • LastModificationTime

  • Status

リクエストの構文

{ "DatasetArn": "string" }

リクエストパラメータ

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

DatasetArn

データセットの Amazon リソースネーム (ARN)。

Type: 文字列

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

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

必須: はい

レスポンスの構文

{ "CreationTime": number, "DataFrequency": "string", "DatasetArn": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "LastModificationTime": number, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "Status": "string" }

レスポンス要素

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

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

CreationTime

データセットが作成された日時。

Type: タイムスタンプ

DataFrequency

データ収集の頻度。

有効な間隔は、Y(年)、M(月)、W(週)、D(日)、H(時間)、30 分(30分)、15 分(15分)、10 分(10分)、5 分(5分)、1 分(1分)です。たとえば、「M」は毎月を示し、「30min」は30分ごとを示します。

Type: 文字列

Pattern: ^Y|M|W|D|H|30min|15min|10min|5min|1min$

DatasetArn

データセットの Amazon リソースネーム (ARN)。

Type: 文字列

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

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

DatasetName

データセットの名前。

Type: 文字列

長さの制約: 最小長は 1 です。 最大長は 63 です。

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*

DatasetType

データセットタイプ。

Type: 文字列

有効な値: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA

Domain

データセットに関連付けられたドメイン。

Type: 文字列

有効な値: RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS

EncryptionConfig

キーへのアクセスのために Amazon Forecast が引き受けることができる AWS キーマネジメントサービス (KMS) キーおよび AWS Identity and Access Management (IAM) ロール。

タイプ: EncryptionConfig オブジェクト

LastModificationTime

データセットを作成すると、LastModificationTimeは、CreationTime。データがデータセットにインポートされている間、LastModificationTime現在の時刻です。DescribeDatasetを呼び出します。After CreateDatasetImportJob 操作が終了しました。LastModificationTimeは、インポートジョブが完了または失敗したときです。

Type: タイムスタンプ

Schema

の配列SchemaAttributeオブジェクトを使用して、データセットフィールドを指定します。EachSchemaAttributeは、フィールドの名前とデータ型を指定します。

タイプ: Schema オブジェクト

Status

データセットのステータス。含まれる状態:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

-UPDATEの呼び出しからデータセットにデータがインポートされる間、 CreateDatasetImportJob オペレーションを実行して、データセットのインポートジョブのステータスを反映します。たとえば、インポートジョブのステータスがCREATE_IN_PROGRESSの場合、データセットのステータスはUPDATE_IN_PROGRESS

注記

-Statusは、データセットのACTIVEトレーニングデータをインポートする前に。

Type: 文字列

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

Errors

InvalidInputException

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

HTTP ステータスコード:HTTP ステータスコード 400

ResourceNotFoundException

その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。

HTTP ステータスコード:HTTP ステータスコード 400

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

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