batch_delete_dataset_data_segments ¶

batch_delete_dataset_data_segments(
    dataset_id: ID,
    workspace_name: WorkspaceName,
    delete_data_segment_entries: DeleteDataSegmentEntries,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> BatchDeleteDatasetDataSegmentsResponse

Deletes a batch of data segments from a session dataset. Deleting a data segment deletes the underlying time series data for the segment's time range.

Parameters:

dataset_id (ID) –

The ID of the session dataset from which to delete data segments.
workspace_name (WorkspaceName) –

The name of the workspace that contains the dataset.
delete_data_segment_entries (DeleteDataSegmentEntries) –

The list of data segment entries to delete.
client_token (Optional[ClientToken], default: None ) –

A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.

Raises:

ConflictingOperationException –

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.
InternalFailureException –

IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

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.

For more information, see Quotas in the IoT SiteWise User Guide.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iotsitewise/_services/io_t_site_wise.py

def batch_delete_dataset_data_segments(
    self,
    dataset_id: "capo_iotsitewise.types.id.ID",
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    delete_data_segment_entries: "capo_iotsitewise.types.delete_data_segment_entries.DeleteDataSegmentEntries",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
) -> "capo_iotsitewise.types.batch_delete_dataset_data_segments_response.BatchDeleteDatasetDataSegmentsResponse":
    """<p>Deletes a batch of data segments from a session dataset. Deleting a data segment deletes the underlying time series data for the segment's time range.</p>

    Args:
        dataset_id: <p>The ID of the session dataset from which to delete data segments.</p>
        workspace_name: <p>The name of the workspace that contains the dataset.</p>
        delete_data_segment_entries: <p>The list of data segment entries to delete.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.</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.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.batch_delete_dataset_data_segments_request.BatchDeleteDatasetDataSegmentsRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.batch_delete_dataset_data_segments_response.BatchDeleteDatasetDataSegmentsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.batch_delete_dataset_data_segments

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchDeleteDatasetDataSegments")
    )
    input_: capo_iotsitewise.types.batch_delete_dataset_data_segments_request.BatchDeleteDatasetDataSegmentsRequest = {
        "dataset_id": dataset_id,
        "workspace_name": workspace_name,
        "delete_data_segment_entries": delete_data_segment_entries,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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