DeleteSyncJob - IoT TwinMaker

DeleteSyncJob

Delete the SyncJob.

Request Syntax

DELETE /workspaces/workspaceId/sync-jobs/syncSource HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

syncSource

The sync source.

Note

Currently the only supported syncSource is SITEWISE .

Pattern: [a-zA-Z_0-9]+

Required: Yes

workspaceId

The workspace ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "state": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

state

The SyncJob response state.

Type: String

Valid Values: CREATING | INITIALIZING | ACTIVE | DELETING | ERROR

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalServerException

An unexpected error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource wasn't found.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota was exceeded.

HTTP Status Code: 402

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

Failed

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: