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.
- 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 the runs of the specified Device Advisor test suite.
- ListTagsForResource ( array $params = [] )
Lists the tags attached to an IoT Device Advisor resource.
- ListTestCases ( array $params = [] )
Lists all the test cases in the test suite.
- StartSuiteRun ( array $params = [] )
Starts a Device Advisor test suite run.
- 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:
Operations
CreateSuiteDefinition
$result = $client->createSuiteDefinition([/* ... */]); $promise = $client->createSuiteDefinitionAsync([/* ... */]);
Creates a Device Advisor test suite.
Parameter Syntax
$result = $client->createSuiteDefinition([
'suiteDefinitionConfiguration' => [
'devicePermissionRoleArn' => '<string>',
'devices' => [
[
'certificateArn' => '<string>',
'thingArn' => '<string>',
],
// ...
],
'intendedForQualification' => true || false,
'rootGroup' => '<string>',
'suiteDefinitionName' => '<string>',
],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- suiteDefinitionConfiguration
-
- 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)
Creates a Device Advisor test suite with TimeStamp of when it was created.
- suiteDefinitionArn
-
- Type: string
Creates a Device Advisor test suite with Amazon Resource name.
- suiteDefinitionId
-
- Type: string
Creates a Device Advisor test suite with suite UUID.
- suiteDefinitionName
-
- Type: string
Creates a Device Advisor test suite with suite definition name.
Errors
-
Sends invalid request exception.
-
Sends Internal Failure Exception.
DeleteSuiteDefinition
$result = $client->deleteSuiteDefinition([/* ... */]); $promise = $client->deleteSuiteDefinitionAsync([/* ... */]);
Deletes a Device Advisor test suite.
Parameter Syntax
$result = $client->deleteSuiteDefinition([
'suiteDefinitionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Sends invalid request exception.
-
Sends Internal Failure Exception.
GetSuiteDefinition
$result = $client->getSuiteDefinition([/* ... */]); $promise = $client->getSuiteDefinitionAsync([/* ... */]);
Gets information about a Device Advisor test suite.
Parameter Syntax
$result = $client->getSuiteDefinition([
'suiteDefinitionId' => '<string>', // REQUIRED
'suiteDefinitionVersion' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'createdAt' => <DateTime>,
'lastModifiedAt' => <DateTime>,
'latestVersion' => '<string>',
'suiteDefinitionArn' => '<string>',
'suiteDefinitionConfiguration' => [
'devicePermissionRoleArn' => '<string>',
'devices' => [
[
'certificateArn' => '<string>',
'thingArn' => '<string>',
],
// ...
],
'intendedForQualification' => true || false,
'rootGroup' => '<string>',
'suiteDefinitionName' => '<string>',
],
'suiteDefinitionId' => '<string>',
'suiteDefinitionVersion' => '<string>',
'tags' => ['<string>', ...],
]
Result Details
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Gets the timestamp of the time suite was created with GetSuiteDefinition API call.
- lastModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Gets the timestamp of the time suite was modified with GetSuiteDefinition API call.
- latestVersion
-
- Type: string
Gets latest suite definition version with GetSuiteDefinition API call.
- suiteDefinitionArn
-
- Type: string
The ARN of the suite definition.
- suiteDefinitionConfiguration
-
- Type: SuiteDefinitionConfiguration structure
Gets the suite configuration with GetSuiteDefinition API call.
- suiteDefinitionId
-
- Type: string
Gets suite definition Id with GetSuiteDefinition API call.
- suiteDefinitionVersion
-
- Type: string
Gets suite definition version with GetSuiteDefinition API call.
- tags
-
- Type: Associative array of custom strings keys (String128) to strings
Tags attached to the suite definition.
Errors
-
Sends invalid request exception.
-
Sends Internal Failure Exception.
-
Sends Resource Not Found Exception.
GetSuiteRun
$result = $client->getSuiteRun([/* ... */]); $promise = $client->getSuiteRunAsync([/* ... */]);
Gets information about a Device Advisor test suite run.
Parameter Syntax
$result = $client->getSuiteRun([
'suiteDefinitionId' => '<string>', // REQUIRED
'suiteRunId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'endTime' => <DateTime>,
'errorReason' => '<string>',
'startTime' => <DateTime>,
'status' => 'PASS|FAIL|CANCELED|PENDING|RUNNING|PASS_WITH_WARNINGS|ERROR',
'suiteDefinitionId' => '<string>',
'suiteDefinitionVersion' => '<string>',
'suiteRunArn' => '<string>',
'suiteRunConfiguration' => [
'primaryDevice' => [
'certificateArn' => '<string>',
'thingArn' => '<string>',
],
'secondaryDevice' => [
'certificateArn' => '<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|PASS_WITH_WARNINGS|ERROR',
'testCaseDefinitionId' => '<string>',
'testCaseDefinitionName' => '<string>',
'testCaseRunId' => '<string>',
'warnings' => '<string>',
],
// ...
],
],
// ...
],
],
]
Result Details
Members
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Gets the information about Device Advisor test suite run based on end time.
- errorReason
-
- Type: string
Gets the information about Device Advisor test suite run based on error.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Gets the information about Device Advisor test suite run based on start time.
- status
-
- Type: string
Gets the information about Device Advisor test suite run based on its status.
- suiteDefinitionId
-
- Type: string
Gets the information about Device Advisor test suite run based on suite definition Id.
- suiteDefinitionVersion
-
- Type: string
Gets the information about Device Advisor test suite run based on suite definition version.
- suiteRunArn
-
- Type: string
The ARN of the suite run.
- suiteRunConfiguration
-
- Type: SuiteRunConfiguration structure
Gets the information about Device Advisor test suite run based on suite configuration.
- suiteRunId
-
- Type: string
Gets the information about Device Advisor test suite run based on suite run Id.
- tags
-
- Type: Associative array of custom strings keys (String128) to strings
The tags attached to the suite run.
- testResult
-
- Type: TestResult structure
Gets the information about Device Advisor test suite run based on test case runs.
Errors
-
Sends invalid request exception.
-
Sends Internal Failure Exception.
-
Sends 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.
Parameter Syntax
$result = $client->getSuiteRunReport([
'suiteDefinitionId' => '<string>', // REQUIRED
'suiteRunId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'qualificationReportDownloadUrl' => '<string>',
]
Result Details
Members
Errors
-
Sends invalid request exception.
-
Sends Internal Failure Exception.
-
Sends Resource Not Found Exception.
ListSuiteDefinitions
$result = $client->listSuiteDefinitions([/* ... */]); $promise = $client->listSuiteDefinitionsAsync([/* ... */]);
Lists the Device Advisor test suites you have created.
Parameter Syntax
$result = $client->listSuiteDefinitions([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'suiteDefinitionInformationList' => [
[
'createdAt' => <DateTime>,
'defaultDevices' => [
[
'certificateArn' => '<string>',
'thingArn' => '<string>',
],
// ...
],
'intendedForQualification' => true || false,
'suiteDefinitionId' => '<string>',
'suiteDefinitionName' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Creates a Device Advisor test suite.
- suiteDefinitionInformationList
-
- Type: Array of SuiteDefinitionInformation structures
Lists test suite information using List suite definition.
Errors
-
Sends invalid request exception.
-
Sends Internal Failure Exception.
ListSuiteRuns
$result = $client->listSuiteRuns([/* ... */]); $promise = $client->listSuiteRunsAsync([/* ... */]);
Lists the 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.
Parameter Syntax
$result = $client->listSuiteRuns([
'maxResults' => <integer>,
'nextToken' => '<string>',
'suiteDefinitionId' => '<string>',
'suiteDefinitionVersion' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
MaxResults for list suite run API request.
- nextToken
-
- Type: string
Next pagination token for list suite run request.
- suiteDefinitionId
-
- Type: string
Lists the runs of the specified Device Advisor test suite based on suite definition Id.
- suiteDefinitionVersion
-
- Type: string
Lists the runs of the specified Device Advisor 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|PASS_WITH_WARNINGS|ERROR',
'suiteDefinitionId' => '<string>',
'suiteDefinitionName' => '<string>',
'suiteDefinitionVersion' => '<string>',
'suiteRunId' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Next pagination token for list suite run response.
- suiteRunsList
-
- Type: Array of SuiteRunInformation structures
Lists the runs of the specified Device Advisor test suite.
Errors
-
Sends invalid request exception.
-
Sends Internal Failure Exception.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags attached to an IoT Device Advisor resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
Sends Internal Failure Exception.
-
Sends invalid request exception.
-
Sends Resource Not Found Exception.
ListTestCases
$result = $client->listTestCases([/* ... */]); $promise = $client->listTestCasesAsync([/* ... */]);
Lists all the test cases in the test suite.
Parameter Syntax
$result = $client->listTestCases([
'intendedForQualification' => true || false,
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'categories' => [
[
'name' => '<string>',
'tests' => [
[
'configuration' => ['<string>', ...],
'name' => '<string>',
'test' => [
'id' => '<string>',
'testCaseVersion' => '<string>',
],
],
// ...
],
],
// ...
],
'groupConfiguration' => ['<string>', ...],
'nextToken' => '<string>',
'rootGroupConfiguration' => ['<string>', ...],
]
Result Details
Members
- categories
-
- Type: Array of TestCaseCategory structures
Gets the category of test case.
- groupConfiguration
-
- Type: Associative array of custom strings keys (ConfigString) to strings
Gets the configuration of test group.
- nextToken
-
- Type: string
Test cases next token response.
- rootGroupConfiguration
-
- Type: Associative array of custom strings keys (ConfigString) to strings
Gets the configuration of root test group.
Errors
-
Sends Internal Failure Exception.
StartSuiteRun
$result = $client->startSuiteRun([/* ... */]); $promise = $client->startSuiteRunAsync([/* ... */]);
Starts a Device Advisor test suite run.
Parameter Syntax
$result = $client->startSuiteRun([
'suiteDefinitionId' => '<string>', // REQUIRED
'suiteDefinitionVersion' => '<string>',
'suiteRunConfiguration' => [
'primaryDevice' => [
'certificateArn' => '<string>',
'thingArn' => '<string>',
],
'secondaryDevice' => [
'certificateArn' => '<string>',
'thingArn' => '<string>',
],
'selectedTestList' => ['<string>', ...],
],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- suiteDefinitionId
-
- Required: Yes
- Type: string
Request to start suite run based on suite definition Id.
- suiteDefinitionVersion
-
- Type: string
Request to start suite run based on suite definition version.
- suiteRunConfiguration
-
- Type: SuiteRunConfiguration structure
Request to start suite run based on suite 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>,
'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.
- suiteRunArn
-
- Type: string
Starts a Device Advisor test suite run based on suite run arn.
- suiteRunId
-
- Type: string
Starts a Device Advisor test suite run based on suite Run Id.
Errors
-
Sends invalid request exception.
-
Sends Internal Failure Exception.
-
Sends Conflict Exception.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds to and modifies existing tags of an IoT Device Advisor resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Sends Internal Failure Exception.
-
Sends invalid request exception.
-
Sends Resource Not Found Exception.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from an IoT Device Advisor resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Sends Internal Failure Exception.
-
Sends invalid request exception.
-
Sends Resource Not Found Exception.
UpdateSuiteDefinition
$result = $client->updateSuiteDefinition([/* ... */]); $promise = $client->updateSuiteDefinitionAsync([/* ... */]);
Updates a Device Advisor test suite.
Parameter Syntax
$result = $client->updateSuiteDefinition([
'suiteDefinitionConfiguration' => [
'devicePermissionRoleArn' => '<string>',
'devices' => [
[
'certificateArn' => '<string>',
'thingArn' => '<string>',
],
// ...
],
'intendedForQualification' => true || false,
'rootGroup' => '<string>',
'suiteDefinitionName' => '<string>',
],
'suiteDefinitionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- suiteDefinitionConfiguration
-
- Type: SuiteDefinitionConfiguration structure
Updates a Device Advisor test suite with suite definition configuration.
- suiteDefinitionId
-
- Required: Yes
- Type: string
Updates a Device Advisor test suite with suite definition id.
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)
Updates a Device Advisor test suite with TimeStamp of when it was created.
- lastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Updates a Device Advisor test suite with TimeStamp of when it was updated.
- suiteDefinitionArn
-
- Type: string
Updates a Device Advisor test suite with Amazon Resource name.
- suiteDefinitionId
-
- Type: string
Updates a Device Advisor test suite with suite UUID.
- suiteDefinitionName
-
- Type: string
Updates a Device Advisor test suite with suite definition name.
- suiteDefinitionVersion
-
- Type: string
Updates a Device Advisor test suite with suite definition version.
Errors
-
Sends invalid request exception.
-
Sends Internal Failure Exception.
Shapes
ConflictException
Description
Sends Conflict Exception.
Members
DeviceUnderTest
Description
Lists all the devices under test
Members
GroupResult
Description
Show Group Result.
Members
- groupId
-
- Type: string
Show Group Result Id.
- groupName
-
- Type: string
Show Group Result Name.
- tests
-
- Type: Array of TestCaseRun structures
Show Group Result.
InternalServerException
Description
Sends Internal Failure Exception.
Members
ResourceNotFoundException
Description
Sends Resource Not Found Exception.
Members
SuiteDefinitionConfiguration
Description
Gets Suite Definition Configuration.
Members
- devicePermissionRoleArn
-
- Type: string
Gets device permission arn.
- devices
-
- Type: Array of DeviceUnderTest structures
Gets the devices configured.
- intendedForQualification
-
- Type: boolean
Gets the tests intended for qualification in a suite.
- rootGroup
-
- Type: string
Gets test suite root group.
- suiteDefinitionName
-
- Type: string
Gets Suite Definition Configuration name.
SuiteDefinitionInformation
Description
Get suite definition information.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Gets the information of when the test suite was created.
- defaultDevices
-
- Type: Array of DeviceUnderTest structures
Specifies the devices under test.
- intendedForQualification
-
- Type: boolean
Gets the test suites which will be used for qualification.
- suiteDefinitionId
-
- Type: string
Get suite definition Id.
- suiteDefinitionName
-
- Type: string
Get test suite name.
SuiteRunConfiguration
Description
Gets suite run configuration.
Members
- primaryDevice
-
- Type: DeviceUnderTest structure
Gets the primary device for suite run.
- secondaryDevice
-
- Type: DeviceUnderTest structure
Gets the secondary device for suite run.
- selectedTestList
-
- Type: Array of strings
Gets test case list.
SuiteRunInformation
Description
Get suite run information.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Get suite run information based on time suite was created.
- endAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Get suite run information based on end time of the run.
- failed
-
- Type: int
Get suite run information based on result of the test suite run.
- passed
-
- Type: int
Get suite run information based on result of the test suite run.
- startedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Get suite run information based on start time of the run.
- status
-
- Type: string
Get suite run information based on test run status.
- suiteDefinitionId
-
- Type: string
Get suite run information based on suite definition Id.
- suiteDefinitionName
-
- Type: string
Get suite run information based on suite definition name.
- suiteDefinitionVersion
-
- Type: string
Get suite run information based on suite definition version.
- suiteRunId
-
- Type: string
Get suite run information based on suite run Id.
TestCase
Description
Shows tests in a test group.
Members
- configuration
-
- Type: Associative array of custom strings keys (ConfigString) to strings
Shows test case configuration.
- name
-
- Type: string
Shows test case name.
- test
-
- Type: TestCaseDefinition structure
Specifies a test.
TestCaseCategory
Description
Gets the test case category.
Members
- name
-
- Type: string
Lists all the tests name in the specified category.
- tests
-
- Type: Array of TestCase structures
Lists all the tests in the specified category.
TestCaseDefinition
Description
Provides test case definition.
Members
TestCaseRun
Description
Provides 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 test case run status.
- testCaseDefinitionId
-
- Type: string
Provides test case run definition Id.
- testCaseDefinitionName
-
- Type: string
Provides test case run definition Name.
- testCaseRunId
-
- Type: string
Provides test case run Id.
- warnings
-
- Type: string
Provides test case run warnings.
TestResult
Description
Show each group result.
Members
- groups
-
- Type: Array of GroupResult structures
Show each group of test results.