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([
    'clientToken' => '<string>',
    '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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

Errors

ValidationException:

Sends a validation exception.

InternalServerException:

Sends an Internal Failure exception.