'2.0', 'service' => '

Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with Amazon Web Services IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to Amazon Web Services IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the Amazon Web Services Partner Network to get your device qualified for the Amazon Web Services Partner Device Catalog without the need to send your device in and wait for it to be tested.

', 'operations' => [ 'CreateSuiteDefinition' => '

Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition action.

', 'DeleteSuiteDefinition' => '

Deletes a Device Advisor test suite.

Requires permission to access the DeleteSuiteDefinition action.

', 'GetEndpoint' => '

Gets information about an Device Advisor endpoint.

', 'GetSuiteDefinition' => '

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition action.

', 'GetSuiteRun' => '

Gets information about a Device Advisor test suite run.

Requires permission to access the GetSuiteRun action.

', 'GetSuiteRunReport' => '

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

Requires permission to access the GetSuiteRunReport action.

', 'ListSuiteDefinitions' => '

Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions action.

', 'ListSuiteRuns' => '

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.

', 'ListTagsForResource' => '

Lists the tags attached to an IoT Device Advisor resource.

Requires permission to access the ListTagsForResource action.

', 'StartSuiteRun' => '

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

', 'StopSuiteRun' => '

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

Requires permission to access the StopSuiteRun action.

', 'TagResource' => '

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

Requires permission to access the TagResource action.

', 'UntagResource' => '

Removes tags from an IoT Device Advisor resource.

Requires permission to access the UntagResource action.

', 'UpdateSuiteDefinition' => '

Updates a Device Advisor test suite.

Requires permission to access the UpdateSuiteDefinition action.

', ], 'shapes' => [ 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'CreateSuiteDefinitionResponse$suiteDefinitionArn' => '

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

', 'DeviceUnderTest$thingArn' => '

Lists device\'s thing ARN.

', 'DeviceUnderTest$certificateArn' => '

Lists device\'s certificate ARN.

', 'DeviceUnderTest$deviceRoleArn' => '

Lists device\'s role ARN.

', 'GetEndpointRequest$thingArn' => '

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

', 'GetEndpointRequest$certificateArn' => '

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

', 'GetEndpointRequest$deviceRoleArn' => '

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

', 'GetSuiteDefinitionResponse$suiteDefinitionArn' => '

The ARN of the suite definition.

', 'GetSuiteRunResponse$suiteRunArn' => '

The ARN of the suite run.

', 'ListTagsForResourceRequest$resourceArn' => '

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

', 'StartSuiteRunResponse$suiteRunArn' => '

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

', 'SuiteDefinitionConfiguration$devicePermissionRoleArn' => '

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

', 'TagResourceRequest$resourceArn' => '

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

', 'UntagResourceRequest$resourceArn' => '

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

', 'UpdateSuiteDefinitionResponse$suiteDefinitionArn' => '

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

', ], ], 'AuthenticationMethod' => [ 'base' => NULL, 'refs' => [ 'GetEndpointRequest$authenticationMethod' => '

The authentication method used during the device connection.

', ], ], 'ConflictException' => [ 'base' => '

Sends a Conflict Exception.

', 'refs' => [], ], 'CreateSuiteDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSuiteDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSuiteDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSuiteDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeviceUnderTest' => [ 'base' => '

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

', 'refs' => [ 'DeviceUnderTestList$member' => NULL, 'SuiteRunConfiguration$primaryDevice' => '

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

', ], ], 'DeviceUnderTestList' => [ 'base' => NULL, 'refs' => [ 'SuiteDefinitionConfiguration$devices' => '

Gets the devices configured.

', 'SuiteDefinitionInformation$defaultDevices' => '

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

', ], ], 'Endpoint' => [ 'base' => NULL, 'refs' => [ 'GetEndpointResponse$endpoint' => '

The response of an Device Advisor endpoint.

', 'StartSuiteRunResponse$endpoint' => '

The response of an Device Advisor test endpoint.

', ], ], 'ErrorReason' => [ 'base' => NULL, 'refs' => [ 'GetSuiteRunResponse$errorReason' => '

Error reason for any test suite run failure.

', ], ], 'Failure' => [ 'base' => NULL, 'refs' => [ 'TestCaseRun$failure' => '

Provides test case run failure result.

', 'TestCaseScenario$failure' => '

Provides test case scenario failure result.

', ], ], 'GetEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSuiteDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSuiteDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSuiteRunReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSuiteRunReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSuiteRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSuiteRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GroupName' => [ 'base' => NULL, 'refs' => [ 'GroupResult$groupName' => '

Group Result Name.

', ], ], 'GroupResult' => [ 'base' => '

Show Group Result.

', 'refs' => [ 'GroupResultList$member' => NULL, ], ], 'GroupResultList' => [ 'base' => '

Group Result list.

', 'refs' => [ 'TestResult$groups' => '

Show each group of test results.

', ], ], 'IntendedForQualificationBoolean' => [ 'base' => NULL, 'refs' => [ 'SuiteDefinitionConfiguration$intendedForQualification' => '

Gets the tests intended for qualification in a suite.

', 'SuiteDefinitionInformation$intendedForQualification' => '

Specifies if the test suite is intended for qualification.

', ], ], 'InternalServerException' => [ 'base' => '

Sends an Internal Failure exception.

', 'refs' => [], ], 'IsLongDurationTestBoolean' => [ 'base' => NULL, 'refs' => [ 'SuiteDefinitionConfiguration$isLongDurationTest' => '

Verifies if the test suite is a long duration test.

', 'SuiteDefinitionInformation$isLongDurationTest' => '

Verifies if the test suite is a long duration test.

', ], ], 'ListSuiteDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSuiteDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSuiteRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSuiteRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogUrl' => [ 'base' => NULL, 'refs' => [ 'TestCaseRun$logUrl' => '

Provides test case run log URL.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListSuiteDefinitionsRequest$maxResults' => '

The maximum number of results to return at once.

', 'ListSuiteRunsRequest$maxResults' => '

The maximum number of results to return at once.

', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ConflictException$message' => '

Sends a Conflict Exception message.

', 'InternalServerException$message' => '

Sends an Internal Failure Exception message.

', 'ResourceNotFoundException$message' => '

Sends a Resource Not Found Exception message.

', 'ValidationException$message' => '

Sends a Validation Exception message.

', ], ], 'ParallelRun' => [ 'base' => NULL, 'refs' => [ 'SuiteRunConfiguration$parallelRun' => '

TRUE if multiple test suites run in parallel.

', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'SuiteDefinitionConfiguration$protocol' => '

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

', 'SuiteDefinitionInformation$protocol' => '

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

', ], ], 'QualificationReportDownloadUrl' => [ 'base' => NULL, 'refs' => [ 'GetSuiteRunReportResponse$qualificationReportDownloadUrl' => '

Download URL of the qualification report.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

Sends a Resource Not Found exception.

', 'refs' => [], ], 'RootGroup' => [ 'base' => NULL, 'refs' => [ 'SuiteDefinitionConfiguration$rootGroup' => '

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.

', ], ], 'SelectedTestList' => [ 'base' => NULL, 'refs' => [ 'SuiteRunConfiguration$selectedTestList' => '

Sets test case list.

', ], ], 'StartSuiteRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartSuiteRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'TestCaseRun$status' => '

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.

', ], ], 'StopSuiteRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopSuiteRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'String128' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'String256' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, ], ], 'SuiteDefinitionConfiguration' => [ 'base' => '

Gets the suite definition configuration.

', 'refs' => [ 'CreateSuiteDefinitionRequest$suiteDefinitionConfiguration' => '

Creates a Device Advisor test suite with suite definition configuration.

', 'GetSuiteDefinitionResponse$suiteDefinitionConfiguration' => '

Suite configuration of the suite definition.

', 'UpdateSuiteDefinitionRequest$suiteDefinitionConfiguration' => '

Updates a Device Advisor test suite with suite definition configuration.

', ], ], 'SuiteDefinitionInformation' => [ 'base' => '

Information about the suite definition.

', 'refs' => [ 'SuiteDefinitionInformationList$member' => NULL, ], ], 'SuiteDefinitionInformationList' => [ 'base' => NULL, 'refs' => [ 'ListSuiteDefinitionsResponse$suiteDefinitionInformationList' => '

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

', ], ], 'SuiteDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateSuiteDefinitionResponse$suiteDefinitionName' => '

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

', 'SuiteDefinitionConfiguration$suiteDefinitionName' => '

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

', 'SuiteDefinitionInformation$suiteDefinitionName' => '

Suite name of the test suite.

', 'SuiteRunInformation$suiteDefinitionName' => '

Suite definition name of the suite run.

', 'UpdateSuiteDefinitionResponse$suiteDefinitionName' => '

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

', ], ], 'SuiteDefinitionVersion' => [ 'base' => NULL, 'refs' => [ 'GetSuiteDefinitionRequest$suiteDefinitionVersion' => '

Suite definition version of the test suite to get.

', 'GetSuiteDefinitionResponse$suiteDefinitionVersion' => '

Suite definition version of the suite definition.

', 'GetSuiteDefinitionResponse$latestVersion' => '

Latest suite definition version of the suite definition.

', 'GetSuiteRunResponse$suiteDefinitionVersion' => '

Suite definition version for the test suite run.

', 'ListSuiteRunsRequest$suiteDefinitionVersion' => '

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

', 'StartSuiteRunRequest$suiteDefinitionVersion' => '

Suite definition version of the test suite.

', 'SuiteRunInformation$suiteDefinitionVersion' => '

Suite definition version of the suite run.

', 'UpdateSuiteDefinitionResponse$suiteDefinitionVersion' => '

Suite definition version of the updated test suite.

', ], ], 'SuiteRunConfiguration' => [ 'base' => '

Gets suite run configuration.

', 'refs' => [ 'GetSuiteRunResponse$suiteRunConfiguration' => '

Suite run configuration for the test suite run.

', 'StartSuiteRunRequest$suiteRunConfiguration' => '

Suite run configuration.

', ], ], 'SuiteRunInformation' => [ 'base' => '

Information about the suite run.

Requires permission to access the SuiteRunInformation action.

', 'refs' => [ 'SuiteRunsList$member' => NULL, ], ], 'SuiteRunResultCount' => [ 'base' => NULL, 'refs' => [ 'SuiteRunInformation$passed' => '

Number of test cases that passed in the suite run.

', 'SuiteRunInformation$failed' => '

Number of test cases that failed in the suite run.

', ], ], 'SuiteRunStatus' => [ 'base' => NULL, 'refs' => [ 'GetSuiteRunResponse$status' => '

Status for the test suite run.

', 'SuiteRunInformation$status' => '

Status of the suite run.

', ], ], 'SuiteRunsList' => [ 'base' => NULL, 'refs' => [ 'ListSuiteRunsResponse$suiteRunsList' => '

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

', ], ], 'SystemMessage' => [ 'base' => NULL, 'refs' => [ 'TestCaseScenario$systemMessage' => '

Provides test case scenario system messages if any.

', ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

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

', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreateSuiteDefinitionRequest$tags' => '

The tags to be attached to the suite definition.

', 'GetSuiteDefinitionResponse$tags' => '

Tags attached to the suite definition.

', 'GetSuiteRunResponse$tags' => '

The tags attached to the suite run.

', 'ListTagsForResourceResponse$tags' => '

The tags attached to the IoT Device Advisor resource.

', 'StartSuiteRunRequest$tags' => '

The tags to be attached to the suite run.

', 'TagResourceRequest$tags' => '

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

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TestCaseDefinitionName' => [ 'base' => NULL, 'refs' => [ 'TestCaseRun$testCaseDefinitionName' => '

Provides the test case run definition name.

', ], ], 'TestCaseRun' => [ 'base' => '

Provides the test case run.

', 'refs' => [ 'TestCaseRuns$member' => NULL, ], ], 'TestCaseRuns' => [ 'base' => '

Tests under each group result.

', 'refs' => [ 'GroupResult$tests' => '

Tests under Group Result.

', ], ], 'TestCaseScenario' => [ 'base' => '

Provides test case scenario.

', 'refs' => [ 'TestCaseScenariosList$member' => NULL, ], ], 'TestCaseScenarioId' => [ 'base' => NULL, 'refs' => [ 'TestCaseScenario$testCaseScenarioId' => '

Provides test case scenario ID.

', ], ], 'TestCaseScenarioStatus' => [ 'base' => NULL, 'refs' => [ 'TestCaseScenario$status' => '

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.

', ], ], 'TestCaseScenarioType' => [ 'base' => NULL, 'refs' => [ 'TestCaseScenario$testCaseScenarioType' => '

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

Advanced
Basic

', ], ], 'TestCaseScenariosList' => [ 'base' => NULL, 'refs' => [ 'TestCaseRun$testScenarios' => '

Provides the test scenarios for the test case run.

', ], ], 'TestResult' => [ 'base' => '

Show each group result.

', 'refs' => [ 'GetSuiteRunResponse$testResult' => '

Test results for the test suite run.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'CreateSuiteDefinitionResponse$createdAt' => '

The timestamp of when the test suite was created.

', 'GetSuiteDefinitionResponse$createdAt' => '

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

', 'GetSuiteDefinitionResponse$lastModifiedAt' => '

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

', 'GetSuiteRunResponse$startTime' => '

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

', 'GetSuiteRunResponse$endTime' => '

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

', 'StartSuiteRunResponse$createdAt' => '

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

', 'SuiteDefinitionInformation$createdAt' => '

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

', 'SuiteRunInformation$createdAt' => '

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

', 'SuiteRunInformation$startedAt' => '

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

', 'SuiteRunInformation$endAt' => '

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

', 'TestCaseRun$startTime' => '

Provides test case run start time.

', 'TestCaseRun$endTime' => '

Provides test case run end time.

', 'UpdateSuiteDefinitionResponse$createdAt' => '

Timestamp of when the test suite was created.

', 'UpdateSuiteDefinitionResponse$lastUpdatedAt' => '

Timestamp of when the test suite was updated.

', ], ], 'Token' => [ 'base' => NULL, 'refs' => [ 'ListSuiteDefinitionsRequest$nextToken' => '

A token used to get the next set of results.

', 'ListSuiteDefinitionsResponse$nextToken' => '

A token used to get the next set of results.

', 'ListSuiteRunsRequest$nextToken' => '

A token to retrieve the next set of results.

', 'ListSuiteRunsResponse$nextToken' => '

A token to retrieve the next set of results.

', ], ], 'UUID' => [ 'base' => NULL, 'refs' => [ 'CreateSuiteDefinitionResponse$suiteDefinitionId' => '

The UUID of the test suite created.

', 'DeleteSuiteDefinitionRequest$suiteDefinitionId' => '

Suite definition ID of the test suite to be deleted.

', 'GetSuiteDefinitionRequest$suiteDefinitionId' => '

Suite definition ID of the test suite to get.

', 'GetSuiteDefinitionResponse$suiteDefinitionId' => '

Suite definition ID of the suite definition.

', 'GetSuiteRunReportRequest$suiteDefinitionId' => '

Suite definition ID of the test suite.

', 'GetSuiteRunReportRequest$suiteRunId' => '

Suite run ID of the test suite run.

', 'GetSuiteRunRequest$suiteDefinitionId' => '

Suite definition ID for the test suite run.

', 'GetSuiteRunRequest$suiteRunId' => '

Suite run ID for the test suite run.

', 'GetSuiteRunResponse$suiteDefinitionId' => '

Suite definition ID for the test suite run.

', 'GetSuiteRunResponse$suiteRunId' => '

Suite run ID for the test suite run.

', 'GroupResult$groupId' => '

Group result ID.

', 'ListSuiteRunsRequest$suiteDefinitionId' => '

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

', 'SelectedTestList$member' => NULL, 'StartSuiteRunRequest$suiteDefinitionId' => '

Suite definition ID of the test suite.

', 'StartSuiteRunResponse$suiteRunId' => '

Suite Run ID of the started suite run.

', 'StopSuiteRunRequest$suiteDefinitionId' => '

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

', 'StopSuiteRunRequest$suiteRunId' => '

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

', 'SuiteDefinitionInformation$suiteDefinitionId' => '

Suite definition ID of the test suite.

', 'SuiteRunInformation$suiteDefinitionId' => '

Suite definition ID of the suite run.

', 'SuiteRunInformation$suiteRunId' => '

Suite run ID of the suite run.

', 'TestCaseRun$testCaseRunId' => '

Provides the test case run ID.

', 'TestCaseRun$testCaseDefinitionId' => '

Provides the test case run definition ID.

', 'UpdateSuiteDefinitionRequest$suiteDefinitionId' => '

Suite definition ID of the test suite to be updated.

', 'UpdateSuiteDefinitionResponse$suiteDefinitionId' => '

Suite definition ID of the updated test suite.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSuiteDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSuiteDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

Sends a validation exception.

', 'refs' => [], ], 'Warnings' => [ 'base' => NULL, 'refs' => [ 'TestCaseRun$warnings' => '

Provides test case run warnings.

', ], ], ],];