Skip to content

CreateDatasetRequest

Source code in docs_src/capo_iotsitewise/types/create_dataset_request.py
class CreateDatasetRequest(TypedDict, closed=True):
    dataset_id: NotRequired["capo_iotsitewise.types.id.ID"]
    """<p>The ID of the dataset.</p>"""
    dataset_name: "capo_iotsitewise.types.restricted_name.RestrictedName"
    """<p>The name of the dataset.</p>"""
    dataset_description: NotRequired["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. Required for session and curated datasets. Omit this field for datasets that connect to an external datasource.</p>"""
    metadata: NotRequired["capo_iotsitewise.types.metadata.Metadata"]
    """<p>The metadata for the dataset, provided as key-value pairs.</p>"""
    dataset_source: "capo_iotsitewise.types.dataset_source.DatasetSource"
    """<p>The data source for the dataset.</p>"""
    client_token: NotRequired["capo_iotsitewise.types.client_token.ClientToken"]
    """<p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>"""
    tags: NotRequired["capo_iotsitewise.types.tag_map.TagMap"]
    """<p>A list of key-value pairs that contain metadata for the access policy. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

dataset_config instance-attribute

dataset_config: NotRequired[DatasetConfig]

The configuration for the dataset.

dataset_description instance-attribute

dataset_description: NotRequired[Description]

A description about the dataset, and its functionality.

dataset_id instance-attribute

dataset_id: NotRequired[ID]

The ID of the dataset.

dataset_name instance-attribute

dataset_name: RestrictedName

The name of the dataset.

dataset_source instance-attribute

dataset_source: DatasetSource

The data source for the dataset.

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.

metadata instance-attribute

metadata: NotRequired[Metadata]

The metadata for the dataset, provided as key-value pairs.

tags instance-attribute

tags: NotRequired[TagMap]

A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

workspace_name instance-attribute

workspace_name: NotRequired[WorkspaceName]

The name of the workspace that contains the dataset. Required for session and curated datasets. Omit this field for datasets that connect to an external datasource.