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:
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' => [
'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 (ARN).
- 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 a validation exception.
-
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
Result Syntax
[]
Result Details
Errors
-
Sends a validation exception.
-
Sends an Internal Failure exception.
GetEndpoint
$result = $client->getEndpoint([/* ... */]); $promise = $client->getEndpointAsync([/* ... */]);
Gets information about an Device Advisor endpoint.
Parameter Syntax
$result = $client->getEndpoint([
'certificateArn' => '<string>',
'thingArn' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'endpoint' => '<string>',
]
Result Details
Errors
-
Sends a validation exception.
-
Sends an Internal Failure exception.
-
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
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)
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
-
Sends a validation exception.
-
Sends an Internal Failure exception.
-
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
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>',
'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>',
'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
-
Sends a validation exception.
-
Sends an Internal Failure exception.
-
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
Result Syntax
[
'qualificationReportDownloadUrl' => '<string>',
]
Result Details
Errors
-
Sends a validation exception.
-
Sends an Internal Failure exception.
-
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
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
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
-
Sends a validation exception.
-
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
-
Sends a validation exception.
-
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
Members
Errors
-
Sends an Internal Failure exception.
-
Sends a validation exception.
-
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' => [
'parallelRun' => true || false,
'primaryDevice' => [
'certificateArn' => '<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
-
- 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>,
'suiteRunArn' => '<string>',
'suiteRunId' => '<string>',
]
Result Details
Members
Errors
-
Sends a validation exception.
-
Sends an Internal Failure exception.
-
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
Result Syntax
[]
Result Details
Errors
-
Sends a validation exception.
-
Sends a Resource Not Found exception.
-
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
Result Syntax
[]
Result Details
Errors
-
Sends an Internal Failure exception.
-
Sends a validation exception.
-
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
Result Syntax
[]
Result Details
Errors
-
Sends an Internal Failure exception.
-
Sends a validation exception.
-
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' => [
'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
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
Suite definition name of the updated test suite.
- suiteDefinitionVersion
-
- Type: string
Suite definition version of the updated test suite.
Errors
-
Sends a validation exception.
-
Sends an Internal Failure exception.
Shapes
ConflictException
Description
Sends a Conflict Exception.
Members
DeviceUnderTest
Description
Information of a test device. A thing ARN or a certificate ARN is required.
Members
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
ResourceNotFoundException
Description
Sends a Resource Not Found exception.
Members
SuiteDefinitionConfiguration
Description
Gets Suite Definition Configuration.
Members
- devicePermissionRoleArn
-
- Type: string
Gets the 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
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.
- 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
-
- Type: DeviceUnderTest structure
Gets the primary device for suite run.
- selectedTestList
-
- Type: Array of strings
Gets 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. -
STOPPEDTest 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.
- 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.