IoTSiteWise / Client / batch_delete_dataset_data_segments

batch_delete_dataset_data_segments

IoTSiteWise.Client.batch_delete_dataset_data_segments(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_dataset_data_segments(
    datasetId='string',
    workspaceName='string',
    deleteDataSegmentEntries=[
        {
            'timeSeriesId': 'string',
            'startTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'endTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            }
        },
    ],
    clientToken='string'
)

Parameters:

• datasetId (string) –

  [REQUIRED]

  The ID of the session dataset from which to delete data segments.

• workspaceName (string) –

  [REQUIRED]

  The name of the workspace that contains the dataset.

• deleteDataSegmentEntries (list) –

  [REQUIRED]

  The list of data segment entries to delete.

  • (dict) –

    Contains information about a data segment entry to delete.

    • timeSeriesId (string) – [REQUIRED]

      The ID of the time series.

    • startTimestamp (dict) – [REQUIRED]

      The nanosecond-precision start time of the data segment to delete.

      • timeInSeconds (integer) – [REQUIRED]

        The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

      • offsetInNanos (integer) –

        The nanosecond offset from timeInSeconds.

    • endTimestamp (dict) – [REQUIRED]

      The nanosecond-precision end time of the data segment to delete.

      • timeInSeconds (integer) – [REQUIRED]

        The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

      • offsetInNanos (integer) –

        The nanosecond offset from timeInSeconds.

• clientToken (string) –

  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.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'datasetId': 'string',
    'datasetVersion': 'string',
    'errors': [
        {
            'timeSeriesId': 'string',
            'startTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'endTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'errorCode': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'RESOURCE_NOT_FOUND'|'LIMIT_EXCEEDED'|'CONFLICTING_OPERATION',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • datasetId (string) –

    The ID of the dataset.

  • datasetVersion (string) –

    The version of the dataset after deletion.

  • errors (list) –

    A list of data segment deletions that failed.

    • (dict) –

      Contains error information for a data segment deletion that failed.

      • timeSeriesId (string) –

        The ID of the time series.

      • startTimestamp (dict) –

        The nanosecond-precision start time of the data segment.

        • timeInSeconds (integer) –

          The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

        • offsetInNanos (integer) –

          The nanosecond offset from timeInSeconds.

      • endTimestamp (dict) –

        The nanosecond-precision end time of the data segment.

        • timeInSeconds (integer) –

          The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

        • offsetInNanos (integer) –

          The nanosecond offset from timeInSeconds.

      • errorCode (string) –

        The error code for the failed deletion.

      • errorMessage (string) –

        The error message for the failed deletion.

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.ResourceNotFoundException

• IoTSiteWise.Client.exceptions.ConflictingOperationException

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.ThrottlingException