翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeDataset
CreateDataset オペレーションを使用して作成された Amazon Forecast データセットについて説明します。
このオペレーションは、CreateDataset リクエストで指定されたパラメータの一覧表示に加えて、次のデータセットのプロパティを含めます。
-
CreationTime -
LastModificationTime -
Status
リクエストの構文
{
"DatasetArn": "string"
}リクエストパラメータ
リクエストは以下の JSON 形式のデータを受け入れます。
- DatasetArn
-
データセットの Amazon リソースネーム (ARN)。
型: 文字列
長さの制限：最大長は 256 です。
パターン：
arn:([a-z\d-]+):forecast:.*:.*:.+必須：はい
レスポンスの構文
{
"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
-
データセットが作成された時点。
型: タイムスタンプ
- DataFrequency
-
データ収集の頻度。
有効な間隔は、Y (年)、M (月)、W (週)、D (日)、H (時間)、30min (30分)、15min (15分)、10min (10分)、5min (5分)、および 1min (1分) です。例えば、[M] は毎月を示し、[30min] は 30 分ごとを示します。
型: 文字列
長さの制限：最小長は 1 です。最大長は 5 です。
Pattern:
^Y|M|W|D|H|30min|15min|10min|5min|1min$ - DatasetArn
-
データセットの Amazon リソースネーム (ARN)。
型: 文字列
長さの制限：最大長は 256 です。
パターン：
arn:([a-z\d-]+):forecast:.*:.*:.+ - DatasetName
-
データセットの名前。
型: 文字列
長さの制限：最小長は 1 です。最大長は 63 です。
パターン:
^[a-zA-Z][a-zA-Z0-9_]* - DatasetType
-
データセットのタイプ。
型: 文字列
有効な値：
TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA - Domain
-
データセットに関連付けられているドメイン。
型: 文字列
有効な値：
RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS - EncryptionConfig
-
Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service (KMS) キーと AWS Identity and Access Management (IAM) ロール。
タイプ：EncryptionConfig オブジェクト
- LastModificationTime
-
データセットを作成する場合、
LastModificationTimeはCreationTimeと同じです。データがデータセットにインポートされている間、LastModificationTimeはDescribeDatasetコールの現在の時刻です。CreateDatasetImportJob オペレーションが完了すると、LastModificationTimeはインポートジョブが完了または失敗した時点になります。型: タイムスタンプ
- Schema
-
データセットフィールドを指定する
SchemaAttributeオブジェクトの配列。各SchemaAttributeがフィールドの名前とデータ型を指定します。タイプ：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である必要があります。型: 文字列
長さの制限：最大長は 256 です。
-
エラー
- InvalidInputException
-
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。
HTTP ステータスコード：400
- ResourceNotFoundException
-
その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
