Skip to content
AWS for Query.Farm

aws.robomaker.describe_deployment_job

Example SQL Queries

SELECT * FROM
aws.robomaker.describe_deployment_job
WHERE
"job" = 'VALUE';

Description

Describes a deployment job.

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

Table Definition

Column NameColumn Data Type
job Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

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

VARCHAR
created_at

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

TIMESTAMP_S
deployment_application_configs

The deployment application configuration.

STRUCT(
    "application" VARCHAR,
    "application_version" VARCHAR,
    "launch_config" STRUCT(
        "package_name" VARCHAR,
        "pre_launch_file" VARCHAR,
        "launch_file" VARCHAR,
        "post_launch_file" VARCHAR,
        "environment_variables" MAP(VARCHAR, VARCHAR)
    )
)[]
Show child fields
deployment_application_configs[]
Show child fields
deployment_application_configs[].application

The Amazon Resource Name (ARN) of the robot application.

deployment_application_configs[].application_version

The version of the application.

deployment_application_configs[].launch_config

The launch configuration.

Show child fields
deployment_application_configs[].launch_config.environment_variables

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

deployment_application_configs[].launch_config.launch_file

The launch file name.

deployment_application_configs[].launch_config.package_name

The package name.

deployment_application_configs[].launch_config.post_launch_file

The deployment post-launch file. This file will be executed after the launch file.

deployment_application_configs[].launch_config.pre_launch_file

The deployment pre-launch file. This file will be executed prior to the launch file.

deployment_config

The deployment configuration.

STRUCT(
    "concurrent_deployment_percentage" BIGINT,
    "failure_threshold_percentage" BIGINT,
    "robot_deployment_timeout_in_seconds" BIGINT,
    "download_condition_file" STRUCT(
        "bucket" VARCHAR,
        "key" VARCHAR,
        "etag" VARCHAR
    )
)
Show child fields
deployment_config.concurrent_deployment_percentage

The percentage of robots receiving the deployment at the same time.

deployment_config.download_condition_file

The download condition file.

Show child fields
deployment_config.download_condition_file.bucket

The bucket containing the object.

deployment_config.download_condition_file.etag

The etag of the object.

deployment_config.download_condition_file.key

The key of the object.

deployment_config.failure_threshold_percentage

The percentage of deployments that need to fail before stopping deployment.

deployment_config.robot_deployment_timeout_in_seconds

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.

failure_code

The deployment job failure code.

VARCHAR
failure_reason

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

VARCHAR
fleet

The Amazon Resource Name (ARN) of the fleet.

VARCHAR
robot_deployment_summary

A list of robot deployment summaries.

STRUCT(
    "arn" VARCHAR,
    "deployment_start_time" TIMESTAMP_S,
    "deployment_finish_time" TIMESTAMP_S,
    "status" VARCHAR,
    "progress_detail" STRUCT(
        "current_progress" VARCHAR,
        "percent_done" DOUBLE,
        "estimated_time_remaining_seconds" BIGINT,
        "target_resource" VARCHAR
    ),
    "failure_reason" VARCHAR,
    "failure_code" VARCHAR
)[]
Show child fields
robot_deployment_summary[]
Show child fields
robot_deployment_summary[].arn

The robot deployment Amazon Resource Name (ARN).

robot_deployment_summary[].deployment_finish_time

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

robot_deployment_summary[].deployment_start_time

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

robot_deployment_summary[].failure_code

The robot deployment failure code.

robot_deployment_summary[].failure_reason

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

robot_deployment_summary[].progress_detail

Information about how the deployment is progressing.

Show child fields
robot_deployment_summary[].progress_detail.current_progress

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.

robot_deployment_summary[].progress_detail.estimated_time_remaining_seconds

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.

robot_deployment_summary[].progress_detail.percent_done

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.

robot_deployment_summary[].progress_detail.target_resource

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

robot_deployment_summary[].status

The status of the robot deployment.

status

The status of the deployment job.

VARCHAR
tags

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

MAP(VARCHAR, VARCHAR)