Skip to content
AWS for Query.Farm

aws.iotdeviceadvisor.get_suite_run

Example SQL Queries

SELECT * FROM
aws.iotdeviceadvisor.get_suite_run
WHERE
"suite_definition_id" = 'VALUE'
AND "suite_run_id" = 'VALUE';

Description

Gets information about a Device Advisor test suite run.

Requires permission to access the GetSuiteRun action.

Table Definition

Column NameColumn Data Type
suite_definition_id Required Input Column

Suite definition ID for the test suite run.

VARCHAR
suite_run_id Required Input Column

Suite run ID for the test suite run.

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.

end_time

Date (in Unix epoch time) when the test suite run ended.

TIMESTAMP_S
error_reason

Error reason for any test suite run failure.

VARCHAR
start_time

Date (in Unix epoch time) when the test suite run started.

TIMESTAMP_S
status

Status for the test suite run.

VARCHAR
suite_definition_version

Suite definition version for the test suite run.

VARCHAR
suite_run_arn

The ARN of the suite run.

VARCHAR
suite_run_configuration

Suite run configuration for the test suite run.

STRUCT(
    "primary_device" STRUCT(
        "thing_arn" VARCHAR,
        "certificate_arn" VARCHAR,
        "device_role_arn" VARCHAR
    ),
    "selected_test_list" VARCHAR[],
    "parallel_run" BOOLEAN
)
Show child fields
suite_run_configuration.parallel_run

TRUE if multiple test suites run in parallel.

suite_run_configuration.primary_device

Sets the primary device for the test suite run. This requires a thing ARN or a certificate ARN.

Show child fields
suite_run_configuration.primary_device.certificate_arn

Lists device's certificate ARN.

suite_run_configuration.primary_device.device_role_arn

Lists device's role ARN.

suite_run_configuration.primary_device.thing_arn

Lists device's thing ARN.

suite_run_configuration.selected_test_list[]
tags

The tags attached to the suite run.

MAP(VARCHAR, VARCHAR)
test_result

Test results for the test suite run.

STRUCT(
    "groups" STRUCT(
        "group_id" VARCHAR,
        "group_name" VARCHAR,
        "tests" STRUCT(
            "test_case_run_id" VARCHAR,
            "test_case_definition_id" VARCHAR,
            "test_case_definition_name" VARCHAR,
            "status" VARCHAR,
            "start_time" TIMESTAMP_S,
            "end_time" TIMESTAMP_S,
            "log_url" VARCHAR,
            "warnings" VARCHAR,
            "failure" VARCHAR,
            "test_scenarios" STRUCT(
                "test_case_scenario_id" VARCHAR,
                "test_case_scenario_type" VARCHAR,
                "status" VARCHAR,
                "failure" VARCHAR,
                "system_message" VARCHAR
            )[]
        )[]
    )[]
)
Show child fields
test_result.groups[]
Show child fields
test_result.groups[].group_id

Group result ID.

test_result.groups[].group_name

Group Result Name.

test_result.groups[].tests[]
Show child fields
test_result.groups[].tests[].end_time

Provides test case run end time.

test_result.groups[].tests[].failure

Provides test case run failure result.

test_result.groups[].tests[].log_url

Provides test case run log URL.

test_result.groups[].tests[].start_time

Provides test case run start time.

test_result.groups[].tests[].status

Provides the test case run status. Status is one of the following:

  • PASS: Test passed.

  • FAIL: Test failed.

  • PENDING: Test has not started running but is scheduled.

  • RUNNING: Test is running.

  • STOPPING: Test is performing cleanup steps. You will see this status only if you stop a suite run.

  • STOPPED Test is stopped. You will see this status only if you stop a suite run.

  • PASS_WITH_WARNINGS: Test passed with warnings.

  • ERORR: Test faced an error when running due to an internal issue.

test_result.groups[].tests[].test_case_definition_id

Provides the test case run definition ID.

test_result.groups[].tests[].test_case_definition_name

Provides the test case run definition name.

test_result.groups[].tests[].test_case_run_id

Provides the test case run ID.

test_result.groups[].tests[].test_scenarios[]
Show child fields
test_result.groups[].tests[].test_scenarios[].failure

Provides test case scenario failure result.

test_result.groups[].tests[].test_scenarios[].status

Provides the test case scenario status. Status is one of the following:

  • PASS: Test passed.

  • FAIL: Test failed.

  • PENDING: Test has not started running but is scheduled.

  • RUNNING: Test is running.

  • STOPPING: Test is performing cleanup steps. You will see this status only if you stop a suite run.

  • STOPPED Test is stopped. You will see this status only if you stop a suite run.

  • PASS_WITH_WARNINGS: Test passed with warnings.

  • ERORR: Test faced an error when running due to an internal issue.

test_result.groups[].tests[].test_scenarios[].system_message

Provides test case scenario system messages if any.

test_result.groups[].tests[].test_scenarios[].test_case_scenario_id

Provides test case scenario ID.

test_result.groups[].tests[].test_scenarios[].test_case_scenario_type

Provides test case scenario type. Type is one of the following:

  • Advanced

  • Basic

test_result.groups[].tests[].warnings

Provides test case run warnings.