Skip to content

DatasetSummary

Source code in docs_src/capo_iotsitewise/types/dataset_summary.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class DatasetSummary(TypedDict, closed=True):
    id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the dataset.</p>"""
    arn: "capo_iotsitewise.types.arn.ARN"
    """<p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset. The format is <code>arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}</code>.</p>"""
    name: "capo_iotsitewise.types.restricted_name.RestrictedName"
    """<p>The name of the dataset.</p>"""
    description: "capo_iotsitewise.types.description.Description"
    """<p>A description about the dataset, and its functionality.</p>"""
    source_type: NotRequired[
        "capo_iotsitewise.types.dataset_source_type.DatasetSourceType"
    ]
    """<p>The data source type of the dataset.</p>"""
    dataset_type: NotRequired[
        "capo_iotsitewise.types.dataset_type_enum.DatasetTypeEnum"
    ]
    """<p>The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.</p>"""
    creation_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The dataset creation date, in Unix epoch time.</p>"""
    last_update_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the dataset was last updated, in Unix epoch time.</p>"""
    status: "capo_iotsitewise.types.dataset_status.DatasetStatus"
    """<p>The status of the dataset. This contains the state and any error messages. The state is <code>ACTIVE</code> when ready to use.</p>"""
    enrichment_status: NotRequired[
        "capo_iotsitewise.types.dataset_enrichment.DatasetEnrichment"
    ]
    """<p>The enrichment status of the dataset.</p>"""

arn instance-attribute 

arn: ARN

The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.

creation_date instance-attribute 

creation_date: Timestamp

The dataset creation date, in Unix epoch time.

dataset_type instance-attribute 

dataset_type: NotRequired[DatasetTypeEnum]

The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.

description instance-attribute 

description: Description

A description about the dataset, and its functionality.

enrichment_status instance-attribute 

enrichment_status: NotRequired[DatasetEnrichment]

The enrichment status of the dataset.

id instance-attribute 

id: ID

The ID of the dataset.

last_update_date instance-attribute 

last_update_date: Timestamp

The date the dataset was last updated, in Unix epoch time.

name instance-attribute 

name: RestrictedName

The name of the dataset.

source_type instance-attribute 

source_type: NotRequired[DatasetSourceType]

The data source type of the dataset.

status instance-attribute 

status: DatasetStatus

The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.