Skip to content
AWS for Query.Farm

aws.iotdeviceadvisor.list_suite_definitions

Example SQL Queries

SELECT * FROM
aws.iotdeviceadvisor.list_suite_definitions;

Description

Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions action.

Table Definition

Column NameColumn Data Type
max_results Input Column

The maximum number of results to return at once.

BIGINT
next_token Input Column

A token used to get the next set of results.

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.

suite_definition_information_list

An array of objects that provide summaries of information about the suite definitions in the list.

STRUCT(
    "suite_definition_id" VARCHAR,
    "suite_definition_name" VARCHAR,
    "default_devices" STRUCT(
        "thing_arn" VARCHAR,
        "certificate_arn" VARCHAR,
        "device_role_arn" VARCHAR
    )[],
    "intended_for_qualification" BOOLEAN,
    "is_long_duration_test" BOOLEAN,
    "protocol" VARCHAR,
    "created_at" TIMESTAMP_S
)[]
Show child fields
suite_definition_information_list[]
Show child fields
suite_definition_information_list[].created_at

Date (in Unix epoch time) when the test suite was created.

suite_definition_information_list[].default_devices[]
Show child fields
suite_definition_information_list[].default_devices[].certificate_arn

Lists device's certificate ARN.

suite_definition_information_list[].default_devices[].device_role_arn

Lists device's role ARN.

suite_definition_information_list[].default_devices[].thing_arn

Lists device's thing ARN.

suite_definition_information_list[].intended_for_qualification

Specifies if the test suite is intended for qualification.

suite_definition_information_list[].is_long_duration_test

Verifies if the test suite is a long duration test.

suite_definition_information_list[].protocol

Gets the MQTT protocol that is configured in the suite definition.

suite_definition_information_list[].suite_definition_id

Suite definition ID of the test suite.

suite_definition_information_list[].suite_definition_name

Suite name of the test suite.