RoboMaker / Client / describe_deployment_job

describe_deployment_job

RoboMaker.Client.describe_deployment_job(**kwargs)

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.

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.describe_deployment_job(
    job='string'
)

Parameters:

job (string) –

[REQUIRED]

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

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),
    'robotDeploymentSummary': [
        {
            'arn': 'string',
            'deploymentStartTime': datetime(2015, 1, 1),
            'deploymentFinishTime': datetime(2015, 1, 1),
            'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
            'progressDetail': {
                'currentProgress': 'Validating'|'DownloadingExtracting'|'ExecutingDownloadCondition'|'ExecutingPreLaunch'|'Launching'|'ExecutingPostLaunch'|'Finished',
                'percentDone': ...,
                'estimatedTimeRemainingSeconds': 123,
                'targetResource': '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'
        },
    ],
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

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

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

    The deployment application configuration.

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

    A short description of the reason why the deployment job failed.

  • failureCode (string) –

    The deployment job failure code.

  • createdAt (datetime) –

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

  • robotDeploymentSummary (list) –

    A list of robot deployment summaries.

    • (dict) –

      Information about a robot deployment.

      • arn (string) –

        The robot deployment Amazon Resource Name (ARN).

      • deploymentStartTime (datetime) –

        The time, in milliseconds since the epoch, when the deployment was started.

      • deploymentFinishTime (datetime) –

        The time, in milliseconds since the epoch, when the deployment finished.

      • status (string) –

        The status of the robot deployment.

      • progressDetail (dict) –

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

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

    • (string) –

      • (string) –

Exceptions

• RoboMaker.Client.exceptions.ResourceNotFoundException

• RoboMaker.Client.exceptions.InvalidParameterException

• RoboMaker.Client.exceptions.InternalServerException

• RoboMaker.Client.exceptions.ThrottlingException