amazonka-evidently-2.0: Amazon CloudWatch Evidently SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Evidently.StartExperiment

Description

Starts an existing experiment. To create an experiment, use CreateExperiment.

Synopsis

Creating a Request

data StartExperiment Source #

See: newStartExperiment smart constructor.

Constructors

StartExperiment' 

Fields

  • analysisCompleteTime :: POSIX

    The date and time to end the experiment. This must be no more than 30 days after the experiment starts.

  • experiment :: Text

    The name of the experiment to start.

  • project :: Text

    The name or ARN of the project that contains the experiment to start.

Instances

Instances details
ToJSON StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

toJSON :: StartExperiment -> Value #

toEncoding :: StartExperiment -> Encoding #

toJSONList :: [StartExperiment] -> Value #

toEncodingList :: [StartExperiment] -> Encoding #

ToHeaders StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

toHeaders :: StartExperiment -> [Header] #

ToPath StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

toPath :: StartExperiment -> ByteString #

ToQuery StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

toQuery :: StartExperiment -> QueryString #

AWSRequest StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.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.Evidently.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.Evidently.StartExperiment

Methods

readsPrec :: Int -> ReadS StartExperiment #

readList :: ReadS [StartExperiment] #

readPrec :: ReadPrec StartExperiment #

readListPrec :: ReadPrec [StartExperiment] #

Show StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

showsPrec :: Int -> StartExperiment -> ShowS #

show :: StartExperiment -> String #

showList :: [StartExperiment] -> ShowS #

NFData StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

rnf :: StartExperiment -> () #

Eq StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

(==) :: StartExperiment -> StartExperiment -> Bool #

(/=) :: StartExperiment -> StartExperiment -> Bool #

Hashable StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

hashWithSalt :: Int -> StartExperiment -> Int #

hash :: StartExperiment -> Int #

type AWSResponse StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

type AWSResponse StartExperiment = StartExperimentResponse
type Rep StartExperiment Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

type Rep StartExperiment = D1 ('MetaData "StartExperiment" "Amazonka.Evidently.StartExperiment" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "StartExperiment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "analysisCompleteTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "experiment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartExperiment Source #

Arguments

:: UTCTime

StartExperiment

-> Text

$sel:experiment: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_analysisCompleteTime - The date and time to end the experiment. This must be no more than 30 days after the experiment starts.

$sel:experiment:StartExperiment', startExperiment_experiment - The name of the experiment to start.

StartExperiment, startExperiment_project - The name or ARN of the project that contains the experiment to start.

Request Lenses

startExperiment_analysisCompleteTime :: Lens' StartExperiment UTCTime Source #

The date and time to end the experiment. This must be no more than 30 days after the experiment starts.

startExperiment_experiment :: Lens' StartExperiment Text Source #

The name of the experiment to start.

startExperiment_project :: Lens' StartExperiment Text Source #

The name or ARN of the project that contains the experiment to start.

Destructuring the Response

data StartExperimentResponse Source #

See: newStartExperimentResponse smart constructor.

Constructors

StartExperimentResponse' 

Fields

Instances

Instances details
Generic StartExperimentResponse Source # 
Instance details

Defined in Amazonka.Evidently.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.Evidently.StartExperiment

Methods

readsPrec :: Int -> ReadS StartExperimentResponse #

readList :: ReadS [StartExperimentResponse] #

readPrec :: ReadPrec StartExperimentResponse #

readListPrec :: ReadPrec [StartExperimentResponse] #

Show StartExperimentResponse Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

showsPrec :: Int -> StartExperimentResponse -> ShowS #

show :: StartExperimentResponse -> String #

showList :: [StartExperimentResponse] -> ShowS #

NFData StartExperimentResponse Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

rnf :: StartExperimentResponse -> () #

Eq StartExperimentResponse Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

Methods

(==) :: StartExperimentResponse -> StartExperimentResponse -> Bool #

(/=) :: StartExperimentResponse -> StartExperimentResponse -> Bool #

type Rep StartExperimentResponse Source # 
Instance details

Defined in Amazonka.Evidently.StartExperiment

type Rep StartExperimentResponse = D1 ('MetaData "StartExperimentResponse" "Amazonka.Evidently.StartExperiment" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "StartExperimentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "startedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: 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:

StartExperimentResponse, startExperimentResponse_startedTime - A timestamp that indicates when the experiment started.

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

Response Lenses

startExperimentResponse_startedTime :: Lens' StartExperimentResponse (Maybe UTCTime) Source #

A timestamp that indicates when the experiment started.

startExperimentResponse_httpStatus :: Lens' StartExperimentResponse Int Source #

The response's http status code.