Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1457289301.4 KB

Deploys a specific version of a robot application to robots in a fleet.

This API is no longer supported and will throw an error if used.

The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version.

After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.

post/createDeploymentJob

Request body

clientRequestTokenstring required

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

fleetstring required

The Amazon Resource Name (ARN) of the fleet to deploy.

tagsobject

A map that contains tag keys and tag values that are attached to the deployment job.

Response

Success

arnstring

The Amazon Resource Name (ARN) of the deployment job.

fleetstring

The target fleet for the deployment job.

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

The status of the deployment job.

failureReasonstring

The failure reason of the deployment job if it failed.

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 of the simulation job if it failed:</p> <dl> <dt>BadPermissionError</dt> <dd> <p>AWS Greengrass requires a service-level role permission to access other services. The role must include the <a href="https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor"> <code>AWSGreengrassResourceAccessRolePolicy</code> managed policy</a>. </p> </dd> <dt>ExtractingBundleFailure</dt> <dd> <p>The robot application could not be extracted from the bundle.</p> </dd> <dt>FailureThresholdBreached</dt> <dd> <p>The percentage of robots that could not be updated exceeded the percentage set for the deployment.</p> </dd> <dt>GreengrassDeploymentFailed</dt> <dd> <p>The robot application could not be deployed to the robot.</p> </dd> <dt>GreengrassGroupVersionDoesNotExist</dt> <dd> <p>The AWS Greengrass group or version associated with a robot is missing.</p> </dd> <dt>InternalServerError</dt> <dd> <p>An internal error has occurred. Retry your request, but if the problem persists, contact us with details.</p> </dd> <dt>MissingRobotApplicationArchitecture</dt> <dd> <p>The robot application does not have a source that matches the architecture of the robot.</p> </dd> <dt>MissingRobotDeploymentResource</dt> <dd> <p>One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?</p> </dd> <dt>PostLaunchFileFailure</dt> <dd> <p>The post-launch script failed.</p> </dd> <dt>PreLaunchFileFailure</dt> <dd> <p>The pre-launch script failed.</p> </dd> <dt>ResourceNotFound</dt> <dd> <p>One or more deployment resources are missing. For example, do robot application source bundles still exist? </p> </dd> <dt>RobotDeploymentNoResponse</dt> <dd> <p>There is no response from the robot. It might not be powered on or connected to the internet.</p> </dd> </dl>
createdAtstring date-time

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

tagsobject

The list of all tags added to the deployment job.