DescribeDatasetResponse ¶

class DescribeDatasetResponse(TypedDict, closed=True):
    dataset_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the dataset.</p>"""
    dataset_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>"""
    dataset_name: "capo_iotsitewise.types.restricted_name.RestrictedName"
    """<p>The name of the dataset.</p>"""
    dataset_description: "capo_iotsitewise.types.description.Description"
    """<p>A description about the dataset, and its functionality.</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>"""
    dataset_config: NotRequired["capo_iotsitewise.types.dataset_config.DatasetConfig"]
    """<p>The configuration for the dataset.</p>"""
    workspace_name: NotRequired["capo_iotsitewise.types.workspace_name.WorkspaceName"]
    """<p>The name of the workspace that contains the dataset.</p>"""
    metadata: NotRequired["capo_iotsitewise.types.metadata.Metadata"]
    """<p>The metadata for the dataset.</p>"""
    dataset_source: "capo_iotsitewise.types.dataset_source.DatasetSource"
    """<p>The data source for the dataset.</p>"""
    dataset_status: "capo_iotsitewise.types.dataset_status.DatasetStatus"
    """<p>The status of the dataset. This contains the state and any error messages. State is <code>CREATING</code> after a successfull call to this API, and any associated error message. The state is <code>ACTIVE</code> when ready to use.</p>"""
    dataset_creation_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The dataset creation date, in Unix epoch time.</p>"""
    dataset_last_update_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the dataset was last updated, in Unix epoch time.</p>"""
    dataset_version: NotRequired["capo_iotsitewise.types.version.Version"]
    """<p>The version of the dataset.</p>"""
    enrichment_status: NotRequired[
        "capo_iotsitewise.types.dataset_enrichment.DatasetEnrichment"
    ]
    """<p>The enrichment status of the dataset.</p>"""