interface RunningStatusObjectProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Evidently.Mixins.CfnExperimentPropsMixin.RunningStatusObjectProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsevidently/mixins#CfnExperimentPropsMixin_RunningStatusObjectProperty
Java	software.amazon.awscdk.mixins.preview.services.evidently.mixins.CfnExperimentPropsMixin.RunningStatusObjectProperty
Python	aws_cdk.mixins_preview.aws_evidently.mixins.CfnExperimentPropsMixin.RunningStatusObjectProperty
TypeScript	@aws-cdk/mixins-preview » aws_evidently » mixins » CfnExperimentPropsMixin » RunningStatusObjectProperty

Use this structure to start and stop the experiment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as evidently_mixins } from '@aws-cdk/mixins-preview/aws-evidently';
const runningStatusObjectProperty: evidently_mixins.CfnExperimentPropsMixin.RunningStatusObjectProperty = {
  analysisCompleteTime: 'analysisCompleteTime',
  desiredState: 'desiredState',
  reason: 'reason',
  status: 'status',
};

Properties

Name	Type	Description
analysisCompleteTime?	string	If you are using CloudFormation to start the experiment, use this field to specify when the experiment is to end.
desiredState?	string	If you are using CloudFormation to stop this experiment, specify either COMPLETED or CANCELLED here to indicate how to classify this experiment.
reason?	string	If you are using CloudFormation to stop this experiment, this is an optional field that you can use to record why the experiment is being stopped or cancelled.
status?	string	To start the experiment now, specify START for this parameter.

---

analysisCompleteTime?

Type: string (optional)

If you are using 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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-analysiscompletetime

---

desiredState?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-desiredstate

---

reason?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-reason

---

status?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-status