| CARVIEW |
CreateSyncJob
This action creates a SyncJob.
Request Syntax
POST /workspaces/workspaceId/sync-jobs/syncSource HTTP/1.1
Content-type: application/json
{
"syncRole": "string",
"tags": {
"string" : "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- syncSource
-
The sync source.
Note
Currently the only supported syncSoource 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 accepts the following data in JSON format.
- syncRole
-
The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.
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/.*Required: Yes
- tags
-
The SyncJob tags.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Value Length Constraints: Minimum length of 1. Maximum length of 256.
Value Pattern:
.*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationDateTime": number,
"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.
- arn
-
The SyncJob 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 date and time for the SyncJob creation.
Type: Timestamp
- 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
- ConflictException
-
A conflict occurred.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error has occurred.
HTTP Status Code: 500
- 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:
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.