Amazonka.Evidently.StopExperiment

Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it.

Creating a Request

data StopExperiment

See: newStopExperiment smart constructor.

Constructors

StopExperiment'

Fields

• desiredState :: Maybe ExperimentStopDesiredState

  Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

• reason :: Maybe Text

  A string that describes why you are stopping the experiment.

• experiment :: Text

  The name of the experiment to stop.

• project :: Text

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

Instances

ToJSON StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Methods

toJSON :: StopExperiment -> Value

toEncoding :: StopExperiment -> Encoding

toJSONList :: [StopExperiment] -> Value

toEncodingList :: [StopExperiment] -> Encoding

ToHeaders StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Methods

toHeaders :: StopExperiment -> [Header]

ToPath StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Methods

toPath :: StopExperiment -> ByteString

ToQuery StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Methods

toQuery :: StopExperiment -> QueryString

AWSRequest StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Associated Types

type AWSResponse StopExperiment

Methods

request :: (Service -> Service) -> StopExperiment -> Request StopExperiment

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopExperiment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopExperiment)))

Generic StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Associated Types

type Rep StopExperiment :: Type -> Type

Methods

from :: StopExperiment -> Rep StopExperiment x

to :: Rep StopExperiment x -> StopExperiment

Read StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Methods

readsPrec :: Int -> ReadS StopExperiment

readList :: ReadS [StopExperiment]

readPrec :: ReadPrec StopExperiment

readListPrec :: ReadPrec [StopExperiment]

Show StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Methods

showsPrec :: Int -> StopExperiment -> ShowS

show :: StopExperiment -> String

showList :: [StopExperiment] -> ShowS

NFData StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Methods

rnf :: StopExperiment -> ()

Eq StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Methods

(==) :: StopExperiment -> StopExperiment -> Bool

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

Hashable StopExperiment

Defined in Amazonka.Evidently.StopExperiment

Methods

hashWithSalt :: Int -> StopExperiment -> Int

hash :: StopExperiment -> Int

type AWSResponse StopExperiment

Defined in Amazonka.Evidently.StopExperiment

type AWSResponse StopExperiment = StopExperimentResponse

type Rep StopExperiment

Defined in Amazonka.Evidently.StopExperiment

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

newStopExperiment

Arguments

:: Text

$sel:experiment:StopExperiment'

-> Text

StopExperiment

-> StopExperiment

Create a value of StopExperiment 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:desiredState:StopExperiment', stopExperiment_desiredState - Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

StopExperiment, stopExperiment_reason - A string that describes why you are stopping the experiment.

$sel:experiment:StopExperiment', stopExperiment_experiment - The name of the experiment to stop.

StopExperiment, stopExperiment_project - The name or ARN of the project that contains the experiment to stop.

Request Lenses

stopExperiment_desiredState :: Lens' StopExperiment (Maybe ExperimentStopDesiredState)

Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

stopExperiment_reason :: Lens' StopExperiment (Maybe Text)

A string that describes why you are stopping the experiment.

stopExperiment_experiment :: Lens' StopExperiment Text

The name of the experiment to stop.

stopExperiment_project :: Lens' StopExperiment Text

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

Destructuring the Response

data StopExperimentResponse

See: newStopExperimentResponse smart constructor.

Constructors

StopExperimentResponse'

Fields

• endedTime :: Maybe POSIX

  The date and time that the experiment stopped.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StopExperimentResponse

Defined in Amazonka.Evidently.StopExperiment

Associated Types

type Rep StopExperimentResponse :: Type -> Type

Methods

from :: StopExperimentResponse -> Rep StopExperimentResponse x

to :: Rep StopExperimentResponse x -> StopExperimentResponse

Read StopExperimentResponse

Defined in Amazonka.Evidently.StopExperiment

Methods

readsPrec :: Int -> ReadS StopExperimentResponse

readList :: ReadS [StopExperimentResponse]

readPrec :: ReadPrec StopExperimentResponse

readListPrec :: ReadPrec [StopExperimentResponse]

Show StopExperimentResponse

Defined in Amazonka.Evidently.StopExperiment

Methods

showsPrec :: Int -> StopExperimentResponse -> ShowS

show :: StopExperimentResponse -> String

showList :: [StopExperimentResponse] -> ShowS

NFData StopExperimentResponse

Defined in Amazonka.Evidently.StopExperiment

Methods

rnf :: StopExperimentResponse -> ()

Eq StopExperimentResponse

Defined in Amazonka.Evidently.StopExperiment

Methods

(==) :: StopExperimentResponse -> StopExperimentResponse -> Bool

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

type Rep StopExperimentResponse

Defined in Amazonka.Evidently.StopExperiment

type Rep StopExperimentResponse = D1 ('MetaData "StopExperimentResponse" "Amazonka.Evidently.StopExperiment" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "StopExperimentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopExperimentResponse

Arguments

:: Int

$sel:httpStatus:StopExperimentResponse'

-> StopExperimentResponse

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

StopExperimentResponse, stopExperimentResponse_endedTime - The date and time that the experiment stopped.

$sel:httpStatus:StopExperimentResponse', stopExperimentResponse_httpStatus - The response's http status code.

Response Lenses

stopExperimentResponse_endedTime :: Lens' StopExperimentResponse (Maybe UTCTime)

The date and time that the experiment stopped.

stopExperimentResponse_httpStatus :: Lens' StopExperimentResponse Int

The response's http status code.