RoboMaker / Client / sync_deployment_job

sync_deployment_job

RoboMaker.Client.sync_deployment_job(**kwargs)

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

Warning

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

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.sync_deployment_job(
    clientRequestToken='string',
    fleet='string'
)

Parameters:

• clientRequestToken (string) –

  [REQUIRED]

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

  This field is autopopulated if not provided.

• fleet (string) –

  [REQUIRED]

  The target fleet for the synchronization.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'fleet': 'string',
    'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
    'deploymentConfig': {
        'concurrentDeploymentPercentage': 123,
        'failureThresholdPercentage': 123,
        'robotDeploymentTimeoutInSeconds': 123,
        'downloadConditionFile': {
            'bucket': 'string',
            'key': 'string',
            'etag': 'string'
        }
    },
    'deploymentApplicationConfigs': [
        {
            'application': 'string',
            'applicationVersion': 'string',
            'launchConfig': {
                'packageName': 'string',
                'preLaunchFile': 'string',
                'launchFile': 'string',
                'postLaunchFile': 'string',
                'environmentVariables': {
                    'string': 'string'
                }
            }
        },
    ],
    'failureReason': 'string',
    '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',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • 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 (dict) –

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

      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.

    • (dict) –

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

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

          An array of key/value pairs specifying environment variables for the robot application

          • (string) –

            • (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 (datetime) –

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

Exceptions

• RoboMaker.Client.exceptions.ResourceNotFoundException

• RoboMaker.Client.exceptions.InvalidParameterException

• RoboMaker.Client.exceptions.InternalServerException

• RoboMaker.Client.exceptions.ThrottlingException

• RoboMaker.Client.exceptions.LimitExceededException

• RoboMaker.Client.exceptions.ConcurrentDeploymentException

• RoboMaker.Client.exceptions.IdempotentParameterMismatchException