IoTSiteWise / Client / delete_workspace

delete_workspace

IoTSiteWise.Client.delete_workspace(**kwargs)

Deletes a workspace. Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time series, pipelines, and tasks.

See also: AWS API Documentation

Request Syntax

response = client.delete_workspace(
    workspaceName='string',
    clientToken='string'
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

    The name of the workspace to delete.

  • 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

{
    'workspaceStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • workspaceStatus (dict) –

      The status of the workspace after the deletion request, which is DELETING when the operation returns.

      • state (string) –

        The current state of the workspace.

      • error (dict) –

        Contains associated error information, if any.

        • code (string) –

          The error code.

        • message (string) –

          The error message.

Exceptions