Launch
This structure contains the configuration details of one Evidently launch.
Contents
- arn
-
The ARN of the launch.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/launch/[-a-zA-Z0-9._]*Required: Yes
- createdTime
-
The date and time that the launch is created.
Type: Timestamp
Required: Yes
- lastUpdatedTime
-
The date and time that the launch was most recently updated.
Type: Timestamp
Required: Yes
- name
-
The name of the launch.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
^[-a-zA-Z0-9._]*$Required: Yes
- status
-
The current state of the launch.
Type: String
Valid Values:
CREATED | UPDATING | RUNNING | COMPLETED | CANCELLEDRequired: Yes
- type
-
The type of launch.
Type: String
Valid Values:
aws.evidently.splitsRequired: Yes
- description
-
The description of the launch.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 160.
Pattern:
.*Required: No
- execution
-
A structure that contains information about the start and end times of the launch.
Type: LaunchExecution object
Required: No
- groups
-
An array of structures that define the feature variations that are being used in the launch.
Type: Array of LaunchGroup objects
Required: No
- metricMonitors
-
An array of structures that define the metrics that are being used to monitor the launch performance.
Type: Array of MetricMonitor objects
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Required: No
- project
-
The name or ARN of the project that contains the launch.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
(^[a-zA-Z0-9._-]*$)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[a-zA-Z0-9._-]*)Required: No
- randomizationSalt
-
This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and
randomizationSalt.Type: String
Length Constraints: Minimum length of 0. Maximum length of 127.
Pattern:
.*Required: No
- scheduledSplitsDefinition
-
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
Type: ScheduledSplitsLaunchDefinition object
Required: No
- statusReason
-
If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 160.
Pattern:
.*Required: No
-
The list of tag keys and values associated with this launch.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
