IoTTwinMaker / Client / delete_sync_job

delete_sync_job#

IoTTwinMaker.Client.delete_sync_job(**kwargs)#

Delete the SyncJob.

See also: AWS API Documentation

Request Syntax

response = client.delete_sync_job(
    workspaceId='string',
    syncSource='string'
)
Parameters:

  • workspaceId (string) –

    [REQUIRED]

    The workspace ID.

  • syncSource (string) –

    [REQUIRED]

    The sync source.

    Note

    Currently the only supported syncSource is ``SITEWISE ``.

Return type:

dict

Returns:

Response Syntax

{
    'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR'
}

Response Structure

  • (dict) –

    • state (string) –

      The SyncJob response state.

Exceptions

  • IoTTwinMaker.Client.exceptions.InternalServerException

  • IoTTwinMaker.Client.exceptions.AccessDeniedException

  • IoTTwinMaker.Client.exceptions.ResourceNotFoundException

  • IoTTwinMaker.Client.exceptions.ThrottlingException

  • IoTTwinMaker.Client.exceptions.ValidationException

  • IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException