[ aws . robomaker ]

sync-deployment-job

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  sync-deployment-job
[--client-request-token <value>]
--fleet <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-request-token (string)

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

--fleet (string)

The target fleet for the synchronization.

--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 sync a deployment job

This example synchronizes a deployment job.

Command:

aws robomaker sync-deployment-job --fleet arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/Trek/1539894765711

Output:

{
  "arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-09ccxs3tlfms",
  "fleet": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1539894765711",
  "status": "Pending",
  "deploymentConfig": {
      "concurrentDeploymentPercentage": 20,
      "failureThresholdPercentage": 25
  },
  "deploymentApplicationConfigs": [
      {
          "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1546541208251",
          "applicationVersion": "1",
          "launchConfig": {
              "packageName": "hello_world_simulation",
              "launchFile": "empty_world.launch"
          }
      }
  ],
  "createdAt": 1551286954.0
}

Output

arn -> (string)

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

fleet -> (string)

The Amazon Resource Name (ARN) of the fleet.

status -> (string)

The status of the synchronization job.

deploymentConfig -> (structure)

Information about 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)

Information about the deployment application configurations.

(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)

The failure reason if the job fails.

failureCode -> (string)

The failure code if the job fails:

InternalServiceError

Internal service error.

RobotApplicationCrash

Robot application exited abnormally.

SimulationApplicationCrash

Simulation application exited abnormally.

BadPermissionsRobotApplication

Robot application bundle could not be downloaded.

BadPermissionsSimulationApplication

Simulation application bundle could not be downloaded.

BadPermissionsS3Output

Unable to publish outputs to customer-provided S3 bucket.

BadPermissionsCloudwatchLogs

Unable to publish logs to customer-provided CloudWatch Logs resource.

SubnetIpLimitExceeded

Subnet IP limit exceeded.

ENILimitExceeded

ENI limit exceeded.

BadPermissionsUserCredentials

Unable to use the Role provided.

InvalidBundleRobotApplication

Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

InvalidBundleSimulationApplication

Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

RobotApplicationVersionMismatchedEtag

Etag for RobotApplication does not match value during version creation.

SimulationApplicationVersionMismatchedEtag

Etag for SimulationApplication does not match value during version creation.

createdAt -> (timestamp)

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