Skip to main content

dataset_groups

Creates, updates, deletes, gets or lists a dataset_groups resource.

Overview​

Namedataset_groups
TypeResource
Idaws.forecast.dataset_groups

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
creation_timestring (date-time)When the dataset group was created.
dataset_arnsarrayAn array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
dataset_group_arnstringThe ARN of the dataset group. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
dataset_group_namestringThe name of the dataset group. (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</code>)
domainstringThe domain associated with the dataset group. (RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS)
last_modification_timestring (date-time)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 the DescribeDatasetGroup call.
statusstringThe 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. The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_dataset_groupselectregionDescribes 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
list_dataset_groupsselectregionReturns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.
create_dataset_groupinsertregion, DatasetGroupNameCreates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation. After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups. To get a list of all your datasets groups, use the ListDatasetGroups operation. The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
update_dataset_groupupdateregion, DatasetGroupArn, DatasetArnsReplaces the datasets in a dataset group with the specified datasets. The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status.
delete_dataset_groupdeleteregionDeletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation. This operation deletes only the dataset group, not the datasets in the group.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

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

SELECT
creation_time,
dataset_arns,
dataset_group_arn,
dataset_group_name,
domain,
last_modification_time,
status
FROM aws.forecast.dataset_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation. After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups. To get a list of all your datasets groups, use the ListDatasetGroups operation. The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

INSERT INTO aws.forecast.dataset_groups (
DatasetGroupName,
Domain,
DatasetArns,
Tags,
region
)
SELECT 
'{{ DatasetGroupName }}' /* required */,
'{{ Domain }}',
'{{ DatasetArns }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
dataset_group_arn
;

UPDATE examples​

Replaces the datasets in a dataset group with the specified datasets. The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status.

UPDATE aws.forecast.dataset_groups
SET 
DatasetGroupArn = '{{ DatasetGroupArn }}',
DatasetArns = '{{ DatasetArns }}'
WHERE 
region = '{{ region }}' --required
AND DatasetGroupArn = '{{ DatasetGroupArn }}' --required
AND DatasetArns = '{{ DatasetArns }}' --required;

DELETE examples​

Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation. This operation deletes only the dataset group, not the datasets in the group.

DELETE FROM aws.forecast.dataset_groups
WHERE region = '{{ region }}' --required
;
Last updated on