update_dataset async ¶

async def update_dataset(
    self,
    dataset_id: "capo_iotsitewise.types.id.ID",
    dataset_name: "capo_iotsitewise.types.restricted_name.RestrictedName",
    dataset_source: "capo_iotsitewise.types.dataset_source.DatasetSource",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    workspace_name: Optional[
        "capo_iotsitewise.types.workspace_name.WorkspaceName"
    ] = None,
    dataset_description: Optional[
        "capo_iotsitewise.types.description.Description"
    ] = None,
    dataset_config: Optional[
        "capo_iotsitewise.types.dataset_config.DatasetConfig"
    ] = None,
    metadata: Optional["capo_iotsitewise.types.metadata.Metadata"] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
) -> "capo_iotsitewise.types.update_dataset_response.UpdateDatasetResponse":
    """<p>Updates a dataset.</p>

    Args:
        dataset_id: <p>The ID of the dataset.</p>
        workspace_name: <p>The name of the workspace that contains 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_config: <p>The updated configuration for the dataset.</p>
        metadata: <p>The updated metadata for the dataset.</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>

    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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.update_dataset_request.UpdateDatasetRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.update_dataset_response.UpdateDatasetResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.update_dataset

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.update_dataset.async_update_dataset(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output