Amazonka.Evidently.StartExperiment

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

Creating a Request

data StartExperiment

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

ToJSON StartExperiment

Defined in Amazonka.Evidently.StartExperiment

Methods

toJSON :: StartExperiment -> Value

toEncoding :: StartExperiment -> Encoding

toJSONList :: [StartExperiment] -> Value

toEncodingList :: [StartExperiment] -> Encoding

ToHeaders StartExperiment

Defined in Amazonka.Evidently.StartExperiment

Methods

toHeaders :: StartExperiment -> [Header]

ToPath StartExperiment

Defined in Amazonka.Evidently.StartExperiment

Methods

toPath :: StartExperiment -> ByteString

ToQuery StartExperiment

Defined in Amazonka.Evidently.StartExperiment

Methods

toQuery :: StartExperiment -> QueryString

AWSRequest StartExperiment

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

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

Defined in Amazonka.Evidently.StartExperiment

Methods

readsPrec :: Int -> ReadS StartExperiment

readList :: ReadS [StartExperiment]

readPrec :: ReadPrec StartExperiment

readListPrec :: ReadPrec [StartExperiment]

Show StartExperiment

Defined in Amazonka.Evidently.StartExperiment

Methods

showsPrec :: Int -> StartExperiment -> ShowS

show :: StartExperiment -> String

showList :: [StartExperiment] -> ShowS

NFData StartExperiment

Defined in Amazonka.Evidently.StartExperiment

Methods

rnf :: StartExperiment -> ()

Eq StartExperiment

Defined in Amazonka.Evidently.StartExperiment

Methods

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

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

Hashable StartExperiment

Defined in Amazonka.Evidently.StartExperiment

Methods

hashWithSalt :: Int -> StartExperiment -> Int

hash :: StartExperiment -> Int

type AWSResponse StartExperiment

Defined in Amazonka.Evidently.StartExperiment

type AWSResponse StartExperiment = StartExperimentResponse

type Rep StartExperiment

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

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

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

The name of the experiment to start.

startExperiment_project :: Lens' StartExperiment Text

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

Destructuring the Response

data StartExperimentResponse

See: newStartExperimentResponse smart constructor.

Constructors

StartExperimentResponse'

Fields

• startedTime :: Maybe POSIX

  A timestamp that indicates when the experiment started.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartExperimentResponse

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

Defined in Amazonka.Evidently.StartExperiment

Methods

readsPrec :: Int -> ReadS StartExperimentResponse

readList :: ReadS [StartExperimentResponse]

readPrec :: ReadPrec StartExperimentResponse

readListPrec :: ReadPrec [StartExperimentResponse]

Show StartExperimentResponse

Defined in Amazonka.Evidently.StartExperiment

Methods

showsPrec :: Int -> StartExperimentResponse -> ShowS

show :: StartExperimentResponse -> String

showList :: [StartExperimentResponse] -> ShowS

NFData StartExperimentResponse

Defined in Amazonka.Evidently.StartExperiment

Methods

rnf :: StartExperimentResponse -> ()

Eq StartExperimentResponse

Defined in Amazonka.Evidently.StartExperiment

Methods

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

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

type Rep StartExperimentResponse

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

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)

A timestamp that indicates when the experiment started.

startExperimentResponse_httpStatus :: Lens' StartExperimentResponse Int

The response's http status code.