---
title: "POST /describeDeploymentJob"
method: POST
path: "/describeDeploymentJob"
deprecated: true
---

# POST /describeDeploymentJob

`POST /describeDeploymentJob`

> **Deprecated.**

Describes a deployment job.

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

## Request body

- object
  - `job` string, required — The Amazon Resource Name (ARN) of the deployment job.

## Response `200`

Success

- DescribeDeploymentJobResponse — Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
  - `arn` string — The Amazon Resource Name (ARN) of the deployment job.
  - `fleet` string — The Amazon Resource Name (ARN) of the fleet.
  - `status` 'Pending' | 'Preparing' | 'InProgress' | 'Failed' | 'Succeeded' | 'Canceled' — The status of the deployment job.
  - `deploymentConfig` object — The deployment configuration.
    - `concurrentDeploymentPercentage` integer — The percentage of robots receiving the deployment at the same time.
    - `failureThresholdPercentage` integer — The percentage of deployments that need to fail before stopping deployment.
    - `robotDeploymentTimeoutInSeconds` integer — The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.
    - `downloadConditionFile` object — The download condition file.
      - `bucket` string, required — The bucket containing the object.
      - `key` string, required — The key of the object.
      - `etag` string — The etag of the object.
  - `deploymentApplicationConfigs` DeploymentApplicationConfig[] — The deployment application configuration.
    - `application` string, required — The Amazon Resource Name (ARN) of the robot application.
    - `applicationVersion` string, required — The version of the application.
    - `launchConfig` object, required — The launch configuration.
      - `packageName` string, required — The package name.
      - `preLaunchFile` string — The deployment pre-launch file. This file will be executed prior to the launch file.
      - `launchFile` string, required — The launch file name.
      - `postLaunchFile` string — The deployment post-launch file. This file will be executed after the launch file.
      - `environmentVariables` object — An array of key/value pairs specifying environment variables for the robot application
  - `failureReason` string — A short description of the reason why the deployment job 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' — The deployment job failure code.
  - `createdAt` string, date-time — The time, in milliseconds since the epoch, when the deployment job was created.
  - `robotDeploymentSummary` RobotDeployment[] — A list of robot deployment summaries.
    - `arn` string — The robot deployment Amazon Resource Name (ARN).
    - `deploymentStartTime` string, date-time — The time, in milliseconds since the epoch, when the deployment was started.
    - `deploymentFinishTime` string, date-time — The time, in milliseconds since the epoch, when the deployment finished.
    - `status` 'Available' | 'Registered' | 'PendingNewDeployment' | 'Deploying' | 'Failed' | 'InSync' | 'NoResponse' — The status of the robot deployment.
    - `progressDetail` object — Information about how the deployment is progressing.
      - `currentProgress` 'Validating' | 'DownloadingExtracting' | 'ExecutingDownloadCondition' | 'ExecutingPreLaunch' | 'Launching' | 'ExecutingPostLaunch' | 'Finished' — <p>The current progress status.</p> <dl> <dt>Validating</dt> <dd> <p>Validating the deployment.</p> </dd> <dt>DownloadingExtracting</dt> <dd> <p>Downloading and extracting the bundle on the robot.</p> </dd> <dt>ExecutingPreLaunch</dt> <dd> <p>Executing pre-launch script(s) if provided.</p> </dd> <dt>Launching</dt> <dd> <p>Launching the robot application.</p> </dd> <dt>ExecutingPostLaunch</dt> <dd> <p>Executing post-launch script(s) if provided.</p> </dd> <dt>Finished</dt> <dd> <p>Deployment is complete.</p> </dd> </dl>
      - `percentDone` number, float — Precentage of the step that is done. This currently only applies to the <code>Downloading/Extracting</code> step of the deployment. It is empty for other steps.
      - `estimatedTimeRemainingSeconds` integer — Estimated amount of time in seconds remaining in the step. This currently only applies to the <code>Downloading/Extracting</code> step of the deployment. It is empty for other steps.
      - `targetResource` string — The Amazon Resource Name (ARN) of the deployment job.
    - `failureReason` string — A short description of the reason why the robot deployment 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' — The robot deployment failure code.
  - `tags` object — The list of all tags added to the specified deployment job.

## Other responses

- `480` — ResourceNotFoundException
- `481` — InvalidParameterException
- `482` — InternalServerException
- `483` — ThrottlingException

---

[API](https://skmtc.net/aws/apis/robomaker.md) · [All operations](https://skmtc.net/aws/apis/robomaker/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/robomaker/versions/a6f68d7d4866/schema)