Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SyncDeploymentJob

This action has been deprecated.

Important

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

Request Syntax


POST /syncDeploymentJob HTTP/1.1
Content-type: application/json

{
   "clientRequestToken": "string",
   "fleet": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientRequestToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

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

Pattern: [a-zA-Z0-9_\-=]*

Required: Yes

fleet

The target fleet for the synchronization.

Type: String

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

Pattern: arn:.*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "createdAt": number,
   "deploymentApplicationConfigs": [ 
      { 
         "application": "string",
         "applicationVersion": "string",
         "launchConfig": { 
            "environmentVariables": { 
               "string" : "string" 
            },
            "launchFile": "string",
            "packageName": "string",
            "postLaunchFile": "string",
            "preLaunchFile": "string"
         }
      }
   ],
   "deploymentConfig": { 
      "concurrentDeploymentPercentage": number,
      "downloadConditionFile": { 
         "bucket": "string",
         "etag": "string",
         "key": "string"
      },
      "failureThresholdPercentage": number,
      "robotDeploymentTimeoutInSeconds": number
   },
   "failureCode": "string",
   "failureReason": "string",
   "fleet": "string",
   "status": "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 Amazon Resource Name (ARN) of the synchronization request.

Type: String

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

Pattern: arn:.*

createdAt

The time, in milliseconds since the epoch, when the fleet was created.

Type: Timestamp

deploymentApplicationConfigs

Information about the deployment application configurations.

Type: Array of DeploymentApplicationConfig objects

Array Members: Fixed number of 1 item.

deploymentConfig

Information about the deployment configuration.

Type: DeploymentConfig object

failureCode

The failure code if the job fails:

InternalServiceError: Internal service error.
RobotApplicationCrash: Robot application exited abnormally.
SimulationApplicationCrash: Simulation application exited abnormally.
BadPermissionsRobotApplication: Robot application bundle could not be downloaded.
BadPermissionsSimulationApplication: Simulation application bundle could not be downloaded.
BadPermissionsS3Output: Unable to publish outputs to customer-provided S3 bucket.
BadPermissionsCloudwatchLogs: Unable to publish logs to customer-provided CloudWatch Logs resource.
SubnetIpLimitExceeded: Subnet IP limit exceeded.
ENILimitExceeded: ENI limit exceeded.
BadPermissionsUserCredentials: Unable to use the Role provided.
InvalidBundleRobotApplication: Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
InvalidBundleSimulationApplication: Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
RobotApplicationVersionMismatchedEtag: Etag for RobotApplication does not match value during version creation.
SimulationApplicationVersionMismatchedEtag: Etag for SimulationApplication does not match value during version creation.

Type: String

failureReason

The failure reason if the job fails.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

fleet

The Amazon Resource Name (ARN) of the fleet.

Type: String

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

Pattern: arn:.*

status

The status of the synchronization job.

Type: String

Errors

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

ConcurrentDeploymentException

The failure percentage threshold percentage was met.

HTTP Status Code: 400

IdempotentParameterMismatchException

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

HTTP Status Code: 400

InternalServerException

AWS RoboMaker experienced a service issue. Try your call again.

HTTP Status Code: 500

InvalidParameterException

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

HTTP Status Code: 400

LimitExceededException

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 400

ThrottlingException

AWS RoboMaker is temporarily unable to process the request. Try your call again.

HTTP Status Code: 400