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.FIS.StartExperiment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts running an experiment from the specified experiment template.

Creating a Request

data StartExperiment Source #

See: newStartExperiment smart constructor.

Constructors

StartExperiment'
Fields tags :: Maybe (HashMap Text Text) The tags to apply to the experiment. clientToken :: Text Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. experimentTemplateId :: Text The ID of the experiment template.

Instances

Instances details

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

newStartExperiment Source #

Arguments

:: Text	`$sel:clientToken:StartExperiment'`
-> Text	`StartExperiment`
-> StartExperiment

Create a value of StartExperiment 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:

StartExperiment, startExperiment_tags - The tags to apply to the experiment.

$sel:clientToken:StartExperiment', startExperiment_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

StartExperiment, startExperiment_experimentTemplateId - The ID of the experiment template.

Request Lenses

startExperiment_tags :: Lens' StartExperiment (Maybe (HashMap Text Text)) Source #

The tags to apply to the experiment.

startExperiment_clientToken :: Lens' StartExperiment Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

startExperiment_experimentTemplateId :: Lens' StartExperiment Text Source #

The ID of the experiment template.

Destructuring the Response

data StartExperimentResponse Source #

See: newStartExperimentResponse smart constructor.

Constructors

StartExperimentResponse'
Fields experiment :: Maybe Experiment Information about the experiment. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartExperimentResponse Source #
Instance details Defined in Amazonka.FIS.StartExperiment Associated Types type Rep StartExperimentResponse :: Type -> Type # Methods from :: StartExperimentResponse -> Rep StartExperimentResponse x # to :: Rep StartExperimentResponse x -> StartExperimentResponse #
Read StartExperimentResponse Source #
Instance details Defined in Amazonka.FIS.StartExperiment Methods readsPrec :: Int -> ReadS StartExperimentResponse # readList :: ReadS [StartExperimentResponse] # readPrec :: ReadPrec StartExperimentResponse # readListPrec :: ReadPrec [StartExperimentResponse] #
Show StartExperimentResponse Source #
Instance details Defined in Amazonka.FIS.StartExperiment Methods showsPrec :: Int -> StartExperimentResponse -> ShowS # show :: StartExperimentResponse -> String # showList :: [StartExperimentResponse] -> ShowS #
NFData StartExperimentResponse Source #
Instance details Defined in Amazonka.FIS.StartExperiment Methods rnf :: StartExperimentResponse -> () #
Eq StartExperimentResponse Source #
Instance details Defined in Amazonka.FIS.StartExperiment Methods (==) :: StartExperimentResponse -> StartExperimentResponse -> Bool # (/=) :: StartExperimentResponse -> StartExperimentResponse -> Bool #
type Rep StartExperimentResponse Source #
Instance details Defined in Amazonka.FIS.StartExperiment type Rep StartExperimentResponse = D1 ('MetaData "StartExperimentResponse" "Amazonka.FIS.StartExperiment" "amazonka-fis-2.0-7yQxB3RmWBm2PZyqsl0n5H" 'False) (C1 ('MetaCons "StartExperimentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "experiment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Experiment)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartExperimentResponse Source #

Arguments

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

Create a value of StartExperimentResponse 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:experiment:StartExperimentResponse', startExperimentResponse_experiment - Information about the experiment.

$sel:httpStatus:StartExperimentResponse', startExperimentResponse_httpStatus - The response's http status code.

Response Lenses

startExperimentResponse_experiment :: Lens' StartExperimentResponse (Maybe Experiment) Source #

Information about the experiment.

startExperimentResponse_httpStatus :: Lens' StartExperimentResponse Int Source #

The response's http status code.