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.GetSuiteRun

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about a Device Advisor test suite run.

Requires permission to access the GetSuiteRun action.

Synopsis

data GetSuiteRun = GetSuiteRun' {
- suiteDefinitionId :: Text
- suiteRunId :: Text
}
newGetSuiteRun :: Text -> Text -> GetSuiteRun
getSuiteRun_suiteDefinitionId :: Lens' GetSuiteRun Text
getSuiteRun_suiteRunId :: Lens' GetSuiteRun Text
data GetSuiteRunResponse = GetSuiteRunResponse' {
- endTime :: Maybe POSIX
- errorReason :: Maybe Text
- startTime :: Maybe POSIX
- status :: Maybe SuiteRunStatus
- suiteDefinitionId :: Maybe Text
- suiteDefinitionVersion :: Maybe Text
- suiteRunArn :: Maybe Text
- suiteRunConfiguration :: Maybe SuiteRunConfiguration
- suiteRunId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- testResult :: Maybe TestResult
- httpStatus :: Int
}
newGetSuiteRunResponse :: Int -> GetSuiteRunResponse
getSuiteRunResponse_endTime :: Lens' GetSuiteRunResponse (Maybe UTCTime)
getSuiteRunResponse_errorReason :: Lens' GetSuiteRunResponse (Maybe Text)
getSuiteRunResponse_startTime :: Lens' GetSuiteRunResponse (Maybe UTCTime)
getSuiteRunResponse_status :: Lens' GetSuiteRunResponse (Maybe SuiteRunStatus)
getSuiteRunResponse_suiteDefinitionId :: Lens' GetSuiteRunResponse (Maybe Text)
getSuiteRunResponse_suiteDefinitionVersion :: Lens' GetSuiteRunResponse (Maybe Text)
getSuiteRunResponse_suiteRunArn :: Lens' GetSuiteRunResponse (Maybe Text)
getSuiteRunResponse_suiteRunConfiguration :: Lens' GetSuiteRunResponse (Maybe SuiteRunConfiguration)
getSuiteRunResponse_suiteRunId :: Lens' GetSuiteRunResponse (Maybe Text)
getSuiteRunResponse_tags :: Lens' GetSuiteRunResponse (Maybe (HashMap Text Text))
getSuiteRunResponse_testResult :: Lens' GetSuiteRunResponse (Maybe TestResult)
getSuiteRunResponse_httpStatus :: Lens' GetSuiteRunResponse Int

Creating a Request

data GetSuiteRun Source #

See: newGetSuiteRun smart constructor.

Constructors

GetSuiteRun'
Fields suiteDefinitionId :: Text Suite definition ID for the test suite run. suiteRunId :: Text Suite run ID for the test suite run.

Instances

Instances details

ToHeaders GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods toHeaders :: GetSuiteRun -> [Header] #
ToPath GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods toPath :: GetSuiteRun -> ByteString #
ToQuery GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods toQuery :: GetSuiteRun -> QueryString #
AWSRequest GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Associated Types type AWSResponse GetSuiteRun # Methods request :: (Service -> Service) -> GetSuiteRun -> Request GetSuiteRun # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSuiteRun -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSuiteRun))) #
Generic GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Associated Types type Rep GetSuiteRun :: Type -> Type # Methods from :: GetSuiteRun -> Rep GetSuiteRun x # to :: Rep GetSuiteRun x -> GetSuiteRun #
Read GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods readsPrec :: Int -> ReadS GetSuiteRun # readList :: ReadS [GetSuiteRun] # readPrec :: ReadPrec GetSuiteRun # readListPrec :: ReadPrec [GetSuiteRun] #
Show GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods showsPrec :: Int -> GetSuiteRun -> ShowS # show :: GetSuiteRun -> String # showList :: [GetSuiteRun] -> ShowS #
NFData GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods rnf :: GetSuiteRun -> () #
Eq GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods (==) :: GetSuiteRun -> GetSuiteRun -> Bool # (/=) :: GetSuiteRun -> GetSuiteRun -> Bool #
Hashable GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods hashWithSalt :: Int -> GetSuiteRun -> Int # hash :: GetSuiteRun -> Int #
type AWSResponse GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun type AWSResponse GetSuiteRun = GetSuiteRunResponse
type Rep GetSuiteRun Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun type Rep GetSuiteRun = D1 ('MetaData "GetSuiteRun" "Amazonka.IoTDeviceAdvisor.GetSuiteRun" "amazonka-iotdeviceadvisor-2.0-DMTYim03jFoq2XrPgpZdL" 'False) (C1 ('MetaCons "GetSuiteRun'" 'PrefixI 'True) (S1 ('MetaSel ('Just "suiteDefinitionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "suiteRunId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetSuiteRun Source #

Arguments

:: Text	`GetSuiteRun`
-> Text	`GetSuiteRun`
-> GetSuiteRun

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.

Request Lenses

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.

Destructuring the Response

data GetSuiteRunResponse Source #

See: newGetSuiteRunResponse smart constructor.

Constructors

GetSuiteRunResponse'

Fields

endTime :: Maybe POSIX
Date (in Unix epoch time) when the test suite run ended.
errorReason :: Maybe Text
Error reason for any test suite run failure.
startTime :: Maybe POSIX
Date (in Unix epoch time) when the test suite run started.
status :: Maybe SuiteRunStatus
Status for the test suite run.
suiteDefinitionId :: Maybe Text
Suite definition ID for the test suite run.
suiteDefinitionVersion :: Maybe Text
Suite definition version for the test suite run.
suiteRunArn :: Maybe Text
The ARN of the suite run.
suiteRunConfiguration :: Maybe SuiteRunConfiguration
Suite run configuration for the test suite run.
suiteRunId :: Maybe Text
Suite run ID for the test suite run.
tags :: Maybe (HashMap Text Text)
The tags attached to the suite run.
testResult :: Maybe TestResult
Test results for the test suite run.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Associated Types type Rep GetSuiteRunResponse :: Type -> Type # Methods from :: GetSuiteRunResponse -> Rep GetSuiteRunResponse x # to :: Rep GetSuiteRunResponse x -> GetSuiteRunResponse #
Read GetSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods readsPrec :: Int -> ReadS GetSuiteRunResponse # readList :: ReadS [GetSuiteRunResponse] # readPrec :: ReadPrec GetSuiteRunResponse # readListPrec :: ReadPrec [GetSuiteRunResponse] #
Show GetSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods showsPrec :: Int -> GetSuiteRunResponse -> ShowS # show :: GetSuiteRunResponse -> String # showList :: [GetSuiteRunResponse] -> ShowS #
NFData GetSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods rnf :: GetSuiteRunResponse -> () #
Eq GetSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun Methods (==) :: GetSuiteRunResponse -> GetSuiteRunResponse -> Bool # (/=) :: GetSuiteRunResponse -> GetSuiteRunResponse -> Bool #
type Rep GetSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.GetSuiteRun type Rep GetSuiteRunResponse = D1 ('MetaData "GetSuiteRunResponse" "Amazonka.IoTDeviceAdvisor.GetSuiteRun" "amazonka-iotdeviceadvisor-2.0-DMTYim03jFoq2XrPgpZdL" 'False) (C1 ('MetaCons "GetSuiteRunResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "errorReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuiteRunStatus)) :: (S1 ('MetaSel ('Just "suiteDefinitionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "suiteDefinitionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "suiteRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "suiteRunConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuiteRunConfiguration)) :: S1 ('MetaSel ('Just "suiteRunId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "testResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TestResult)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetSuiteRunResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSuiteRunResponse'`
-> GetSuiteRunResponse

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.

Response Lenses

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.