Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTDeviceAdvisor.Lens

Contents

Operations
Types

Description

Synopsis

Operations

CreateSuiteDefinition

createSuiteDefinition_tags :: Lens' CreateSuiteDefinition (Maybe (HashMap Text Text)) Source #

The tags to be attached to the suite definition.

createSuiteDefinition_suiteDefinitionConfiguration :: Lens' CreateSuiteDefinition SuiteDefinitionConfiguration Source #

Creates a Device Advisor test suite with suite definition configuration.

createSuiteDefinitionResponse_createdAt :: Lens' CreateSuiteDefinitionResponse (Maybe UTCTime) Source #

The timestamp of when the test suite was created.

createSuiteDefinitionResponse_suiteDefinitionArn :: Lens' CreateSuiteDefinitionResponse (Maybe Text) Source #

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

createSuiteDefinitionResponse_suiteDefinitionId :: Lens' CreateSuiteDefinitionResponse (Maybe Text) Source #

The UUID of the test suite created.

createSuiteDefinitionResponse_suiteDefinitionName :: Lens' CreateSuiteDefinitionResponse (Maybe Text) Source #

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

createSuiteDefinitionResponse_httpStatus :: Lens' CreateSuiteDefinitionResponse Int Source #

The response's http status code.

DeleteSuiteDefinition

deleteSuiteDefinition_suiteDefinitionId :: Lens' DeleteSuiteDefinition Text Source #

Suite definition ID of the test suite to be deleted.

deleteSuiteDefinitionResponse_httpStatus :: Lens' DeleteSuiteDefinitionResponse Int Source #

The response's http status code.

GetEndpoint

getEndpoint_certificateArn :: Lens' GetEndpoint (Maybe Text) Source #

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

getEndpoint_thingArn :: Lens' GetEndpoint (Maybe Text) Source #

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

getEndpointResponse_endpoint :: Lens' GetEndpointResponse (Maybe Text) Source #

The response of an Device Advisor endpoint.

getEndpointResponse_httpStatus :: Lens' GetEndpointResponse Int Source #

The response's http status code.

GetSuiteDefinition

getSuiteDefinition_suiteDefinitionVersion :: Lens' GetSuiteDefinition (Maybe Text) Source #

Suite definition version of the test suite to get.

getSuiteDefinition_suiteDefinitionId :: Lens' GetSuiteDefinition Text Source #

Suite definition ID of the test suite to get.

getSuiteDefinitionResponse_createdAt :: Lens' GetSuiteDefinitionResponse (Maybe UTCTime) Source #

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

getSuiteDefinitionResponse_lastModifiedAt :: Lens' GetSuiteDefinitionResponse (Maybe UTCTime) Source #

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

getSuiteDefinitionResponse_latestVersion :: Lens' GetSuiteDefinitionResponse (Maybe Text) Source #

Latest suite definition version of the suite definition.

getSuiteDefinitionResponse_suiteDefinitionArn :: Lens' GetSuiteDefinitionResponse (Maybe Text) Source #

The ARN of the suite definition.

getSuiteDefinitionResponse_suiteDefinitionConfiguration :: Lens' GetSuiteDefinitionResponse (Maybe SuiteDefinitionConfiguration) Source #

Suite configuration of the suite definition.

getSuiteDefinitionResponse_suiteDefinitionId :: Lens' GetSuiteDefinitionResponse (Maybe Text) Source #

Suite definition ID of the suite definition.

getSuiteDefinitionResponse_suiteDefinitionVersion :: Lens' GetSuiteDefinitionResponse (Maybe Text) Source #

Suite definition version of the suite definition.

getSuiteDefinitionResponse_tags :: Lens' GetSuiteDefinitionResponse (Maybe (HashMap Text Text)) Source #

Tags attached to the suite definition.

getSuiteDefinitionResponse_httpStatus :: Lens' GetSuiteDefinitionResponse Int Source #

The response's http status code.

GetSuiteRun

getSuiteRun_suiteDefinitionId :: Lens' GetSuiteRun Text Source #

Suite definition ID for the test suite run.

getSuiteRun_suiteRunId :: Lens' GetSuiteRun Text Source #

Suite run ID for the test suite run.

getSuiteRunResponse_endTime :: Lens' GetSuiteRunResponse (Maybe UTCTime) Source #

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

getSuiteRunResponse_errorReason :: Lens' GetSuiteRunResponse (Maybe Text) Source #

Error reason for any test suite run failure.

getSuiteRunResponse_startTime :: Lens' GetSuiteRunResponse (Maybe UTCTime) Source #

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

getSuiteRunResponse_status :: Lens' GetSuiteRunResponse (Maybe SuiteRunStatus) Source #

Status for the test suite run.

getSuiteRunResponse_suiteDefinitionId :: Lens' GetSuiteRunResponse (Maybe Text) Source #

Suite definition ID for the test suite run.

getSuiteRunResponse_suiteDefinitionVersion :: Lens' GetSuiteRunResponse (Maybe Text) Source #

Suite definition version for the test suite run.

getSuiteRunResponse_suiteRunArn :: Lens' GetSuiteRunResponse (Maybe Text) Source #

The ARN of the suite run.

getSuiteRunResponse_suiteRunConfiguration :: Lens' GetSuiteRunResponse (Maybe SuiteRunConfiguration) Source #

Suite run configuration for the test suite run.

getSuiteRunResponse_suiteRunId :: Lens' GetSuiteRunResponse (Maybe Text) Source #

Suite run ID for the test suite run.

getSuiteRunResponse_tags :: Lens' GetSuiteRunResponse (Maybe (HashMap Text Text)) Source #

The tags attached to the suite run.

getSuiteRunResponse_testResult :: Lens' GetSuiteRunResponse (Maybe TestResult) Source #

Test results for the test suite run.

getSuiteRunResponse_httpStatus :: Lens' GetSuiteRunResponse Int Source #

The response's http status code.

GetSuiteRunReport

getSuiteRunReport_suiteDefinitionId :: Lens' GetSuiteRunReport Text Source #

Suite definition ID of the test suite.

getSuiteRunReport_suiteRunId :: Lens' GetSuiteRunReport Text Source #

Suite run ID of the test suite run.

getSuiteRunReportResponse_qualificationReportDownloadUrl :: Lens' GetSuiteRunReportResponse (Maybe Text) Source #

Download URL of the qualification report.

getSuiteRunReportResponse_httpStatus :: Lens' GetSuiteRunReportResponse Int Source #

The response's http status code.

ListSuiteDefinitions

listSuiteDefinitions_maxResults :: Lens' ListSuiteDefinitions (Maybe Natural) Source #

The maximum number of results to return at once.

listSuiteDefinitions_nextToken :: Lens' ListSuiteDefinitions (Maybe Text) Source #

A token used to get the next set of results.

listSuiteDefinitionsResponse_nextToken :: Lens' ListSuiteDefinitionsResponse (Maybe Text) Source #

A token used to get the next set of results.

listSuiteDefinitionsResponse_suiteDefinitionInformationList :: Lens' ListSuiteDefinitionsResponse (Maybe [SuiteDefinitionInformation]) Source #

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

listSuiteDefinitionsResponse_httpStatus :: Lens' ListSuiteDefinitionsResponse Int Source #

The response's http status code.

ListSuiteRuns

listSuiteRuns_maxResults :: Lens' ListSuiteRuns (Maybe Natural) Source #

The maximum number of results to return at once.

listSuiteRuns_nextToken :: Lens' ListSuiteRuns (Maybe Text) Source #

A token to retrieve the next set of results.

listSuiteRuns_suiteDefinitionId :: Lens' ListSuiteRuns (Maybe Text) Source #

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

listSuiteRuns_suiteDefinitionVersion :: Lens' ListSuiteRuns (Maybe Text) Source #

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

listSuiteRunsResponse_nextToken :: Lens' ListSuiteRunsResponse (Maybe Text) Source #

A token to retrieve the next set of results.

listSuiteRunsResponse_suiteRunsList :: Lens' ListSuiteRunsResponse (Maybe [SuiteRunInformation]) Source #

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

listSuiteRunsResponse_httpStatus :: Lens' ListSuiteRunsResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

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

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The tags attached to the IoT Device Advisor resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

StartSuiteRun

startSuiteRun_suiteDefinitionVersion :: Lens' StartSuiteRun (Maybe Text) Source #

Suite definition version of the test suite.

startSuiteRun_tags :: Lens' StartSuiteRun (Maybe (HashMap Text Text)) Source #

The tags to be attached to the suite run.

startSuiteRun_suiteDefinitionId :: Lens' StartSuiteRun Text Source #

Suite definition ID of the test suite.

startSuiteRun_suiteRunConfiguration :: Lens' StartSuiteRun SuiteRunConfiguration Source #

Suite run configuration.

startSuiteRunResponse_createdAt :: Lens' StartSuiteRunResponse (Maybe UTCTime) Source #

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

startSuiteRunResponse_endpoint :: Lens' StartSuiteRunResponse (Maybe Text) Source #

The response of an Device Advisor test endpoint.

startSuiteRunResponse_suiteRunArn :: Lens' StartSuiteRunResponse (Maybe Text) Source #

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

startSuiteRunResponse_suiteRunId :: Lens' StartSuiteRunResponse (Maybe Text) Source #

Suite Run ID of the started suite run.

startSuiteRunResponse_httpStatus :: Lens' StartSuiteRunResponse Int Source #

The response's http status code.

StopSuiteRun

stopSuiteRun_suiteDefinitionId :: Lens' StopSuiteRun Text Source #

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

stopSuiteRun_suiteRunId :: Lens' StopSuiteRun Text Source #

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

stopSuiteRunResponse_httpStatus :: Lens' StopSuiteRunResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

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

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

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

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

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

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

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

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateSuiteDefinition

updateSuiteDefinition_suiteDefinitionId :: Lens' UpdateSuiteDefinition Text Source #

Suite definition ID of the test suite to be updated.

updateSuiteDefinition_suiteDefinitionConfiguration :: Lens' UpdateSuiteDefinition SuiteDefinitionConfiguration Source #

Updates a Device Advisor test suite with suite definition configuration.

updateSuiteDefinitionResponse_createdAt :: Lens' UpdateSuiteDefinitionResponse (Maybe UTCTime) Source #

Timestamp of when the test suite was created.

updateSuiteDefinitionResponse_lastUpdatedAt :: Lens' UpdateSuiteDefinitionResponse (Maybe UTCTime) Source #

Timestamp of when the test suite was updated.

updateSuiteDefinitionResponse_suiteDefinitionArn :: Lens' UpdateSuiteDefinitionResponse (Maybe Text) Source #

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

updateSuiteDefinitionResponse_suiteDefinitionId :: Lens' UpdateSuiteDefinitionResponse (Maybe Text) Source #

Suite definition ID of the updated test suite.

updateSuiteDefinitionResponse_suiteDefinitionName :: Lens' UpdateSuiteDefinitionResponse (Maybe Text) Source #

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

updateSuiteDefinitionResponse_suiteDefinitionVersion :: Lens' UpdateSuiteDefinitionResponse (Maybe Text) Source #

Suite definition version of the updated test suite.

updateSuiteDefinitionResponse_httpStatus :: Lens' UpdateSuiteDefinitionResponse Int Source #

The response's http status code.

Types

DeviceUnderTest

deviceUnderTest_certificateArn :: Lens' DeviceUnderTest (Maybe Text) Source #

Lists devices certificate ARN.

deviceUnderTest_thingArn :: Lens' DeviceUnderTest (Maybe Text) Source #

Lists devices thing ARN.

GroupResult

groupResult_groupId :: Lens' GroupResult (Maybe Text) Source #

Group result ID.

groupResult_groupName :: Lens' GroupResult (Maybe Text) Source #

Group Result Name.

groupResult_tests :: Lens' GroupResult (Maybe [TestCaseRun]) Source #

Tests under Group Result.

SuiteDefinitionConfiguration

suiteDefinitionConfiguration_devices :: Lens' SuiteDefinitionConfiguration (Maybe [DeviceUnderTest]) Source #

Gets the devices configured.

suiteDefinitionConfiguration_intendedForQualification :: Lens' SuiteDefinitionConfiguration (Maybe Bool) Source #

Gets the tests intended for qualification in a suite.

suiteDefinitionConfiguration_isLongDurationTest :: Lens' SuiteDefinitionConfiguration (Maybe Bool) Source #

Verifies if the test suite is a long duration test.

suiteDefinitionConfiguration_protocol :: Lens' SuiteDefinitionConfiguration (Maybe Protocol) Source #

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

suiteDefinitionConfiguration_suiteDefinitionName :: Lens' SuiteDefinitionConfiguration Text Source #

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

suiteDefinitionConfiguration_rootGroup :: Lens' SuiteDefinitionConfiguration Text Source #

Gets the test suite root group. This is a required parameter.

suiteDefinitionConfiguration_devicePermissionRoleArn :: Lens' SuiteDefinitionConfiguration Text Source #

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

SuiteDefinitionInformation

suiteDefinitionInformation_createdAt :: Lens' SuiteDefinitionInformation (Maybe UTCTime) Source #

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

suiteDefinitionInformation_defaultDevices :: Lens' SuiteDefinitionInformation (Maybe [DeviceUnderTest]) Source #

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

suiteDefinitionInformation_intendedForQualification :: Lens' SuiteDefinitionInformation (Maybe Bool) Source #

Specifies if the test suite is intended for qualification.

suiteDefinitionInformation_isLongDurationTest :: Lens' SuiteDefinitionInformation (Maybe Bool) Source #

Verifies if the test suite is a long duration test.

suiteDefinitionInformation_protocol :: Lens' SuiteDefinitionInformation (Maybe Protocol) Source #

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

suiteDefinitionInformation_suiteDefinitionId :: Lens' SuiteDefinitionInformation (Maybe Text) Source #

Suite definition ID of the test suite.

suiteDefinitionInformation_suiteDefinitionName :: Lens' SuiteDefinitionInformation (Maybe Text) Source #

Suite name of the test suite.

SuiteRunConfiguration

suiteRunConfiguration_parallelRun :: Lens' SuiteRunConfiguration (Maybe Bool) Source #

TRUE if multiple test suites run in parallel.

suiteRunConfiguration_selectedTestList :: Lens' SuiteRunConfiguration (Maybe [Text]) Source #

Sets test case list.

suiteRunConfiguration_primaryDevice :: Lens' SuiteRunConfiguration DeviceUnderTest Source #

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

SuiteRunInformation

suiteRunInformation_createdAt :: Lens' SuiteRunInformation (Maybe UTCTime) Source #

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

suiteRunInformation_endAt :: Lens' SuiteRunInformation (Maybe UTCTime) Source #

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

suiteRunInformation_failed :: Lens' SuiteRunInformation (Maybe Natural) Source #

Number of test cases that failed in the suite run.

suiteRunInformation_passed :: Lens' SuiteRunInformation (Maybe Natural) Source #

Number of test cases that passed in the suite run.

suiteRunInformation_startedAt :: Lens' SuiteRunInformation (Maybe UTCTime) Source #

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

suiteRunInformation_status :: Lens' SuiteRunInformation (Maybe SuiteRunStatus) Source #

Status of the suite run.

suiteRunInformation_suiteDefinitionId :: Lens' SuiteRunInformation (Maybe Text) Source #

Suite definition ID of the suite run.

suiteRunInformation_suiteDefinitionName :: Lens' SuiteRunInformation (Maybe Text) Source #

Suite definition name of the suite run.

suiteRunInformation_suiteDefinitionVersion :: Lens' SuiteRunInformation (Maybe Text) Source #

Suite definition version of the suite run.

suiteRunInformation_suiteRunId :: Lens' SuiteRunInformation (Maybe Text) Source #

Suite run ID of the suite run.

TestCaseRun

testCaseRun_endTime :: Lens' TestCaseRun (Maybe UTCTime) Source #

Provides test case run end time.

testCaseRun_failure :: Lens' TestCaseRun (Maybe Text) Source #

Provides test case run failure result.

testCaseRun_logUrl :: Lens' TestCaseRun (Maybe Text) Source #

Provides test case run log URL.

testCaseRun_startTime :: Lens' TestCaseRun (Maybe UTCTime) Source #

Provides test case run start time.

testCaseRun_status :: Lens' TestCaseRun (Maybe Status) Source #

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.

testCaseRun_testCaseDefinitionId :: Lens' TestCaseRun (Maybe Text) Source #

Provides the test case run definition ID.

testCaseRun_testCaseDefinitionName :: Lens' TestCaseRun (Maybe Text) Source #

Provides the test case run definition name.

testCaseRun_testCaseRunId :: Lens' TestCaseRun (Maybe Text) Source #

Provides the test case run ID.

testCaseRun_testScenarios :: Lens' TestCaseRun (Maybe [TestCaseScenario]) Source #

Provides the test scenarios for the test case run.

testCaseRun_warnings :: Lens' TestCaseRun (Maybe Text) Source #

Provides test case run warnings.

TestCaseScenario

testCaseScenario_failure :: Lens' TestCaseScenario (Maybe Text) Source #

Provides test case scenario failure result.

testCaseScenario_status :: Lens' TestCaseScenario (Maybe TestCaseScenarioStatus) Source #

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.

testCaseScenario_systemMessage :: Lens' TestCaseScenario (Maybe Text) Source #

testCaseScenario_testCaseScenarioId :: Lens' TestCaseScenario (Maybe Text) Source #

Provides test case scenario ID.

testCaseScenario_testCaseScenarioType :: Lens' TestCaseScenario (Maybe TestCaseScenarioType) Source #

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

Advanced
Basic

TestResult

testResult_groups :: Lens' TestResult (Maybe [GroupResult]) Source #

Show each group of test results.