DescribeDatasetGroup
Describes a dataset group created using the CreateDatasetGroup operation.
In addition to listing the parameters provided in the CreateDatasetGroup
request, this operation includes the following properties:
-
DatasetArns
- The datasets belonging to the group. -
CreationTime
-
LastModificationTime
-
Status
Request Syntax
{
"DatasetGroupArn": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- DatasetGroupArn
-
The Amazon Resource Name (ARN) of the dataset group.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+
Required: Yes
Response Syntax
{
"CreationTime": number,
"DatasetArns": [ "string" ],
"DatasetGroupArn": "string",
"DatasetGroupName": "string",
"Domain": "string",
"LastModificationTime": number,
"Status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreationTime
-
When the dataset group was created.
Type: Timestamp
- DatasetArns
-
An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
Type: Array of strings
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+
- DatasetGroupArn
-
The ARN of the dataset group.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+
- DatasetGroupName
-
The name of the dataset group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z][a-zA-Z0-9_]*
- Domain
-
The domain associated with the dataset group.
Type: String
Valid Values:
RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS
- LastModificationTime
-
When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,
LastModificationTime
is the current time of theDescribeDatasetGroup
call.Type: Timestamp
- Status
-
The status of the dataset group. States include:
-
ACTIVE
-
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
-
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
-
UPDATE_PENDING
,UPDATE_IN_PROGRESS
,UPDATE_FAILED
The
UPDATE
states apply when you call the UpdateDatasetGroup operation.Note
The
Status
of the dataset group must beACTIVE
before you can use the dataset group to create a predictor.Type: String
Length Constraints: Maximum length of 256.
-
Errors
- InvalidInputException
-
We can't process the request because it includes an invalid value or a value that exceeds the valid range.
HTTP Status Code: 400
- ResourceNotFoundException
-
We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: