describe-deployment-job¶
Description¶
Describes a deployment job.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-deployment-job
--job <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--job (string)
The Amazon Resource Name (ARN) of the deployment job.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To describe a deployment job
The following describe-deployment-job example retrieves the details about the specified deployment job.
aws robomaker describe-deployment-job \
--job arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-xl8qssl6pbcn
Output:
{
"arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-xl8qssl6pbcn",
"fleet": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/Trek/1539894765711",
"status": "InProgress",
"deploymentConfig": {
"concurrentDeploymentPercentage": 20,
"failureThresholdPercentage": 25
},
"deploymentApplicationConfigs": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/RoboMakerHelloWorldRobot/1546541208251",
"applicationVersion": "1",
"launchConfig": {
"packageName": "hello_world_robot",
"launchFile": "rotate.launch"
}
}
],
"createdAt": 1551218369.0,
"robotDeploymentSummary": [
{
"arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1540834232469",
"deploymentStartTime": 1551218376.0,
"status": "Deploying",
"progressDetail": {}
}
],
"tags": {}
}
Output¶
arn -> (string)
The Amazon Resource Name (ARN) of the deployment job.
fleet -> (string)
The Amazon Resource Name (ARN) of the fleet.
status -> (string)
The status of the deployment job.
deploymentConfig -> (structure)
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 -> (long)
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 -> (structure)
The download condition file.
bucket -> (string)
The bucket containing the object.
key -> (string)
The key of the object.
etag -> (string)
The etag of the object.
deploymentApplicationConfigs -> (list)
The deployment application configuration.
(structure)
Information about a deployment application configuration.
application -> (string)
The Amazon Resource Name (ARN) of the robot application.
applicationVersion -> (string)
The version of the application.
launchConfig -> (structure)
The launch configuration.
packageName -> (string)
The package name.
preLaunchFile -> (string)
The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile -> (string)
The launch file name.
postLaunchFile -> (string)
The deployment post-launch file. This file will be executed after the launch file.
environmentVariables -> (map)
An array of key/value pairs specifying environment variables for the robot application
key -> (string)
value -> (string)
failureReason -> (string)
A short description of the reason why the deployment job failed.
failureCode -> (string)
The deployment job failure code.
createdAt -> (timestamp)
The time, in milliseconds since the epoch, when the deployment job was created.
robotDeploymentSummary -> (list)
A list of robot deployment summaries.
(structure)
Information about a robot deployment.
arn -> (string)
The robot deployment Amazon Resource Name (ARN).
deploymentStartTime -> (timestamp)
The time, in milliseconds since the epoch, when the deployment was started.
deploymentFinishTime -> (timestamp)
The time, in milliseconds since the epoch, when the deployment finished.
status -> (string)
The status of the robot deployment.
progressDetail -> (structure)
Information about how the deployment is progressing.
currentProgress -> (string)
The current progress status.
Validating
Validating the deployment.
DownloadingExtracting
Downloading and extracting the bundle on the robot.
ExecutingPreLaunch
Executing pre-launch script(s) if provided.
Launching
Launching the robot application.
ExecutingPostLaunch
Executing post-launch script(s) if provided.
Finished
Deployment is complete.
percentDone -> (float)
Precentage of the step that is done. This currently only applies to the
Downloading/Extractingstep 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
Downloading/Extractingstep 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 -> (string)
The robot deployment failure code.
tags -> (map)
The list of all tags added to the specified deployment job.
key -> (string)
value -> (string)