create_dataset ¶

def create_dataset(
    self,
    dataset_name: "capo_iotsitewise.types.restricted_name.RestrictedName",
    dataset_source: "capo_iotsitewise.types.dataset_source.DatasetSource",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    dataset_id: Optional["capo_iotsitewise.types.id.ID"] = None,
    dataset_description: Optional[
        "capo_iotsitewise.types.description.Description"
    ] = None,
    dataset_type: Optional[
        "capo_iotsitewise.types.dataset_type_enum.DatasetTypeEnum"
    ] = None,
    dataset_config: Optional[
        "capo_iotsitewise.types.dataset_config.DatasetConfig"
    ] = None,
    workspace_name: Optional[
        "capo_iotsitewise.types.workspace_name.WorkspaceName"
    ] = None,
    metadata: Optional["capo_iotsitewise.types.metadata.Metadata"] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
    tags: Optional["capo_iotsitewise.types.tag_map.TagMap"] = None,
) -> "capo_iotsitewise.types.create_dataset_response.CreateDatasetResponse":
    """<p>Creates a dataset. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace.</p>

    Args:
        dataset_id: <p>The ID of the dataset.</p>
        dataset_name: <p>The name of the dataset.</p>
        dataset_description: <p>A description about the dataset, and its functionality.</p>
        dataset_type: <p>The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.</p>
        dataset_config: <p>The configuration for the dataset.</p>
        workspace_name: <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: <p>The metadata for the dataset, provided as key-value pairs.</p>
        dataset_source: <p>The data source for the dataset.</p>
        client_token: <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: <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>

    Raises:
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.limit_exceeded_exception.LimitExceededException: <p>You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The resource already exists.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.create_dataset_request.CreateDatasetRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.create_dataset_response.CreateDatasetResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.create_dataset

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.create_dataset.create_dataset(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDataset")
    )
    input_: capo_iotsitewise.types.create_dataset_request.CreateDatasetRequest = {
        "dataset_name": dataset_name,
        "dataset_source": dataset_source,
    }
    if dataset_id is not None:
        input_["dataset_id"] = dataset_id
    if dataset_description is not None:
        input_["dataset_description"] = dataset_description
    if dataset_type is not None:
        input_["dataset_type"] = dataset_type
    if dataset_config is not None:
        input_["dataset_config"] = dataset_config
    if workspace_name is not None:
        input_["workspace_name"] = workspace_name
    if metadata is not None:
        input_["metadata"] = metadata
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output