Skip to content
AWS for Query.Farm

aws.iotdeviceadvisor.get_suite_definition

Example SQL Queries

SELECT * FROM
aws.iotdeviceadvisor.get_suite_definition
WHERE
"suite_definition_id" = 'VALUE';

Description

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition action.

Table Definition

Column NameColumn Data Type
suite_definition_id Required Input Column

Suite definition ID of the suite definition.

VARCHAR
suite_definition_version Input Column

Suite definition version of the suite definition.

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.

created_at

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

TIMESTAMP_S
last_modified_at

Date (in Unix epoch time) when the suite definition was last modified.

TIMESTAMP_S
latest_version

Latest suite definition version of the suite definition.

VARCHAR
suite_definition_arn

The ARN of the suite definition.

VARCHAR
suite_definition_configuration

Suite configuration of the suite definition.

STRUCT(
    "suite_definition_name" VARCHAR,
    "devices" STRUCT(
        "thing_arn" VARCHAR,
        "certificate_arn" VARCHAR,
        "device_role_arn" VARCHAR
    )[],
    "intended_for_qualification" BOOLEAN,
    "is_long_duration_test" BOOLEAN,
    "root_group" VARCHAR,
    "device_permission_role_arn" VARCHAR,
    "protocol" VARCHAR
)
Show child fields
suite_definition_configuration.device_permission_role_arn

Gets the device permission ARN. This is a required parameter.

suite_definition_configuration.devices[]
Show child fields
suite_definition_configuration.devices[].certificate_arn

Lists device's certificate ARN.

suite_definition_configuration.devices[].device_role_arn

Lists device's role ARN.

suite_definition_configuration.devices[].thing_arn

Lists device's thing ARN.

suite_definition_configuration.intended_for_qualification

Gets the tests intended for qualification in a suite.

suite_definition_configuration.is_long_duration_test

Verifies if the test suite is a long duration test.

suite_definition_configuration.protocol

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

suite_definition_configuration.root_group

Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if intendedForQualification is set to true, rootGroup can be an empty string. If intendedForQualification is false, rootGroup cannot be an empty string. If rootGroup is empty, and intendedForQualification is set to true, all the qualification tests are included, and the configuration is default.

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

suite_definition_configuration.suite_definition_name

Gets the suite definition name. This is a required parameter.

tags

Tags attached to the suite definition.

MAP(VARCHAR, VARCHAR)