CloudWatchEvidently / Client / stop_launch

stop_launch#

CloudWatchEvidently.Client.stop_launch(**kwargs)#

Stops a launch that is currently running. After you stop a launch, you will not be able to resume it or restart it. Also, it will not be evaluated as a rule for traffic allocation, and the traffic that was allocated to the launch will instead be available to the feature’s experiment, if there is one. Otherwise, all traffic will be served the default variation after the launch is stopped.

See also: AWS API Documentation

Request Syntax

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

  • desiredState (string) – Specify whether to consider the launch as COMPLETED or CANCELLED after it stops.

  • launch (string) –

    [REQUIRED]

    The name of the launch to stop.

  • project (string) –

    [REQUIRED]

    The name or ARN of the project that contains the launch that you want to stop.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • endedTime (datetime) –

      The date and time that the launch stopped.

Exceptions

  • CloudWatchEvidently.Client.exceptions.ThrottlingException

  • CloudWatchEvidently.Client.exceptions.ValidationException

  • CloudWatchEvidently.Client.exceptions.ResourceNotFoundException

  • CloudWatchEvidently.Client.exceptions.AccessDeniedException