v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1457289301.4 KB

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

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

post/syncDeploymentJob

Request body

clientRequestTokenstring required

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

fleetstring required

The target fleet for the synchronization.

Response

Success

arnstring

The Amazon Resource Name (ARN) of the synchronization request.

fleetstring

The Amazon Resource Name (ARN) of the fleet.

status'Pending' | 'Preparing' | 'InProgress' | 'Failed' | 'Succeeded' | 'Canceled'

The status of the synchronization job.

failureReasonstring

The failure reason if the job fails.

failureCode'ResourceNotFound' | 'EnvironmentSetupError' | 'EtagMismatch' | 'FailureThresholdBreached' | 'RobotDeploymentAborted' | 'RobotDeploymentNoResponse' | 'RobotAgentConnectionTimeout' | 'GreengrassDeploymentFailed' | 'InvalidGreengrassGroup' | 'MissingRobotArchitecture' | 'MissingRobotApplicationArchitecture' | 'MissingRobotDeploymentResource' | 'GreengrassGroupVersionDoesNotExist' | 'LambdaDeleted' | 'ExtractingBundleFailure' | 'PreLaunchFileFailure' | 'PostLaunchFileFailure' | 'BadPermissionError' | 'DownloadConditionFailed' | 'BadLambdaAssociated' | 'InternalServerError' | 'RobotApplicationDoesNotExist' | 'DeploymentFleetDoesNotExist' | 'FleetDeploymentTimeout'
<p>The failure code if the job fails:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>RobotApplicationCrash</dt> <dd> <p>Robot application exited abnormally.</p> </dd> <dt>SimulationApplicationCrash</dt> <dd> <p> Simulation application exited abnormally.</p> </dd> <dt>BadPermissionsRobotApplication</dt> <dd> <p>Robot application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsSimulationApplication</dt> <dd> <p>Simulation application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsS3Output</dt> <dd> <p>Unable to publish outputs to customer-provided S3 bucket.</p> </dd> <dt>BadPermissionsCloudwatchLogs</dt> <dd> <p>Unable to publish logs to customer-provided CloudWatch Logs resource.</p> </dd> <dt>SubnetIpLimitExceeded</dt> <dd> <p>Subnet IP limit exceeded.</p> </dd> <dt>ENILimitExceeded</dt> <dd> <p>ENI limit exceeded.</p> </dd> <dt>BadPermissionsUserCredentials</dt> <dd> <p>Unable to use the Role provided.</p> </dd> <dt>InvalidBundleRobotApplication</dt> <dd> <p>Robot bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>InvalidBundleSimulationApplication</dt> <dd> <p>Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>RobotApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for RobotApplication does not match value during version creation.</p> </dd> <dt>SimulationApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for SimulationApplication does not match value during version creation.</p> </dd> </dl>
createdAtstring date-time

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