IoTSiteWise / Client / delete_dataset

delete_dataset#

IoTSiteWise.Client.delete_dataset(**kwargs)#

Deletes a dataset. This cannot be undone.

Request Syntax

response = client.delete_dataset(
    datasetId='string',
    clientToken='string'
)

Parameters:

datasetId (string) –
[REQUIRED]

The ID of the dataset.
clientToken (string) –
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.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'datasetStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string',
            'details': [
                {
                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message': 'string'
                },
            ]
        }
    }
}

Response Structure

(dict) –
- datasetStatus (dict) –
  
  The status of the dataset. This contains the state and any error messages. State is DELETING after a successfull call to this API, and any associated error message.
  - state (string) –
    
    The current status of the dataset.
  - error (dict) –
    
    Contains the details of an IoT SiteWise error.
    - code (string) –
      
      The error code.
    - message (string) –
      
      The error message.
    - details (list) –
      
      A list of detailed errors.
      - (dict) –
        
        Contains detailed error information.
        
        code (string) –
        
        The error code.
        
        message (string) –
        
        The error message.

Exceptions

IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.ThrottlingException
IoTSiteWise.Client.exceptions.ConflictingOperationException