AWS::Evidently::Experiment RunningStatusObject - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Evidently::Experiment RunningStatusObject

Use this structure to start and stop the experiment.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AnalysisCompleteTime" : String,
  "DesiredState" : String,
  "Reason" : String,
  "Status" : String
}

YAML

  AnalysisCompleteTime: String
  DesiredState: String
  Reason: String
  Status: String

Properties

AnalysisCompleteTime

If you are using Amazon CloudFormation to start the experiment, use this field to specify when the experiment is to end. The format is as a UNIX timestamp. For more information about this format, see The Current Epoch Unix Timestamp.

Required: No

Type: String

Update requires: No interruption

DesiredState

If you are using Amazon CloudFormation to stop this experiment, specify either COMPLETED or CANCELLED here to indicate how to classify this experiment.

Required: No

Type: String

Pattern: ^(CANCELLED|COMPLETED)

Update requires: No interruption

Reason

If you are using Amazon CloudFormation to stop this experiment, this is an optional field that you can use to record why the experiment is being stopped or cancelled.

Required: No

Type: String

Update requires: No interruption

Status

To start the experiment now, specify START for this parameter. If this experiment is currently running and you want to stop it now, specify STOP.

Required: No

Type: String

Update requires: No interruption