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 |
Derived from API version 2020-09-18
of the AWS service descriptions, licensed under Apache 2.0.
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.
Synopsis
- defaultService :: Service
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateSuiteDefinition = CreateSuiteDefinition' (Maybe (HashMap Text Text)) SuiteDefinitionConfiguration
- newCreateSuiteDefinition :: SuiteDefinitionConfiguration -> CreateSuiteDefinition
- data CreateSuiteDefinitionResponse = CreateSuiteDefinitionResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateSuiteDefinitionResponse :: Int -> CreateSuiteDefinitionResponse
- data DeleteSuiteDefinition = DeleteSuiteDefinition' Text
- newDeleteSuiteDefinition :: Text -> DeleteSuiteDefinition
- data DeleteSuiteDefinitionResponse = DeleteSuiteDefinitionResponse' Int
- newDeleteSuiteDefinitionResponse :: Int -> DeleteSuiteDefinitionResponse
- data GetEndpoint = GetEndpoint' (Maybe Text) (Maybe Text)
- newGetEndpoint :: GetEndpoint
- data GetEndpointResponse = GetEndpointResponse' (Maybe Text) Int
- newGetEndpointResponse :: Int -> GetEndpointResponse
- data GetSuiteDefinition = GetSuiteDefinition' (Maybe Text) Text
- newGetSuiteDefinition :: Text -> GetSuiteDefinition
- data GetSuiteDefinitionResponse = GetSuiteDefinitionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe SuiteDefinitionConfiguration) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newGetSuiteDefinitionResponse :: Int -> GetSuiteDefinitionResponse
- data GetSuiteRun = GetSuiteRun' Text Text
- newGetSuiteRun :: Text -> Text -> GetSuiteRun
- data GetSuiteRunResponse = GetSuiteRunResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe SuiteRunStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SuiteRunConfiguration) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe TestResult) Int
- newGetSuiteRunResponse :: Int -> GetSuiteRunResponse
- data GetSuiteRunReport = GetSuiteRunReport' Text Text
- newGetSuiteRunReport :: Text -> Text -> GetSuiteRunReport
- data GetSuiteRunReportResponse = GetSuiteRunReportResponse' (Maybe Text) Int
- newGetSuiteRunReportResponse :: Int -> GetSuiteRunReportResponse
- data ListSuiteDefinitions = ListSuiteDefinitions' (Maybe Natural) (Maybe Text)
- newListSuiteDefinitions :: ListSuiteDefinitions
- data ListSuiteDefinitionsResponse = ListSuiteDefinitionsResponse' (Maybe Text) (Maybe [SuiteDefinitionInformation]) Int
- newListSuiteDefinitionsResponse :: Int -> ListSuiteDefinitionsResponse
- data ListSuiteRuns = ListSuiteRuns' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text)
- newListSuiteRuns :: ListSuiteRuns
- data ListSuiteRunsResponse = ListSuiteRunsResponse' (Maybe Text) (Maybe [SuiteRunInformation]) Int
- newListSuiteRunsResponse :: Int -> ListSuiteRunsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data StartSuiteRun = StartSuiteRun' (Maybe Text) (Maybe (HashMap Text Text)) Text SuiteRunConfiguration
- newStartSuiteRun :: Text -> SuiteRunConfiguration -> StartSuiteRun
- data StartSuiteRunResponse = StartSuiteRunResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newStartSuiteRunResponse :: Int -> StartSuiteRunResponse
- data StopSuiteRun = StopSuiteRun' Text Text
- newStopSuiteRun :: Text -> Text -> StopSuiteRun
- data StopSuiteRunResponse = StopSuiteRunResponse' Int
- newStopSuiteRunResponse :: Int -> StopSuiteRunResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateSuiteDefinition = UpdateSuiteDefinition' Text SuiteDefinitionConfiguration
- newUpdateSuiteDefinition :: Text -> SuiteDefinitionConfiguration -> UpdateSuiteDefinition
- data UpdateSuiteDefinitionResponse = UpdateSuiteDefinitionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateSuiteDefinitionResponse :: Int -> UpdateSuiteDefinitionResponse
- newtype Protocol where
- Protocol' {
- fromProtocol :: Text
- pattern Protocol_MqttV3_1_1 :: Protocol
- pattern Protocol_MqttV5 :: Protocol
- Protocol' {
- newtype Status where
- Status' {
- fromStatus :: Text
- pattern Status_CANCELED :: Status
- pattern Status_ERROR :: Status
- pattern Status_FAIL :: Status
- pattern Status_PASS :: Status
- pattern Status_PASS_WITH_WARNINGS :: Status
- pattern Status_PENDING :: Status
- pattern Status_RUNNING :: Status
- pattern Status_STOPPED :: Status
- pattern Status_STOPPING :: Status
- Status' {
- newtype SuiteRunStatus where
- SuiteRunStatus' { }
- pattern SuiteRunStatus_CANCELED :: SuiteRunStatus
- pattern SuiteRunStatus_ERROR :: SuiteRunStatus
- pattern SuiteRunStatus_FAIL :: SuiteRunStatus
- pattern SuiteRunStatus_PASS :: SuiteRunStatus
- pattern SuiteRunStatus_PASS_WITH_WARNINGS :: SuiteRunStatus
- pattern SuiteRunStatus_PENDING :: SuiteRunStatus
- pattern SuiteRunStatus_RUNNING :: SuiteRunStatus
- pattern SuiteRunStatus_STOPPED :: SuiteRunStatus
- pattern SuiteRunStatus_STOPPING :: SuiteRunStatus
- newtype TestCaseScenarioStatus where
- TestCaseScenarioStatus' { }
- pattern TestCaseScenarioStatus_CANCELED :: TestCaseScenarioStatus
- pattern TestCaseScenarioStatus_ERROR :: TestCaseScenarioStatus
- pattern TestCaseScenarioStatus_FAIL :: TestCaseScenarioStatus
- pattern TestCaseScenarioStatus_PASS :: TestCaseScenarioStatus
- pattern TestCaseScenarioStatus_PASS_WITH_WARNINGS :: TestCaseScenarioStatus
- pattern TestCaseScenarioStatus_PENDING :: TestCaseScenarioStatus
- pattern TestCaseScenarioStatus_RUNNING :: TestCaseScenarioStatus
- pattern TestCaseScenarioStatus_STOPPED :: TestCaseScenarioStatus
- pattern TestCaseScenarioStatus_STOPPING :: TestCaseScenarioStatus
- newtype TestCaseScenarioType where
- data DeviceUnderTest = DeviceUnderTest' (Maybe Text) (Maybe Text)
- newDeviceUnderTest :: DeviceUnderTest
- data GroupResult = GroupResult' (Maybe Text) (Maybe Text) (Maybe [TestCaseRun])
- newGroupResult :: GroupResult
- data SuiteDefinitionConfiguration = SuiteDefinitionConfiguration' (Maybe [DeviceUnderTest]) (Maybe Bool) (Maybe Bool) (Maybe Protocol) Text Text Text
- newSuiteDefinitionConfiguration :: Text -> Text -> Text -> SuiteDefinitionConfiguration
- data SuiteDefinitionInformation = SuiteDefinitionInformation' (Maybe POSIX) (Maybe [DeviceUnderTest]) (Maybe Bool) (Maybe Bool) (Maybe Protocol) (Maybe Text) (Maybe Text)
- newSuiteDefinitionInformation :: SuiteDefinitionInformation
- data SuiteRunConfiguration = SuiteRunConfiguration' (Maybe Bool) (Maybe [Text]) DeviceUnderTest
- newSuiteRunConfiguration :: DeviceUnderTest -> SuiteRunConfiguration
- data SuiteRunInformation = SuiteRunInformation' (Maybe POSIX) (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe POSIX) (Maybe SuiteRunStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newSuiteRunInformation :: SuiteRunInformation
- data TestCaseRun = TestCaseRun' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Status) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [TestCaseScenario]) (Maybe Text)
- newTestCaseRun :: TestCaseRun
- data TestCaseScenario = TestCaseScenario' (Maybe Text) (Maybe TestCaseScenarioStatus) (Maybe Text) (Maybe Text) (Maybe TestCaseScenarioType)
- newTestCaseScenario :: TestCaseScenario
- data TestResult = TestResult' (Maybe [GroupResult])
- newTestResult :: TestResult
Service Configuration
defaultService :: Service Source #
API version 2020-09-18
of the Amazon IoT Core Device Advisor SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoTDeviceAdvisor
.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Sends a Conflict Exception.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Sends an Internal Failure exception.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Sends a Resource Not Found exception.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Sends a validation exception.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateSuiteDefinition
data CreateSuiteDefinition Source #
See: newCreateSuiteDefinition
smart constructor.
Instances
newCreateSuiteDefinition Source #
Create a value of CreateSuiteDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateSuiteDefinition'
, createSuiteDefinition_tags
- The tags to be attached to the suite definition.
$sel:suiteDefinitionConfiguration:CreateSuiteDefinition'
, createSuiteDefinition_suiteDefinitionConfiguration
- Creates a Device Advisor test suite with suite definition configuration.
data CreateSuiteDefinitionResponse Source #
See: newCreateSuiteDefinitionResponse
smart constructor.
Instances
newCreateSuiteDefinitionResponse Source #
Create a value of CreateSuiteDefinitionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSuiteDefinitionResponse
, createSuiteDefinitionResponse_createdAt
- The timestamp of when the test suite was created.
$sel:suiteDefinitionArn:CreateSuiteDefinitionResponse'
, createSuiteDefinitionResponse_suiteDefinitionArn
- The Amazon Resource Name (ARN) of the test suite.
CreateSuiteDefinitionResponse
, createSuiteDefinitionResponse_suiteDefinitionId
- The UUID of the test suite created.
CreateSuiteDefinitionResponse
, createSuiteDefinitionResponse_suiteDefinitionName
- The suite definition name of the test suite. This is a required
parameter.
$sel:httpStatus:CreateSuiteDefinitionResponse'
, createSuiteDefinitionResponse_httpStatus
- The response's http status code.
DeleteSuiteDefinition
data DeleteSuiteDefinition Source #
See: newDeleteSuiteDefinition
smart constructor.
Instances
newDeleteSuiteDefinition Source #
Create a value of DeleteSuiteDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSuiteDefinition
, deleteSuiteDefinition_suiteDefinitionId
- Suite definition ID of the test suite to be deleted.
data DeleteSuiteDefinitionResponse Source #
See: newDeleteSuiteDefinitionResponse
smart constructor.
Instances
newDeleteSuiteDefinitionResponse Source #
Create a value of DeleteSuiteDefinitionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteSuiteDefinitionResponse'
, deleteSuiteDefinitionResponse_httpStatus
- The response's http status code.
GetEndpoint
data GetEndpoint Source #
See: newGetEndpoint
smart constructor.
GetEndpoint' (Maybe Text) (Maybe Text) |
Instances
newGetEndpoint :: GetEndpoint Source #
Create a value of GetEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEndpoint
, getEndpoint_certificateArn
- The certificate ARN of the device. This is an optional parameter.
GetEndpoint
, getEndpoint_thingArn
- The thing ARN of the device. This is an optional parameter.
data GetEndpointResponse Source #
See: newGetEndpointResponse
smart constructor.
Instances
newGetEndpointResponse Source #
Create a value of GetEndpointResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpoint:GetEndpointResponse'
, getEndpointResponse_endpoint
- The response of an Device Advisor endpoint.
$sel:httpStatus:GetEndpointResponse'
, getEndpointResponse_httpStatus
- The response's http status code.
GetSuiteDefinition
data GetSuiteDefinition Source #
See: newGetSuiteDefinition
smart constructor.
Instances
newGetSuiteDefinition Source #
Create a value of GetSuiteDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSuiteDefinition
, getSuiteDefinition_suiteDefinitionVersion
- Suite definition version of the test suite to get.
GetSuiteDefinition
, getSuiteDefinition_suiteDefinitionId
- Suite definition ID of the test suite to get.
data GetSuiteDefinitionResponse Source #
See: newGetSuiteDefinitionResponse
smart constructor.
GetSuiteDefinitionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe SuiteDefinitionConfiguration) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newGetSuiteDefinitionResponse Source #
Create a value of GetSuiteDefinitionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSuiteDefinitionResponse
, getSuiteDefinitionResponse_createdAt
- Date (in Unix epoch time) when the suite definition was created.
$sel:lastModifiedAt:GetSuiteDefinitionResponse'
, getSuiteDefinitionResponse_lastModifiedAt
- Date (in Unix epoch time) when the suite definition was last modified.
$sel:latestVersion:GetSuiteDefinitionResponse'
, getSuiteDefinitionResponse_latestVersion
- Latest suite definition version of the suite definition.
$sel:suiteDefinitionArn:GetSuiteDefinitionResponse'
, getSuiteDefinitionResponse_suiteDefinitionArn
- The ARN of the suite definition.
$sel:suiteDefinitionConfiguration:GetSuiteDefinitionResponse'
, getSuiteDefinitionResponse_suiteDefinitionConfiguration
- Suite configuration of the suite definition.
GetSuiteDefinition
, getSuiteDefinitionResponse_suiteDefinitionId
- Suite definition ID of the suite definition.
GetSuiteDefinition
, getSuiteDefinitionResponse_suiteDefinitionVersion
- Suite definition version of the suite definition.
$sel:tags:GetSuiteDefinitionResponse'
, getSuiteDefinitionResponse_tags
- Tags attached to the suite definition.
$sel:httpStatus:GetSuiteDefinitionResponse'
, getSuiteDefinitionResponse_httpStatus
- The response's http status code.
GetSuiteRun
data GetSuiteRun Source #
See: newGetSuiteRun
smart constructor.
Instances
Create a value of GetSuiteRun
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSuiteRun
, getSuiteRun_suiteDefinitionId
- Suite definition ID for the test suite run.
GetSuiteRun
, getSuiteRun_suiteRunId
- Suite run ID for the test suite run.
data GetSuiteRunResponse Source #
See: newGetSuiteRunResponse
smart constructor.
GetSuiteRunResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe SuiteRunStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SuiteRunConfiguration) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe TestResult) Int |
Instances
newGetSuiteRunResponse Source #
Create a value of GetSuiteRunResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSuiteRunResponse
, getSuiteRunResponse_endTime
- Date (in Unix epoch time) when the test suite run ended.
$sel:errorReason:GetSuiteRunResponse'
, getSuiteRunResponse_errorReason
- Error reason for any test suite run failure.
GetSuiteRunResponse
, getSuiteRunResponse_startTime
- Date (in Unix epoch time) when the test suite run started.
GetSuiteRunResponse
, getSuiteRunResponse_status
- Status for the test suite run.
GetSuiteRun
, getSuiteRunResponse_suiteDefinitionId
- Suite definition ID for the test suite run.
GetSuiteRunResponse
, getSuiteRunResponse_suiteDefinitionVersion
- Suite definition version for the test suite run.
$sel:suiteRunArn:GetSuiteRunResponse'
, getSuiteRunResponse_suiteRunArn
- The ARN of the suite run.
$sel:suiteRunConfiguration:GetSuiteRunResponse'
, getSuiteRunResponse_suiteRunConfiguration
- Suite run configuration for the test suite run.
GetSuiteRun
, getSuiteRunResponse_suiteRunId
- Suite run ID for the test suite run.
$sel:tags:GetSuiteRunResponse'
, getSuiteRunResponse_tags
- The tags attached to the suite run.
$sel:testResult:GetSuiteRunResponse'
, getSuiteRunResponse_testResult
- Test results for the test suite run.
$sel:httpStatus:GetSuiteRunResponse'
, getSuiteRunResponse_httpStatus
- The response's http status code.
GetSuiteRunReport
data GetSuiteRunReport Source #
See: newGetSuiteRunReport
smart constructor.
Instances
Create a value of GetSuiteRunReport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSuiteRunReport
, getSuiteRunReport_suiteDefinitionId
- Suite definition ID of the test suite.
GetSuiteRunReport
, getSuiteRunReport_suiteRunId
- Suite run ID of the test suite run.
data GetSuiteRunReportResponse Source #
See: newGetSuiteRunReportResponse
smart constructor.
Instances
newGetSuiteRunReportResponse Source #
Create a value of GetSuiteRunReportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:qualificationReportDownloadUrl:GetSuiteRunReportResponse'
, getSuiteRunReportResponse_qualificationReportDownloadUrl
- Download URL of the qualification report.
$sel:httpStatus:GetSuiteRunReportResponse'
, getSuiteRunReportResponse_httpStatus
- The response's http status code.
ListSuiteDefinitions
data ListSuiteDefinitions Source #
See: newListSuiteDefinitions
smart constructor.
Instances
newListSuiteDefinitions :: ListSuiteDefinitions Source #
Create a value of ListSuiteDefinitions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListSuiteDefinitions'
, listSuiteDefinitions_maxResults
- The maximum number of results to return at once.
ListSuiteDefinitions
, listSuiteDefinitions_nextToken
- A token used to get the next set of results.
data ListSuiteDefinitionsResponse Source #
See: newListSuiteDefinitionsResponse
smart constructor.
Instances
newListSuiteDefinitionsResponse Source #
Create a value of ListSuiteDefinitionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSuiteDefinitions
, listSuiteDefinitionsResponse_nextToken
- A token used to get the next set of results.
$sel:suiteDefinitionInformationList:ListSuiteDefinitionsResponse'
, listSuiteDefinitionsResponse_suiteDefinitionInformationList
- An array of objects that provide summaries of information about the
suite definitions in the list.
$sel:httpStatus:ListSuiteDefinitionsResponse'
, listSuiteDefinitionsResponse_httpStatus
- The response's http status code.
ListSuiteRuns
data ListSuiteRuns Source #
See: newListSuiteRuns
smart constructor.
Instances
newListSuiteRuns :: ListSuiteRuns Source #
Create a value of ListSuiteRuns
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListSuiteRuns'
, listSuiteRuns_maxResults
- The maximum number of results to return at once.
ListSuiteRuns
, listSuiteRuns_nextToken
- A token to retrieve the next set of results.
ListSuiteRuns
, listSuiteRuns_suiteDefinitionId
- Lists the test suite runs of the specified test suite based on suite
definition ID.
ListSuiteRuns
, listSuiteRuns_suiteDefinitionVersion
- Must be passed along with suiteDefinitionId
. Lists the test suite runs
of the specified test suite based on suite definition version.
data ListSuiteRunsResponse Source #
See: newListSuiteRunsResponse
smart constructor.
Instances
newListSuiteRunsResponse Source #
Create a value of ListSuiteRunsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSuiteRuns
, listSuiteRunsResponse_nextToken
- A token to retrieve the next set of results.
$sel:suiteRunsList:ListSuiteRunsResponse'
, listSuiteRunsResponse_suiteRunsList
- An array of objects that provide summaries of information about the
suite runs in the list.
$sel:httpStatus:ListSuiteRunsResponse'
, listSuiteRunsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The resource ARN of the IoT Device Advisor resource. This can be
SuiteDefinition ARN or SuiteRun ARN.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The tags attached to the IoT Device Advisor resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
StartSuiteRun
data StartSuiteRun Source #
See: newStartSuiteRun
smart constructor.
Instances
Create a value of StartSuiteRun
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartSuiteRun
, startSuiteRun_suiteDefinitionVersion
- Suite definition version of the test suite.
$sel:tags:StartSuiteRun'
, startSuiteRun_tags
- The tags to be attached to the suite run.
StartSuiteRun
, startSuiteRun_suiteDefinitionId
- Suite definition ID of the test suite.
$sel:suiteRunConfiguration:StartSuiteRun'
, startSuiteRun_suiteRunConfiguration
- Suite run configuration.
data StartSuiteRunResponse Source #
See: newStartSuiteRunResponse
smart constructor.
Instances
newStartSuiteRunResponse Source #
Create a value of StartSuiteRunResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartSuiteRunResponse
, startSuiteRunResponse_createdAt
- Starts a Device Advisor test suite run based on suite create time.
$sel:endpoint:StartSuiteRunResponse'
, startSuiteRunResponse_endpoint
- The response of an Device Advisor test endpoint.
$sel:suiteRunArn:StartSuiteRunResponse'
, startSuiteRunResponse_suiteRunArn
- Amazon Resource Name (ARN) of the started suite run.
StartSuiteRunResponse
, startSuiteRunResponse_suiteRunId
- Suite Run ID of the started suite run.
$sel:httpStatus:StartSuiteRunResponse'
, startSuiteRunResponse_httpStatus
- The response's http status code.
StopSuiteRun
data StopSuiteRun Source #
See: newStopSuiteRun
smart constructor.
Instances
Create a value of StopSuiteRun
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopSuiteRun
, stopSuiteRun_suiteDefinitionId
- Suite definition ID of the test suite run to be stopped.
StopSuiteRun
, stopSuiteRun_suiteRunId
- Suite run ID of the test suite run to be stopped.
data StopSuiteRunResponse Source #
See: newStopSuiteRunResponse
smart constructor.
Instances
newStopSuiteRunResponse Source #
Create a value of StopSuiteRunResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopSuiteRunResponse'
, stopSuiteRunResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The resource ARN of an IoT Device Advisor resource. This can be
SuiteDefinition ARN or SuiteRun ARN.
$sel:tags:TagResource'
, tagResource_tags
- The tags to be attached to the IoT Device Advisor resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The resource ARN of an IoT Device Advisor resource. This can be
SuiteDefinition ARN or SuiteRun ARN.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- List of tag keys to remove from the IoT Device Advisor resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateSuiteDefinition
data UpdateSuiteDefinition Source #
See: newUpdateSuiteDefinition
smart constructor.
Instances
newUpdateSuiteDefinition Source #
Create a value of UpdateSuiteDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateSuiteDefinition
, updateSuiteDefinition_suiteDefinitionId
- Suite definition ID of the test suite to be updated.
$sel:suiteDefinitionConfiguration:UpdateSuiteDefinition'
, updateSuiteDefinition_suiteDefinitionConfiguration
- Updates a Device Advisor test suite with suite definition configuration.
data UpdateSuiteDefinitionResponse Source #
See: newUpdateSuiteDefinitionResponse
smart constructor.
UpdateSuiteDefinitionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newUpdateSuiteDefinitionResponse Source #
Create a value of UpdateSuiteDefinitionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateSuiteDefinitionResponse
, updateSuiteDefinitionResponse_createdAt
- Timestamp of when the test suite was created.
$sel:lastUpdatedAt:UpdateSuiteDefinitionResponse'
, updateSuiteDefinitionResponse_lastUpdatedAt
- Timestamp of when the test suite was updated.
$sel:suiteDefinitionArn:UpdateSuiteDefinitionResponse'
, updateSuiteDefinitionResponse_suiteDefinitionArn
- Amazon Resource Name (ARN) of the updated test suite.
UpdateSuiteDefinition
, updateSuiteDefinitionResponse_suiteDefinitionId
- Suite definition ID of the updated test suite.
UpdateSuiteDefinitionResponse
, updateSuiteDefinitionResponse_suiteDefinitionName
- Updates the suite definition name. This is a required parameter.
UpdateSuiteDefinitionResponse
, updateSuiteDefinitionResponse_suiteDefinitionVersion
- Suite definition version of the updated test suite.
$sel:httpStatus:UpdateSuiteDefinitionResponse'
, updateSuiteDefinitionResponse_httpStatus
- The response's http status code.
Types
Protocol
pattern Protocol_MqttV3_1_1 :: Protocol | |
pattern Protocol_MqttV5 :: Protocol |
Instances
Status
pattern Status_CANCELED :: Status | |
pattern Status_ERROR :: Status | |
pattern Status_FAIL :: Status | |
pattern Status_PASS :: Status | |
pattern Status_PASS_WITH_WARNINGS :: Status | |
pattern Status_PENDING :: Status | |
pattern Status_RUNNING :: Status | |
pattern Status_STOPPED :: Status | |
pattern Status_STOPPING :: Status |
Instances
SuiteRunStatus
newtype SuiteRunStatus Source #
pattern SuiteRunStatus_CANCELED :: SuiteRunStatus | |
pattern SuiteRunStatus_ERROR :: SuiteRunStatus | |
pattern SuiteRunStatus_FAIL :: SuiteRunStatus | |
pattern SuiteRunStatus_PASS :: SuiteRunStatus | |
pattern SuiteRunStatus_PASS_WITH_WARNINGS :: SuiteRunStatus | |
pattern SuiteRunStatus_PENDING :: SuiteRunStatus | |
pattern SuiteRunStatus_RUNNING :: SuiteRunStatus | |
pattern SuiteRunStatus_STOPPED :: SuiteRunStatus | |
pattern SuiteRunStatus_STOPPING :: SuiteRunStatus |
Instances
TestCaseScenarioStatus
newtype TestCaseScenarioStatus Source #
Instances
TestCaseScenarioType
newtype TestCaseScenarioType Source #
pattern TestCaseScenarioType_Advanced :: TestCaseScenarioType | |
pattern TestCaseScenarioType_Basic :: TestCaseScenarioType |
Instances
DeviceUnderTest
data DeviceUnderTest Source #
Information of a test device. A thing ARN or a certificate ARN is required.
See: newDeviceUnderTest
smart constructor.
Instances
newDeviceUnderTest :: DeviceUnderTest Source #
Create a value of DeviceUnderTest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateArn:DeviceUnderTest'
, deviceUnderTest_certificateArn
- Lists devices certificate ARN.
$sel:thingArn:DeviceUnderTest'
, deviceUnderTest_thingArn
- Lists devices thing ARN.
GroupResult
data GroupResult Source #
Show Group Result.
See: newGroupResult
smart constructor.
GroupResult' (Maybe Text) (Maybe Text) (Maybe [TestCaseRun]) |
Instances
newGroupResult :: GroupResult Source #
Create a value of GroupResult
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupId:GroupResult'
, groupResult_groupId
- Group result ID.
$sel:groupName:GroupResult'
, groupResult_groupName
- Group Result Name.
$sel:tests:GroupResult'
, groupResult_tests
- Tests under Group Result.
SuiteDefinitionConfiguration
data SuiteDefinitionConfiguration Source #
Gets the suite definition configuration.
See: newSuiteDefinitionConfiguration
smart constructor.
SuiteDefinitionConfiguration' (Maybe [DeviceUnderTest]) (Maybe Bool) (Maybe Bool) (Maybe Protocol) Text Text Text |
Instances
newSuiteDefinitionConfiguration Source #
:: Text | |
-> Text | |
-> Text | |
-> SuiteDefinitionConfiguration |
Create a value of SuiteDefinitionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:devices:SuiteDefinitionConfiguration'
, suiteDefinitionConfiguration_devices
- Gets the devices configured.
$sel:intendedForQualification:SuiteDefinitionConfiguration'
, suiteDefinitionConfiguration_intendedForQualification
- Gets the tests intended for qualification in a suite.
$sel:isLongDurationTest:SuiteDefinitionConfiguration'
, suiteDefinitionConfiguration_isLongDurationTest
- Verifies if the test suite is a long duration test.
$sel:protocol:SuiteDefinitionConfiguration'
, suiteDefinitionConfiguration_protocol
- Sets the MQTT protocol that is configured in the suite definition.
$sel:suiteDefinitionName:SuiteDefinitionConfiguration'
, suiteDefinitionConfiguration_suiteDefinitionName
- Gets the suite definition name. This is a required parameter.
$sel:rootGroup:SuiteDefinitionConfiguration'
, suiteDefinitionConfiguration_rootGroup
- Gets the test suite root group. This is a required parameter.
$sel:devicePermissionRoleArn:SuiteDefinitionConfiguration'
, suiteDefinitionConfiguration_devicePermissionRoleArn
- Gets the device permission ARN. This is a required parameter.
SuiteDefinitionInformation
data SuiteDefinitionInformation Source #
Information about the suite definition.
See: newSuiteDefinitionInformation
smart constructor.
SuiteDefinitionInformation' (Maybe POSIX) (Maybe [DeviceUnderTest]) (Maybe Bool) (Maybe Bool) (Maybe Protocol) (Maybe Text) (Maybe Text) |
Instances
newSuiteDefinitionInformation :: SuiteDefinitionInformation Source #
Create a value of SuiteDefinitionInformation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdAt:SuiteDefinitionInformation'
, suiteDefinitionInformation_createdAt
- Date (in Unix epoch time) when the test suite was created.
$sel:defaultDevices:SuiteDefinitionInformation'
, suiteDefinitionInformation_defaultDevices
- Specifies the devices that are under test for the test suite.
$sel:intendedForQualification:SuiteDefinitionInformation'
, suiteDefinitionInformation_intendedForQualification
- Specifies if the test suite is intended for qualification.
$sel:isLongDurationTest:SuiteDefinitionInformation'
, suiteDefinitionInformation_isLongDurationTest
- Verifies if the test suite is a long duration test.
$sel:protocol:SuiteDefinitionInformation'
, suiteDefinitionInformation_protocol
- Gets the MQTT protocol that is configured in the suite definition.
$sel:suiteDefinitionId:SuiteDefinitionInformation'
, suiteDefinitionInformation_suiteDefinitionId
- Suite definition ID of the test suite.
$sel:suiteDefinitionName:SuiteDefinitionInformation'
, suiteDefinitionInformation_suiteDefinitionName
- Suite name of the test suite.
SuiteRunConfiguration
data SuiteRunConfiguration Source #
Gets suite run configuration.
See: newSuiteRunConfiguration
smart constructor.
Instances
newSuiteRunConfiguration Source #
Create a value of SuiteRunConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parallelRun:SuiteRunConfiguration'
, suiteRunConfiguration_parallelRun
- TRUE if multiple test suites run in parallel.
$sel:selectedTestList:SuiteRunConfiguration'
, suiteRunConfiguration_selectedTestList
- Sets test case list.
$sel:primaryDevice:SuiteRunConfiguration'
, suiteRunConfiguration_primaryDevice
- Sets the primary device for the test suite run. This requires a thing
ARN or a certificate ARN.
SuiteRunInformation
data SuiteRunInformation Source #
Information about the suite run.
Requires permission to access the SuiteRunInformation action.
See: newSuiteRunInformation
smart constructor.
SuiteRunInformation' (Maybe POSIX) (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe POSIX) (Maybe SuiteRunStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newSuiteRunInformation :: SuiteRunInformation Source #
Create a value of SuiteRunInformation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdAt:SuiteRunInformation'
, suiteRunInformation_createdAt
- Date (in Unix epoch time) when the suite run was created.
$sel:endAt:SuiteRunInformation'
, suiteRunInformation_endAt
- Date (in Unix epoch time) when the suite run ended.
$sel:failed:SuiteRunInformation'
, suiteRunInformation_failed
- Number of test cases that failed in the suite run.
$sel:passed:SuiteRunInformation'
, suiteRunInformation_passed
- Number of test cases that passed in the suite run.
$sel:startedAt:SuiteRunInformation'
, suiteRunInformation_startedAt
- Date (in Unix epoch time) when the suite run was started.
$sel:status:SuiteRunInformation'
, suiteRunInformation_status
- Status of the suite run.
$sel:suiteDefinitionId:SuiteRunInformation'
, suiteRunInformation_suiteDefinitionId
- Suite definition ID of the suite run.
$sel:suiteDefinitionName:SuiteRunInformation'
, suiteRunInformation_suiteDefinitionName
- Suite definition name of the suite run.
$sel:suiteDefinitionVersion:SuiteRunInformation'
, suiteRunInformation_suiteDefinitionVersion
- Suite definition version of the suite run.
$sel:suiteRunId:SuiteRunInformation'
, suiteRunInformation_suiteRunId
- Suite run ID of the suite run.
TestCaseRun
data TestCaseRun Source #
Provides the test case run.
See: newTestCaseRun
smart constructor.
TestCaseRun' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Status) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [TestCaseScenario]) (Maybe Text) |
Instances
newTestCaseRun :: TestCaseRun Source #
Create a value of TestCaseRun
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:TestCaseRun'
, testCaseRun_endTime
- Provides test case run end time.
TestCaseRun
, testCaseRun_failure
- Provides test case run failure result.
$sel:logUrl:TestCaseRun'
, testCaseRun_logUrl
- Provides test case run log URL.
$sel:startTime:TestCaseRun'
, testCaseRun_startTime
- Provides test case run start time.
TestCaseRun
, 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.
$sel:testCaseDefinitionId:TestCaseRun'
, testCaseRun_testCaseDefinitionId
- Provides the test case run definition ID.
$sel:testCaseDefinitionName:TestCaseRun'
, testCaseRun_testCaseDefinitionName
- Provides the test case run definition name.
$sel:testCaseRunId:TestCaseRun'
, testCaseRun_testCaseRunId
- Provides the test case run ID.
$sel:testScenarios:TestCaseRun'
, testCaseRun_testScenarios
- Provides the test scenarios for the test case run.
$sel:warnings:TestCaseRun'
, testCaseRun_warnings
- Provides test case run warnings.
TestCaseScenario
data TestCaseScenario Source #
Provides test case scenario.
See: newTestCaseScenario
smart constructor.
TestCaseScenario' (Maybe Text) (Maybe TestCaseScenarioStatus) (Maybe Text) (Maybe Text) (Maybe TestCaseScenarioType) |
Instances
newTestCaseScenario :: TestCaseScenario Source #
Create a value of TestCaseScenario
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failure:TestCaseScenario'
, testCaseScenario_failure
- Provides test case scenario failure result.
$sel:status:TestCaseScenario'
, 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.
$sel:systemMessage:TestCaseScenario'
, testCaseScenario_systemMessage
-
$sel:testCaseScenarioId:TestCaseScenario'
, testCaseScenario_testCaseScenarioId
- Provides test case scenario ID.
$sel:testCaseScenarioType:TestCaseScenario'
, testCaseScenario_testCaseScenarioType
- Provides test case scenario type. Type is one of the following:
- Advanced
- Basic
TestResult
data TestResult Source #
Show each group result.
See: newTestResult
smart constructor.
Instances
newTestResult :: TestResult Source #
Create a value of TestResult
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groups:TestResult'
, testResult_groups
- Show each group of test results.