SDK for PHP 3.x

AWS IoT Core Device Advisor 2020-09-18

Client: Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
Service ID: iotdeviceadvisor
Version: 2020-09-18

This page describes the parameters and results for the operations of the AWS IoT Core Device Advisor (2020-09-18), and shows how to use the Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient object to call the described operations. This documentation is specific to the 2020-09-18 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateSuiteDefinition ( array $params = [] )
Creates a Device Advisor test suite.
DeleteSuiteDefinition ( array $params = [] )
Deletes a Device Advisor test suite.
GetEndpoint ( array $params = [] )
Gets information about an Device Advisor endpoint.
GetSuiteDefinition ( array $params = [] )
Gets information about a Device Advisor test suite.
GetSuiteRun ( array $params = [] )
Gets information about a Device Advisor test suite run.
GetSuiteRunReport ( array $params = [] )
Gets a report download link for a successful Device Advisor qualifying test suite run.
ListSuiteDefinitions ( array $params = [] )
Lists the Device Advisor test suites you have created.
ListSuiteRuns ( array $params = [] )
Lists runs of the specified Device Advisor test suite.
ListTagsForResource ( array $params = [] )
Lists the tags attached to an IoT Device Advisor resource.
StartSuiteRun ( array $params = [] )
Starts a Device Advisor test suite run.
StopSuiteRun ( array $params = [] )
Stops a Device Advisor test suite run that is currently running.
TagResource ( array $params = [] )
Adds to and modifies existing tags of an IoT Device Advisor resource.
UntagResource ( array $params = [] )
Removes tags from an IoT Device Advisor resource.
UpdateSuiteDefinition ( array $params = [] )
Updates a Device Advisor test suite.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListSuiteDefinitions
ListSuiteRuns

Operations

CreateSuiteDefinition 

$result = $client->createSuiteDefinition([/* ... */]);
$promise = $client->createSuiteDefinitionAsync([/* ... */]);

Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition action.

Parameter Syntax

$result = $client->createSuiteDefinition([
    'suiteDefinitionConfiguration' => [ // REQUIRED
        'devicePermissionRoleArn' => '<string>', // REQUIRED
        'devices' => [
            [
                'certificateArn' => '<string>',
                'deviceRoleArn' => '<string>',
                'thingArn' => '<string>',
            ],
            // ...
        ],
        'intendedForQualification' => true || false,
        'isLongDurationTest' => true || false,
        'protocol' => 'MqttV3_1_1|MqttV5|MqttV3_1_1_OverWebSocket|MqttV5_OverWebSocket',
        'rootGroup' => '<string>', // REQUIRED
        'suiteDefinitionName' => '<string>', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
suiteDefinitionConfiguration
Required: Yes
Type: SuiteDefinitionConfiguration structure

Creates a Device Advisor test suite with suite definition configuration.

tags
Type: Associative array of custom strings keys (String128) to strings

The tags to be attached to the suite definition.

Result Syntax

[
    'createdAt' => <DateTime>,
    'suiteDefinitionArn' => '<string>',
    'suiteDefinitionId' => '<string>',
    'suiteDefinitionName' => '<string>',
]

Result Details

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the test suite was created.

suiteDefinitionArn
Type: string

The Amazon Resource Name (ARN) of the test suite.

suiteDefinitionId
Type: string

The UUID of the test suite created.

suiteDefinitionName
Type: string

The suite definition name of the test suite. This is a required parameter.

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.

DeleteSuiteDefinition 

$result = $client->deleteSuiteDefinition([/* ... */]);
$promise = $client->deleteSuiteDefinitionAsync([/* ... */]);

Deletes a Device Advisor test suite.

Requires permission to access the DeleteSuiteDefinition action.

Parameter Syntax

$result = $client->deleteSuiteDefinition([
    'suiteDefinitionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
suiteDefinitionId
Required: Yes
Type: string

Suite definition ID of the test suite to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.

GetEndpoint 

$result = $client->getEndpoint([/* ... */]);
$promise = $client->getEndpointAsync([/* ... */]);

Gets information about an Device Advisor endpoint.

Parameter Syntax

$result = $client->getEndpoint([
    'authenticationMethod' => 'X509ClientCertificate|SignatureVersion4',
    'certificateArn' => '<string>',
    'deviceRoleArn' => '<string>',
    'thingArn' => '<string>',
]);

Parameter Details

Members
authenticationMethod
Type: string

The authentication method used during the device connection.

certificateArn
Type: string

The certificate ARN of the device. This is an optional parameter.

deviceRoleArn
Type: string

The device role ARN of the device. This is an optional parameter.

thingArn
Type: string

The thing ARN of the device. This is an optional parameter.

Result Syntax

[
    'endpoint' => '<string>',
]

Result Details

Members
endpoint
Type: string

The response of an Device Advisor endpoint.

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.

ResourceNotFoundException:

Sends a Resource Not Found exception.

GetSuiteDefinition 

$result = $client->getSuiteDefinition([/* ... */]);
$promise = $client->getSuiteDefinitionAsync([/* ... */]);

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition action.

Parameter Syntax

$result = $client->getSuiteDefinition([
    'suiteDefinitionId' => '<string>', // REQUIRED
    'suiteDefinitionVersion' => '<string>',
]);

Parameter Details

Members
suiteDefinitionId
Required: Yes
Type: string

Suite definition ID of the test suite to get.

suiteDefinitionVersion
Type: string

Suite definition version of the test suite to get.

Result Syntax

[
    'createdAt' => <DateTime>,
    'lastModifiedAt' => <DateTime>,
    'latestVersion' => '<string>',
    'suiteDefinitionArn' => '<string>',
    'suiteDefinitionConfiguration' => [
        'devicePermissionRoleArn' => '<string>',
        'devices' => [
            [
                'certificateArn' => '<string>',
                'deviceRoleArn' => '<string>',
                'thingArn' => '<string>',
            ],
            // ...
        ],
        'intendedForQualification' => true || false,
        'isLongDurationTest' => true || false,
        'protocol' => 'MqttV3_1_1|MqttV5|MqttV3_1_1_OverWebSocket|MqttV5_OverWebSocket',
        'rootGroup' => '<string>',
        'suiteDefinitionName' => '<string>',
    ],
    'suiteDefinitionId' => '<string>',
    'suiteDefinitionVersion' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

lastModifiedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

latestVersion
Type: string

Latest suite definition version of the suite definition.

suiteDefinitionArn
Type: string

The ARN of the suite definition.

suiteDefinitionConfiguration
Type: SuiteDefinitionConfiguration structure

Suite configuration of the suite definition.

suiteDefinitionId
Type: string

Suite definition ID of the suite definition.

suiteDefinitionVersion
Type: string

Suite definition version of the suite definition.

tags
Type: Associative array of custom strings keys (String128) to strings

Tags attached to the suite definition.

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.

ResourceNotFoundException:

Sends a Resource Not Found exception.

GetSuiteRun 

$result = $client->getSuiteRun([/* ... */]);
$promise = $client->getSuiteRunAsync([/* ... */]);

Gets information about a Device Advisor test suite run.

Requires permission to access the GetSuiteRun action.

Parameter Syntax

$result = $client->getSuiteRun([
    'suiteDefinitionId' => '<string>', // REQUIRED
    'suiteRunId' => '<string>', // REQUIRED
]);

Parameter Details

Members
suiteDefinitionId
Required: Yes
Type: string

Suite definition ID for the test suite run.

suiteRunId
Required: Yes
Type: string

Suite run ID for the test suite run.

Result Syntax

[
    'endTime' => <DateTime>,
    'errorReason' => '<string>',
    'startTime' => <DateTime>,
    'status' => 'PASS|FAIL|CANCELED|PENDING|RUNNING|STOPPING|STOPPED|PASS_WITH_WARNINGS|ERROR',
    'suiteDefinitionId' => '<string>',
    'suiteDefinitionVersion' => '<string>',
    'suiteRunArn' => '<string>',
    'suiteRunConfiguration' => [
        'parallelRun' => true || false,
        'primaryDevice' => [
            'certificateArn' => '<string>',
            'deviceRoleArn' => '<string>',
            'thingArn' => '<string>',
        ],
        'selectedTestList' => ['<string>', ...],
    ],
    'suiteRunId' => '<string>',
    'tags' => ['<string>', ...],
    'testResult' => [
        'groups' => [
            [
                'groupId' => '<string>',
                'groupName' => '<string>',
                'tests' => [
                    [
                        'endTime' => <DateTime>,
                        'failure' => '<string>',
                        'logUrl' => '<string>',
                        'startTime' => <DateTime>,
                        'status' => 'PASS|FAIL|CANCELED|PENDING|RUNNING|STOPPING|STOPPED|PASS_WITH_WARNINGS|ERROR',
                        'testCaseDefinitionId' => '<string>',
                        'testCaseDefinitionName' => '<string>',
                        'testCaseRunId' => '<string>',
                        'testScenarios' => [
                            [
                                'failure' => '<string>',
                                'status' => 'PASS|FAIL|CANCELED|PENDING|RUNNING|STOPPING|STOPPED|PASS_WITH_WARNINGS|ERROR',
                                'systemMessage' => '<string>',
                                'testCaseScenarioId' => '<string>',
                                'testCaseScenarioType' => 'Advanced|Basic',
                            ],
                            // ...
                        ],
                        'warnings' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

errorReason
Type: string

Error reason for any test suite run failure.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

status
Type: string

Status for the test suite run.

suiteDefinitionId
Type: string

Suite definition ID for the test suite run.

suiteDefinitionVersion
Type: string

Suite definition version for the test suite run.

suiteRunArn
Type: string

The ARN of the suite run.

suiteRunConfiguration
Type: SuiteRunConfiguration structure

Suite run configuration for the test suite run.

suiteRunId
Type: string

Suite run ID for the test suite run.

tags
Type: Associative array of custom strings keys (String128) to strings

The tags attached to the suite run.

testResult
Type: TestResult structure

Test results for the test suite run.

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.

ResourceNotFoundException:

Sends a Resource Not Found exception.

GetSuiteRunReport 

$result = $client->getSuiteRunReport([/* ... */]);
$promise = $client->getSuiteRunReportAsync([/* ... */]);

Gets a report download link for a successful Device Advisor qualifying test suite run.

Requires permission to access the GetSuiteRunReport action.

Parameter Syntax

$result = $client->getSuiteRunReport([
    'suiteDefinitionId' => '<string>', // REQUIRED
    'suiteRunId' => '<string>', // REQUIRED
]);

Parameter Details

Members
suiteDefinitionId
Required: Yes
Type: string

Suite definition ID of the test suite.

suiteRunId
Required: Yes
Type: string

Suite run ID of the test suite run.

Result Syntax

[
    'qualificationReportDownloadUrl' => '<string>',
]

Result Details

Members
qualificationReportDownloadUrl
Type: string

Download URL of the qualification report.

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.

ResourceNotFoundException:

Sends a Resource Not Found exception.

ListSuiteDefinitions 

$result = $client->listSuiteDefinitions([/* ... */]);
$promise = $client->listSuiteDefinitionsAsync([/* ... */]);

Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions action.

Parameter Syntax

$result = $client->listSuiteDefinitions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return at once.

nextToken
Type: string

A token used to get the next set of results.

Result Syntax

[
    'nextToken' => '<string>',
    'suiteDefinitionInformationList' => [
        [
            'createdAt' => <DateTime>,
            'defaultDevices' => [
                [
                    'certificateArn' => '<string>',
                    'deviceRoleArn' => '<string>',
                    'thingArn' => '<string>',
                ],
                // ...
            ],
            'intendedForQualification' => true || false,
            'isLongDurationTest' => true || false,
            'protocol' => 'MqttV3_1_1|MqttV5|MqttV3_1_1_OverWebSocket|MqttV5_OverWebSocket',
            'suiteDefinitionId' => '<string>',
            'suiteDefinitionName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

A token used to get the next set of results.

suiteDefinitionInformationList
Type: Array of SuiteDefinitionInformation structures

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

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.

ListSuiteRuns 

$result = $client->listSuiteRuns([/* ... */]);
$promise = $client->listSuiteRunsAsync([/* ... */]);

Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.

Requires permission to access the ListSuiteRuns action.

Parameter Syntax

$result = $client->listSuiteRuns([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'suiteDefinitionId' => '<string>',
    'suiteDefinitionVersion' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return at once.

nextToken
Type: string

A token to retrieve the next set of results.

suiteDefinitionId
Type: string

Lists the test suite runs of the specified test suite based on suite definition ID.

suiteDefinitionVersion
Type: string

Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.

Result Syntax

[
    'nextToken' => '<string>',
    'suiteRunsList' => [
        [
            'createdAt' => <DateTime>,
            'endAt' => <DateTime>,
            'failed' => <integer>,
            'passed' => <integer>,
            'startedAt' => <DateTime>,
            'status' => 'PASS|FAIL|CANCELED|PENDING|RUNNING|STOPPING|STOPPED|PASS_WITH_WARNINGS|ERROR',
            'suiteDefinitionId' => '<string>',
            'suiteDefinitionName' => '<string>',
            'suiteDefinitionVersion' => '<string>',
            'suiteRunId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

A token to retrieve the next set of results.

suiteRunsList
Type: Array of SuiteRunInformation structures

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

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags attached to an IoT Device Advisor resource.

Requires permission to access the ListTagsForResource action.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (String128) to strings

The tags attached to the IoT Device Advisor resource.

Errors

InternalServerException:

Sends an Internal Failure exception.

ValidationException:

Sends a validation exception.

ResourceNotFoundException:

Sends a Resource Not Found exception.

StartSuiteRun 

$result = $client->startSuiteRun([/* ... */]);
$promise = $client->startSuiteRunAsync([/* ... */]);

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

Parameter Syntax

$result = $client->startSuiteRun([
    'suiteDefinitionId' => '<string>', // REQUIRED
    'suiteDefinitionVersion' => '<string>',
    'suiteRunConfiguration' => [ // REQUIRED
        'parallelRun' => true || false,
        'primaryDevice' => [ // REQUIRED
            'certificateArn' => '<string>',
            'deviceRoleArn' => '<string>',
            'thingArn' => '<string>',
        ],
        'selectedTestList' => ['<string>', ...],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
suiteDefinitionId
Required: Yes
Type: string

Suite definition ID of the test suite.

suiteDefinitionVersion
Type: string

Suite definition version of the test suite.

suiteRunConfiguration
Required: Yes
Type: SuiteRunConfiguration structure

Suite run configuration.

tags
Type: Associative array of custom strings keys (String128) to strings

The tags to be attached to the suite run.

Result Syntax

[
    'createdAt' => <DateTime>,
    'endpoint' => '<string>',
    'suiteRunArn' => '<string>',
    'suiteRunId' => '<string>',
]

Result Details

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

Starts a Device Advisor test suite run based on suite create time.

endpoint
Type: string

The response of an Device Advisor test endpoint.

suiteRunArn
Type: string

Amazon Resource Name (ARN) of the started suite run.

suiteRunId
Type: string

Suite Run ID of the started suite run.

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.

ConflictException:

Sends a Conflict Exception.

StopSuiteRun 

$result = $client->stopSuiteRun([/* ... */]);
$promise = $client->stopSuiteRunAsync([/* ... */]);

Stops a Device Advisor test suite run that is currently running.

Requires permission to access the StopSuiteRun action.

Parameter Syntax

$result = $client->stopSuiteRun([
    'suiteDefinitionId' => '<string>', // REQUIRED
    'suiteRunId' => '<string>', // REQUIRED
]);

Parameter Details

Members
suiteDefinitionId
Required: Yes
Type: string

Suite definition ID of the test suite run to be stopped.

suiteRunId
Required: Yes
Type: string

Suite run ID of the test suite run to be stopped.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

Sends a validation exception.

ResourceNotFoundException:

Sends a Resource Not Found exception.

InternalServerException:

Sends an Internal Failure exception.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds to and modifies existing tags of an IoT Device Advisor resource.

Requires permission to access the TagResource action.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.

tags
Required: Yes
Type: Associative array of custom strings keys (String128) to strings

The tags to be attached to the IoT Device Advisor resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

Sends an Internal Failure exception.

ValidationException:

Sends a validation exception.

ResourceNotFoundException:

Sends a Resource Not Found exception.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from an IoT Device Advisor resource.

Requires permission to access the UntagResource action.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.

tagKeys
Required: Yes
Type: Array of strings

List of tag keys to remove from the IoT Device Advisor resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

Sends an Internal Failure exception.

ValidationException:

Sends a validation exception.

ResourceNotFoundException:

Sends a Resource Not Found exception.

UpdateSuiteDefinition 

$result = $client->updateSuiteDefinition([/* ... */]);
$promise = $client->updateSuiteDefinitionAsync([/* ... */]);

Updates a Device Advisor test suite.

Requires permission to access the UpdateSuiteDefinition action.

Parameter Syntax

$result = $client->updateSuiteDefinition([
    'suiteDefinitionConfiguration' => [ // REQUIRED
        'devicePermissionRoleArn' => '<string>', // REQUIRED
        'devices' => [
            [
                'certificateArn' => '<string>',
                'deviceRoleArn' => '<string>',
                'thingArn' => '<string>',
            ],
            // ...
        ],
        'intendedForQualification' => true || false,
        'isLongDurationTest' => true || false,
        'protocol' => 'MqttV3_1_1|MqttV5|MqttV3_1_1_OverWebSocket|MqttV5_OverWebSocket',
        'rootGroup' => '<string>', // REQUIRED
        'suiteDefinitionName' => '<string>', // REQUIRED
    ],
    'suiteDefinitionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
suiteDefinitionConfiguration
Required: Yes
Type: SuiteDefinitionConfiguration structure

Updates a Device Advisor test suite with suite definition configuration.

suiteDefinitionId
Required: Yes
Type: string

Suite definition ID of the test suite to be updated.

Result Syntax

[
    'createdAt' => <DateTime>,
    'lastUpdatedAt' => <DateTime>,
    'suiteDefinitionArn' => '<string>',
    'suiteDefinitionId' => '<string>',
    'suiteDefinitionName' => '<string>',
    'suiteDefinitionVersion' => '<string>',
]

Result Details

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp of when the test suite was created.

lastUpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp of when the test suite was updated.

suiteDefinitionArn
Type: string

Amazon Resource Name (ARN) of the updated test suite.

suiteDefinitionId
Type: string

Suite definition ID of the updated test suite.

suiteDefinitionName
Type: string

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

suiteDefinitionVersion
Type: string

Suite definition version of the updated test suite.

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.

Shapes

ConflictException

Description

Sends a Conflict Exception.

Members
message
Type: string

Sends a Conflict Exception message.

DeviceUnderTest

Description

Information of a test device. A thing ARN, certificate ARN or device role ARN is required.

Members
certificateArn
Type: string

Lists device's certificate ARN.

deviceRoleArn
Type: string

Lists device's role ARN.

thingArn
Type: string

Lists device's thing ARN.

GroupResult

Description

Show Group Result.

Members
groupId
Type: string

Group result ID.

groupName
Type: string

Group Result Name.

tests
Type: Array of TestCaseRun structures

Tests under Group Result.

InternalServerException

Description

Sends an Internal Failure exception.

Members
message
Type: string

Sends an Internal Failure Exception message.

ResourceNotFoundException

Description

Sends a Resource Not Found exception.

Members
message
Type: string

Sends a Resource Not Found Exception message.

SuiteDefinitionConfiguration

Description

Gets the suite definition configuration.

Members
devicePermissionRoleArn
Required: Yes
Type: string

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

devices
Type: Array of DeviceUnderTest structures

Gets the devices configured.

intendedForQualification
Type: boolean

Gets the tests intended for qualification in a suite.

isLongDurationTest
Type: boolean

Verifies if the test suite is a long duration test.

protocol
Type: string

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

rootGroup
Required: Yes
Type: string

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.

suiteDefinitionName
Required: Yes
Type: string

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

SuiteDefinitionInformation

Description

Information about the suite definition.

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

defaultDevices
Type: Array of DeviceUnderTest structures

Specifies the devices that are under test for the test suite.

intendedForQualification
Type: boolean

Specifies if the test suite is intended for qualification.

isLongDurationTest
Type: boolean

Verifies if the test suite is a long duration test.

protocol
Type: string

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

suiteDefinitionId
Type: string

Suite definition ID of the test suite.

suiteDefinitionName
Type: string

Suite name of the test suite.

SuiteRunConfiguration

Description

Gets suite run configuration.

Members
parallelRun
Type: boolean

TRUE if multiple test suites run in parallel.

primaryDevice
Required: Yes
Type: DeviceUnderTest structure

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

selectedTestList
Type: Array of strings

Sets test case list.

SuiteRunInformation

Description

Information about the suite run.

Requires permission to access the SuiteRunInformation action.

Members
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

endAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

failed
Type: int

Number of test cases that failed in the suite run.

passed
Type: int

Number of test cases that passed in the suite run.

startedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

status
Type: string

Status of the suite run.

suiteDefinitionId
Type: string

Suite definition ID of the suite run.

suiteDefinitionName
Type: string

Suite definition name of the suite run.

suiteDefinitionVersion
Type: string

Suite definition version of the suite run.

suiteRunId
Type: string

Suite run ID of the suite run.

TestCaseRun

Description

Provides the test case run.

Members
endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Provides test case run end time.

failure
Type: string

Provides test case run failure result.

logUrl
Type: string

Provides test case run log URL.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Provides test case run start time.

status
Type: string

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.

testCaseDefinitionId
Type: string

Provides the test case run definition ID.

testCaseDefinitionName
Type: string

Provides the test case run definition name.

testCaseRunId
Type: string

Provides the test case run ID.

testScenarios
Type: Array of TestCaseScenario structures

Provides the test scenarios for the test case run.

warnings
Type: string

Provides test case run warnings.

TestCaseScenario

Description

Provides test case scenario.

Members
failure
Type: string

Provides test case scenario failure result.

status
Type: string

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.

systemMessage
Type: string

Provides test case scenario system messages if any.

testCaseScenarioId
Type: string

Provides test case scenario ID.

testCaseScenarioType
Type: string

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

  • Advanced

  • Basic

TestResult

Description

Show each group result.

Members
groups
Type: Array of GroupResult structures

Show each group of test results.

ValidationException

Description

Sends a validation exception.

Members
message
Type: string

Sends a Validation Exception message.