[ aws . forecast ]

describe-dataset-group

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-dataset-group
--dataset-group-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dataset-group-arn (string)

The Amazon Resource Name (ARN) of the dataset group.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

DatasetGroupName -> (string)

The name of the dataset group.

DatasetGroupArn -> (string)

The ARN of the dataset group.

DatasetArns -> (list)

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

(string)

Domain -> (string)

The domain associated with the dataset group.

Status -> (string)

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 be ACTIVE before you can use the dataset group to create a predictor.

CreationTime -> (timestamp)

When the dataset group was created.

LastModificationTime -> (timestamp)

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.