Skip to content
AWS for Query.Farm

aws.mgn.describe_jobs

Example SQL Queries

SELECT * FROM
aws.mgn.describe_jobs;

Description

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

Table Definition

Column NameColumn Data Type
account_id Input Column

Request to describe job log items by Account ID.

VARCHAR
filters Input Column

Request to describe Job log filters.

STRUCT(
    "from_date" VARCHAR,
    "job_i_ds" VARCHAR[],
    "to_date" VARCHAR
)
Show child fields
filters.from_date

Request to describe Job log filters by date.

filters.job_i_ds[]
filters.to_date

Request to describe job log items by last date.

_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 ARN of the specific Job.

VARCHAR
creation_date_time

Job creation time.

VARCHAR
end_date_time

Job end time.

VARCHAR
initiated_by

Job initiated by field.

VARCHAR
job_id

Job ID.

VARCHAR
participating_servers

Servers participating in a specific Job.

STRUCT(
    "launch_status" VARCHAR,
    "launched_ec2_instance_id" VARCHAR,
    "post_launch_actions_status" STRUCT(
        "post_launch_actions_launch_status_list" STRUCT(
            "execution_id" VARCHAR,
            "execution_status" VARCHAR,
            "failure_reason" VARCHAR,
            "ssm_document" STRUCT(
                "action_name" VARCHAR,
                "external_parameters" MAP(VARCHAR, STRUCT(
                        "dynamic_path" VARCHAR
                    )),
                "must_succeed_for_cutover" BOOLEAN,
                "parameters" MAP(VARCHAR, STRUCT(
                        "parameter_name" VARCHAR,
                        "parameter_type" VARCHAR
                    )[]),
                "ssm_document_name" VARCHAR,
                "timeout_seconds" BIGINT
            ),
            "ssm_document_type" VARCHAR
        )[],
        "ssm_agent_discovery_datetime" VARCHAR
    ),
    "source_server_id" VARCHAR
)[]
Show child fields
participating_servers[]
Show child fields
participating_servers[].launch_status

Participating server launch status.

participating_servers[].launched_ec2_instance_id

Participating server's launched ec2 instance ID.

participating_servers[].post_launch_actions_status

Participating server's Post Launch Actions Status.

Show child fields
participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[]
Show child fields
participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].execution_id

AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.

participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].execution_status

AWS Systems Manager Document's execution status.

participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].failure_reason

AWS Systems Manager Document's failure reason.

participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].ssm_document

AWS Systems Manager's Document of the of the Job Post Launch Actions.

Show child fields
participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].ssm_document.action_name

User-friendly name for the AWS Systems Manager Document.

participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].ssm_document.external_parameters

AWS Systems Manager Document external parameters.

participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].ssm_document.must_succeed_for_cutover

If true, Cutover will not be enabled if the document has failed.

participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].ssm_document.parameters

AWS Systems Manager Document parameters.

participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].ssm_document.ssm_document_name

AWS Systems Manager Document name or full ARN.

participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].ssm_document.timeout_seconds

AWS Systems Manager Document timeout seconds.

participating_servers[].post_launch_actions_status.post_launch_actions_launch_status_list[].ssm_document_type

AWS Systems Manager Document type.

participating_servers[].post_launch_actions_status.ssm_agent_discovery_datetime

Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.

participating_servers[].source_server_id

Participating server Source Server ID.

status

Job status.

VARCHAR
tags

Tags associated with specific Job.

MAP(VARCHAR, VARCHAR)
type

Job type.

VARCHAR