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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

Synopsis

data StartSuiteRun = StartSuiteRun' {
- suiteDefinitionVersion :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- suiteDefinitionId :: Text
- suiteRunConfiguration :: SuiteRunConfiguration
}
newStartSuiteRun :: Text -> SuiteRunConfiguration -> StartSuiteRun
startSuiteRun_suiteDefinitionVersion :: Lens' StartSuiteRun (Maybe Text)
startSuiteRun_tags :: Lens' StartSuiteRun (Maybe (HashMap Text Text))
startSuiteRun_suiteDefinitionId :: Lens' StartSuiteRun Text
startSuiteRun_suiteRunConfiguration :: Lens' StartSuiteRun SuiteRunConfiguration
data StartSuiteRunResponse = StartSuiteRunResponse' {
- createdAt :: Maybe POSIX
- endpoint :: Maybe Text
- suiteRunArn :: Maybe Text
- suiteRunId :: Maybe Text
- httpStatus :: Int
}
newStartSuiteRunResponse :: Int -> StartSuiteRunResponse
startSuiteRunResponse_createdAt :: Lens' StartSuiteRunResponse (Maybe UTCTime)
startSuiteRunResponse_endpoint :: Lens' StartSuiteRunResponse (Maybe Text)
startSuiteRunResponse_suiteRunArn :: Lens' StartSuiteRunResponse (Maybe Text)
startSuiteRunResponse_suiteRunId :: Lens' StartSuiteRunResponse (Maybe Text)
startSuiteRunResponse_httpStatus :: Lens' StartSuiteRunResponse Int

Creating a Request

data StartSuiteRun Source #

See: newStartSuiteRun smart constructor.

Constructors

StartSuiteRun'
Fields suiteDefinitionVersion :: Maybe Text Suite definition version of the test suite. tags :: Maybe (HashMap Text Text) The tags to be attached to the suite run. suiteDefinitionId :: Text Suite definition ID of the test suite. suiteRunConfiguration :: SuiteRunConfiguration Suite run configuration.

Instances

Instances details

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

newStartSuiteRun Source #

Arguments

:: Text	`StartSuiteRun`
-> SuiteRunConfiguration	`$sel:suiteRunConfiguration:StartSuiteRun'`
-> StartSuiteRun

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.

Request Lenses

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.

Destructuring the Response

data StartSuiteRunResponse Source #

See: newStartSuiteRunResponse smart constructor.

Constructors

StartSuiteRunResponse'
Fields createdAt :: Maybe POSIX Starts a Device Advisor test suite run based on suite create time. endpoint :: Maybe Text The response of an Device Advisor test endpoint. suiteRunArn :: Maybe Text Amazon Resource Name (ARN) of the started suite run. suiteRunId :: Maybe Text Suite Run ID of the started suite run. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.StartSuiteRun Associated Types type Rep StartSuiteRunResponse :: Type -> Type # Methods from :: StartSuiteRunResponse -> Rep StartSuiteRunResponse x # to :: Rep StartSuiteRunResponse x -> StartSuiteRunResponse #
Read StartSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.StartSuiteRun Methods readsPrec :: Int -> ReadS StartSuiteRunResponse # readList :: ReadS [StartSuiteRunResponse] # readPrec :: ReadPrec StartSuiteRunResponse # readListPrec :: ReadPrec [StartSuiteRunResponse] #
Show StartSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.StartSuiteRun Methods showsPrec :: Int -> StartSuiteRunResponse -> ShowS # show :: StartSuiteRunResponse -> String # showList :: [StartSuiteRunResponse] -> ShowS #
NFData StartSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.StartSuiteRun Methods rnf :: StartSuiteRunResponse -> () #
Eq StartSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.StartSuiteRun Methods (==) :: StartSuiteRunResponse -> StartSuiteRunResponse -> Bool # (/=) :: StartSuiteRunResponse -> StartSuiteRunResponse -> Bool #
type Rep StartSuiteRunResponse Source #
Instance details Defined in Amazonka.IoTDeviceAdvisor.StartSuiteRun type Rep StartSuiteRunResponse = D1 ('MetaData "StartSuiteRunResponse" "Amazonka.IoTDeviceAdvisor.StartSuiteRun" "amazonka-iotdeviceadvisor-2.0-DMTYim03jFoq2XrPgpZdL" 'False) (C1 ('MetaCons "StartSuiteRunResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "suiteRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "suiteRunId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newStartSuiteRunResponse Source #

Arguments

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

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.

Response Lenses

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.