CloudWatchEvidently / Client / stop_experiment

stop_experiment#

CloudWatchEvidently.Client.stop_experiment(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.stop_experiment(
    desiredState='COMPLETED'|'CANCELLED',
    experiment='string',
    project='string',
    reason='string'
)
Parameters:

  • desiredState (string) – Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

  • experiment (string) –

    [REQUIRED]

    The name of the experiment to stop.

  • project (string) –

    [REQUIRED]

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

  • reason (string) – A string that describes why you are stopping the experiment.

Return type:

dict

Returns:

Response Syntax

{
    'endedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • endedTime (datetime) –

      The date and time that the experiment stopped.

Exceptions