GetSyncJob
Gets the SyncJob.
Request Syntax
GET /sync-jobs/syncSource?workspace=workspaceId 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]+
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationDateTime": number,
"status": {
"error": {
"code": "string",
"message": "string"
},
"state": "string"
},
"syncRole": "string",
"syncSource": "string",
"updateDateTime": number,
"workspaceId": "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.
- arn
-
The sync job ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+ - creationDateTime
-
The creation date and time.
Type: Timestamp
- status
-
The SyncJob response status.
Type: SyncJobStatus object
- syncRole
-
The sync IAM role.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.* - syncSource
-
The sync source.
Note
Currently the only supported syncSource is
SITEWISE.Type: String
Pattern:
[a-zA-Z_0-9]+ - updateDateTime
-
The update date and time.
Type: Timestamp
- workspaceId
-
The ID of the workspace that contains the sync job.
Type: String
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]+
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:
