AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . robomaker ]

describe-deployment-job

Description

Describes a deployment job.

Warning

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

See also: AWS API Documentation

Synopsis

  describe-deployment-job
--job <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--job (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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/Extracting 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 Downloading/Extracting 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 -> (string)

The robot deployment failure code.

tags -> (map)

The list of all tags added to the specified deployment job.

key -> (string)

value -> (string)