CloudWatchEvidently / Client / start_experiment

start_experiment#

CloudWatchEvidently.Client.start_experiment(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.start_experiment(
    analysisCompleteTime=datetime(2015, 1, 1),
    experiment='string',
    project='string'
)
Parameters:

  • analysisCompleteTime (datetime) –

    [REQUIRED]

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

  • experiment (string) –

    [REQUIRED]

    The name of the experiment to start.

  • project (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • startedTime (datetime) –

      A timestamp that indicates when the experiment started.

Exceptions

  • CloudWatchEvidently.Client.exceptions.ThrottlingException

  • CloudWatchEvidently.Client.exceptions.ValidationException

  • CloudWatchEvidently.Client.exceptions.ConflictException

  • CloudWatchEvidently.Client.exceptions.ServiceQuotaExceededException

  • CloudWatchEvidently.Client.exceptions.ResourceNotFoundException

  • CloudWatchEvidently.Client.exceptions.AccessDeniedException