Skip to content

DescribeDatasetGroupResponse

Source code in docs_src/capo_forecast/types/describe_dataset_group_response.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class DescribeDatasetGroupResponse(TypedDict, closed=True):
    dataset_group_name: NotRequired["capo_forecast.types.name.Name"]
    """<p>The name of the dataset group.</p>"""
    dataset_group_arn: NotRequired["capo_forecast.types.arn.Arn"]
    """<p>The ARN of the dataset group.</p>"""
    dataset_arns: NotRequired["capo_forecast.types.arn_list.ArnList"]
    """<p>An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.</p>"""
    domain: NotRequired["capo_forecast.types.domain.Domain"]
    """<p>The domain associated with the dataset group.</p>"""
    status: NotRequired["capo_forecast.types.status.Status"]
    """<p>The status of the dataset group. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>UPDATE_PENDING</code>, <code>UPDATE_IN_PROGRESS</code>, <code>UPDATE_FAILED</code> </p> </li> </ul> <p>The <code>UPDATE</code> states apply when you call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a> operation.</p> <note> <p>The <code>Status</code> of the dataset group must be <code>ACTIVE</code> before you can use the dataset group to create a predictor.</p> </note>"""
    creation_time: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>When the dataset group was created.</p>"""
    last_modification_time: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>When the dataset group was created or last updated from a call to the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a> operation. While the dataset group is being updated, <code>LastModificationTime</code> is the current time of the <code>DescribeDatasetGroup</code> call.</p>"""

creation_time instance-attribute 

creation_time: NotRequired[Timestamp]

When the dataset group was created.

dataset_arns instance-attribute 

dataset_arns: NotRequired[ArnList]

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

dataset_group_arn instance-attribute 

dataset_group_arn: NotRequired[Arn]

The ARN of the dataset group.

dataset_group_name instance-attribute 

dataset_group_name: NotRequired[Name]

The name of the dataset group.

domain instance-attribute 

domain: NotRequired[Domain]

The domain associated with the dataset group.

last_modification_time instance-attribute 

last_modification_time: NotRequired[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.

status instance-attribute 

status: NotRequired[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.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.