AWS SDK for PHP 3.x

Client: Aws\CloudWatchEvidently\CloudWatchEvidentlyClient

Service ID: evidently

Version: 2021-02-01

This page describes the parameters and results for the operations of the Amazon CloudWatch Evidently (2021-02-01), and shows how to use the Aws\CloudWatchEvidently\CloudWatchEvidentlyClient object to call the described operations. This documentation is specific to the 2021-02-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

BatchEvaluateFeature ( array $params = [] )
This operation assigns feature variation to user sessions.
CreateExperiment ( array $params = [] )
Creates an Evidently experiment.
CreateFeature ( array $params = [] )
Creates an Evidently feature that you want to launch or test.
CreateLaunch ( array $params = [] )
Creates a launch of a given feature.
CreateProject ( array $params = [] )
Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments.
CreateSegment ( array $params = [] )
Use this operation to define a segment of your audience.
DeleteExperiment ( array $params = [] )
Deletes an Evidently experiment.
DeleteFeature ( array $params = [] )
Deletes an Evidently feature.
DeleteLaunch ( array $params = [] )
Deletes an Evidently launch.
DeleteProject ( array $params = [] )
Deletes an Evidently project.
DeleteSegment ( array $params = [] )
Deletes a segment.
EvaluateFeature ( array $params = [] )
This operation assigns a feature variation to one given user session.
GetExperiment ( array $params = [] )
Returns the details about one experiment.
GetExperimentResults ( array $params = [] )
Retrieves the results of a running or completed experiment.
GetFeature ( array $params = [] )
Returns the details about one feature.
GetLaunch ( array $params = [] )
Returns the details about one launch.
GetProject ( array $params = [] )
Returns the details about one launch.
GetSegment ( array $params = [] )
Returns information about the specified segment.
ListExperiments ( array $params = [] )
Returns configuration details about all the experiments in the specified project.
ListFeatures ( array $params = [] )
Returns configuration details about all the features in the specified project.
ListLaunches ( array $params = [] )
Returns configuration details about all the launches in the specified project.
ListProjects ( array $params = [] )
Returns configuration details about all the projects in the current Region in your account.
ListSegmentReferences ( array $params = [] )
Use this operation to find which experiments or launches are using a specified segment.
ListSegments ( array $params = [] )
Returns a list of audience segments that you have created in your account in this Region.
ListTagsForResource ( array $params = [] )
Displays the tags associated with an Evidently resource.
PutProjectEvents ( array $params = [] )
Sends performance events to Evidently.
StartExperiment ( array $params = [] )
Starts an existing experiment.
StartLaunch ( array $params = [] )
Starts an existing launch.
StopExperiment ( array $params = [] )
Stops an experiment that is currently running.
StopLaunch ( array $params = [] )
Stops a launch that is currently running.
TagResource ( array $params = [] )
Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource.
TestSegmentPattern ( array $params = [] )
Use this operation to test a rules pattern that you plan to use to create an audience segment.
UntagResource ( array $params = [] )
Removes one or more tags from the specified resource.
UpdateExperiment ( array $params = [] )
Updates an Evidently experiment.
UpdateFeature ( array $params = [] )
Updates an existing feature.
UpdateLaunch ( array $params = [] )
Updates a launch of a given feature.
UpdateProject ( array $params = [] )
Updates the description of an existing project.
UpdateProjectDataDelivery ( array $params = [] )
Updates the data storage options for this project.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListExperiments
ListFeatures
ListLaunches
ListProjects
ListSegmentReferences
ListSegments

Operations

BatchEvaluateFeature

$result = $client->batchEvaluateFeature([/* ... */]);
$promise = $client->batchEvaluateFeatureAsync([/* ... */]);

This operation assigns feature variation to user sessions. For each user session, you pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation.

The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule.

Next, if there is a launch of the feature, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch.

If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment.

If the user is not assigned to a launch or experiment, they are served the default variation.

Parameter Syntax

$result = $client->batchEvaluateFeature([
    'project' => '<string>', // REQUIRED
    'requests' => [ // REQUIRED
        [
            'entityId' => '<string>', // REQUIRED
            'evaluationContext' => '<string>',
            'feature' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

project

Required: Yes
Type: string

The name or ARN of the project that contains the feature being evaluated.

requests

Required: Yes
Type: Array of EvaluationRequest structures

An array of structures, where each structure assigns a feature variation to one user session.

Result Syntax

[
    'results' => [
        [
            'details' => '<string>',
            'entityId' => '<string>',
            'feature' => '<string>',
            'project' => '<string>',
            'reason' => '<string>',
            'value' => [
                'boolValue' => true || false,
                'doubleValue' => <float>,
                'longValue' => <integer>,
                'stringValue' => '<string>',
            ],
            'variation' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

results

Type: Array of EvaluationResult structures

An array of structures, where each structure displays the results of one feature evaluation assignment to one user session.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

CreateExperiment

$result = $client->createExperiment([/* ... */]);
$promise = $client->createExperimentAsync([/* ... */]);

Creates an Evidently experiment. Before you create an experiment, you must create the feature to use for the experiment.

An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better.

You can optionally specify a segment to have the experiment consider only certain audience types in the experiment, such as using only user sessions from a certain location or who use a certain internet browser.

Don't use this operation to update an existing experiment. Instead, use UpdateExperiment.

Parameter Syntax

$result = $client->createExperiment([
    'description' => '<string>',
    'metricGoals' => [ // REQUIRED
        [
            'desiredChange' => 'INCREASE|DECREASE',
            'metricDefinition' => [ // REQUIRED
                'entityIdKey' => '<string>', // REQUIRED
                'eventPattern' => '<string>',
                'name' => '<string>', // REQUIRED
                'unitLabel' => '<string>',
                'valueKey' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'onlineAbConfig' => [
        'controlTreatmentName' => '<string>',
        'treatmentWeights' => [<integer>, ...],
    ],
    'project' => '<string>', // REQUIRED
    'randomizationSalt' => '<string>',
    'samplingRate' => <integer>,
    'segment' => '<string>',
    'tags' => ['<string>', ...],
    'treatments' => [ // REQUIRED
        [
            'description' => '<string>',
            'feature' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'variation' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

description

Type: string

An optional description of the experiment.

metricGoals

Required: Yes
Type: Array of MetricGoalConfig structures

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

name

Required: Yes
Type: string

A name for the new experiment.

onlineAbConfig

Type: OnlineAbConfig structure

A structure that contains the configuration of which variation to use as the "control" version. tThe "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

project

Required: Yes
Type: string

The name or ARN of the project that you want to create the new experiment in.

randomizationSalt

Type: string

When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.

samplingRate

Type: long (int|float)

The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

segment

Type: string

Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Assigns one or more tags (key-value pairs) to the experiment.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with an experiment.

For more information, see Tagging Amazon Web Services resources.

treatments

Required: Yes
Type: Array of TreatmentConfig structures

An array of structures that describe the configuration of each feature variation used in the experiment.

Result Syntax

[
    'experiment' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'execution' => [
            'endedTime' => <DateTime>,
            'startedTime' => <DateTime>,
        ],
        'lastUpdatedTime' => <DateTime>,
        'metricGoals' => [
            [
                'desiredChange' => 'INCREASE|DECREASE',
                'metricDefinition' => [
                    'entityIdKey' => '<string>',
                    'eventPattern' => '<string>',
                    'name' => '<string>',
                    'unitLabel' => '<string>',
                    'valueKey' => '<string>',
                ],
            ],
            // ...
        ],
        'name' => '<string>',
        'onlineAbDefinition' => [
            'controlTreatmentName' => '<string>',
            'treatmentWeights' => [<integer>, ...],
        ],
        'project' => '<string>',
        'randomizationSalt' => '<string>',
        'samplingRate' => <integer>,
        'schedule' => [
            'analysisCompleteTime' => <DateTime>,
        ],
        'segment' => '<string>',
        'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
        'statusReason' => '<string>',
        'tags' => ['<string>', ...],
        'treatments' => [
            [
                'description' => '<string>',
                'featureVariations' => ['<string>', ...],
                'name' => '<string>',
            ],
            // ...
        ],
        'type' => 'aws.evidently.onlineab',
    ],
]

Result Details

Members

experiment

Required: Yes
Type: Experiment structure

A structure containing the configuration details of the experiment that you created.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

CreateFeature

$result = $client->createFeature([/* ... */]);
$promise = $client->createFeatureAsync([/* ... */]);

Creates an Evidently feature that you want to launch or test. You can define up to five variations of a feature, and use these variations in your launches and experiments. A feature must be created in a project. For information about creating a project, see CreateProject.

Don't use this operation to update an existing feature. Instead, use UpdateFeature.

Parameter Syntax

$result = $client->createFeature([
    'defaultVariation' => '<string>',
    'description' => '<string>',
    'entityOverrides' => ['<string>', ...],
    'evaluationStrategy' => 'ALL_RULES|DEFAULT_VARIATION',
    'name' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'variations' => [ // REQUIRED
        [
            'name' => '<string>', // REQUIRED
            'value' => [ // REQUIRED
                'boolValue' => true || false,
                'doubleValue' => <float>,
                'longValue' => <integer>,
                'stringValue' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

defaultVariation

Type: string

The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

This variation must also be listed in the variations structure.

If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

description

Type: string

An optional description of the feature.

entityOverrides

Type: Associative array of custom strings keys (EntityId) to strings

Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.

evaluationStrategy

Type: string

Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.

name

Required: Yes
Type: string

The name for the new feature.

project

Required: Yes
Type: string

The name or ARN of the project that is to contain the new feature.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Assigns one or more tags (key-value pairs) to the feature.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with a feature.

For more information, see Tagging Amazon Web Services resources.

variations

Required: Yes
Type: Array of VariationConfig structures

An array of structures that contain the configuration of the feature's different variations.

Result Syntax

[
    'feature' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'defaultVariation' => '<string>',
        'description' => '<string>',
        'entityOverrides' => ['<string>', ...],
        'evaluationRules' => [
            [
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'evaluationStrategy' => 'ALL_RULES|DEFAULT_VARIATION',
        'lastUpdatedTime' => <DateTime>,
        'name' => '<string>',
        'project' => '<string>',
        'status' => 'AVAILABLE|UPDATING',
        'tags' => ['<string>', ...],
        'valueType' => 'STRING|LONG|DOUBLE|BOOLEAN',
        'variations' => [
            [
                'name' => '<string>',
                'value' => [
                    'boolValue' => true || false,
                    'doubleValue' => <float>,
                    'longValue' => <integer>,
                    'stringValue' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

feature

Type: Feature structure

A structure that contains information about the new feature.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

CreateLaunch

$result = $client->createLaunch([/* ... */]);
$promise = $client->createLaunchAsync([/* ... */]);

Creates a launch of a given feature. Before you create a launch, you must create the feature to use for the launch.

You can use a launch to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to more users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.

Don't use this operation to update an existing launch. Instead, use UpdateLaunch.

Parameter Syntax

$result = $client->createLaunch([
    'description' => '<string>',
    'groups' => [ // REQUIRED
        [
            'description' => '<string>',
            'feature' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'variation' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'metricMonitors' => [
        [
            'metricDefinition' => [ // REQUIRED
                'entityIdKey' => '<string>', // REQUIRED
                'eventPattern' => '<string>',
                'name' => '<string>', // REQUIRED
                'unitLabel' => '<string>',
                'valueKey' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
    'randomizationSalt' => '<string>',
    'scheduledSplitsConfig' => [
        'steps' => [ // REQUIRED
            [
                'groupWeights' => [<integer>, ...], // REQUIRED
                'segmentOverrides' => [
                    [
                        'evaluationOrder' => <integer>, // REQUIRED
                        'segment' => '<string>', // REQUIRED
                        'weights' => [<integer>, ...], // REQUIRED
                    ],
                    // ...
                ],
                'startTime' => <integer || string || DateTime>, // REQUIRED
            ],
            // ...
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

description

Type: string

An optional description for the launch.

groups

Required: Yes
Type: Array of LaunchGroupConfig structures

An array of structures that contains the feature and variations that are to be used for the launch.

metricMonitors

Type: Array of MetricMonitorConfig structures

An array of structures that define the metrics that will be used to monitor the launch performance.

name

Required: Yes
Type: string

The name for the new launch.

project

Required: Yes
Type: string

The name or ARN of the project that you want to create the launch in.

randomizationSalt

Type: string

When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.

scheduledSplitsConfig

Type: ScheduledSplitsLaunchConfig structure

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Assigns one or more tags (key-value pairs) to the launch.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with a launch.

For more information, see Tagging Amazon Web Services resources.

Result Syntax

[
    'launch' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'execution' => [
            'endedTime' => <DateTime>,
            'startedTime' => <DateTime>,
        ],
        'groups' => [
            [
                'description' => '<string>',
                'featureVariations' => ['<string>', ...],
                'name' => '<string>',
            ],
            // ...
        ],
        'lastUpdatedTime' => <DateTime>,
        'metricMonitors' => [
            [
                'metricDefinition' => [
                    'entityIdKey' => '<string>',
                    'eventPattern' => '<string>',
                    'name' => '<string>',
                    'unitLabel' => '<string>',
                    'valueKey' => '<string>',
                ],
            ],
            // ...
        ],
        'name' => '<string>',
        'project' => '<string>',
        'randomizationSalt' => '<string>',
        'scheduledSplitsDefinition' => [
            'steps' => [
                [
                    'groupWeights' => [<integer>, ...],
                    'segmentOverrides' => [
                        [
                            'evaluationOrder' => <integer>,
                            'segment' => '<string>',
                            'weights' => [<integer>, ...],
                        ],
                        // ...
                    ],
                    'startTime' => <DateTime>,
                ],
                // ...
            ],
        ],
        'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
        'statusReason' => '<string>',
        'tags' => ['<string>', ...],
        'type' => 'aws.evidently.splits',
    ],
]

Result Details

Members

launch

Required: Yes
Type: Launch structure

A structure that contains the configuration of the launch that was created.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

CreateProject

$result = $client->createProject([/* ... */]);
$promise = $client->createProjectAsync([/* ... */]);

Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.

To update an existing project, use UpdateProject.

Parameter Syntax

$result = $client->createProject([
    'appConfigResource' => [
        'applicationId' => '<string>',
        'environmentId' => '<string>',
    ],
    'dataDelivery' => [
        'cloudWatchLogs' => [
            'logGroup' => '<string>',
        ],
        's3Destination' => [
            'bucket' => '<string>',
            'prefix' => '<string>',
        ],
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

appConfigResource

Type: ProjectAppConfigResourceConfig structure

Use this parameter if the project will use client-side evaluation powered by AppConfig. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. For more information, see Client-side evaluation - powered by AppConfig.

This parameter is a structure that contains information about the AppConfig application and environment that will be used as for client-side evaluation.

To create a project that uses client-side evaluation, you must have the evidently:ExportProjectAsConfiguration permission.

dataDelivery

Type: ProjectDataDeliveryConfig structure

A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.

description

Type: string

An optional description of the project.

name

Required: Yes
Type: string

The name for the project.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Assigns one or more tags (key-value pairs) to the project.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with a project.

For more information, see Tagging Amazon Web Services resources.

Result Syntax

[
    'project' => [
        'activeExperimentCount' => <integer>,
        'activeLaunchCount' => <integer>,
        'appConfigResource' => [
            'applicationId' => '<string>',
            'configurationProfileId' => '<string>',
            'environmentId' => '<string>',
        ],
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'dataDelivery' => [
            'cloudWatchLogs' => [
                'logGroup' => '<string>',
            ],
            's3Destination' => [
                'bucket' => '<string>',
                'prefix' => '<string>',
            ],
        ],
        'description' => '<string>',
        'experimentCount' => <integer>,
        'featureCount' => <integer>,
        'lastUpdatedTime' => <DateTime>,
        'launchCount' => <integer>,
        'name' => '<string>',
        'status' => 'AVAILABLE|UPDATING',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

project

Required: Yes
Type: Project structure

A structure that contains information about the created project.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

CreateSegment

$result = $client->createSegment([/* ... */]);
$promise = $client->createSegmentAsync([/* ... */]);

Use this operation to define a segment of your audience. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

Using a segment in an experiment limits that experiment to evaluate only the users who match the segment criteria. Using one or more segments in a launch allows you to define different traffic splits for the different audience segments.

For more information about segment pattern syntax, see Segment rule pattern syntax.

The pattern that you define for a segment is matched against the value of evaluationContext, which is passed into Evidently in the EvaluateFeature operation, when Evidently assigns a feature variation to a user.

Parameter Syntax

$result = $client->createSegment([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'pattern' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

description

Type: string

An optional description for this segment.

name

Required: Yes
Type: string

A name for the segment.

pattern

Required: Yes
Type: string (string|number|array|map or anything parsable by json_encode)

The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Assigns one or more tags (key-value pairs) to the segment.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with a segment.

For more information, see Tagging Amazon Web Services resources.

Result Syntax

[
    'segment' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'experimentCount' => <integer>,
        'lastUpdatedTime' => <DateTime>,
        'launchCount' => <integer>,
        'name' => '<string>',
        'pattern' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

segment

Required: Yes
Type: Segment structure

A structure that contains the complete information about the segment that was just created.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

DeleteExperiment

$result = $client->deleteExperiment([/* ... */]);
$promise = $client->deleteExperimentAsync([/* ... */]);

Deletes an Evidently experiment. The feature used for the experiment is not deleted.

To stop an experiment without deleting it, use StopExperiment.

Parameter Syntax

$result = $client->deleteExperiment([
    'experiment' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

experiment

Required: Yes
Type: string

The name of the experiment to delete.

project

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The value of a parameter in the request caused an error.
InternalServerException:
Unexpected error while processing the request. Retry the request.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceUnavailableException:
The service was unavailable. Retry the request.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

DeleteFeature

$result = $client->deleteFeature([/* ... */]);
$promise = $client->deleteFeatureAsync([/* ... */]);

Deletes an Evidently feature.

Parameter Syntax

$result = $client->deleteFeature([
    'feature' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

feature

Required: Yes
Type: string

The name of the feature to delete.

project

Required: Yes
Type: string

The name or ARN of the project that contains the feature to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

DeleteLaunch

$result = $client->deleteLaunch([/* ... */]);
$promise = $client->deleteLaunchAsync([/* ... */]);

Deletes an Evidently launch. The feature used for the launch is not deleted.

To stop a launch without deleting it, use StopLaunch.

Parameter Syntax

$result = $client->deleteLaunch([
    'launch' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

launch

Required: Yes
Type: string

The name of the launch to delete.

project

Required: Yes
Type: string

The name or ARN of the project that contains the launch to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

DeleteProject

$result = $client->deleteProject([/* ... */]);
$promise = $client->deleteProjectAsync([/* ... */]);

Deletes an Evidently project. Before you can delete a project, you must delete all the features that the project contains. To delete a feature, use DeleteFeature.

Parameter Syntax

$result = $client->deleteProject([
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

project

Required: Yes
Type: string

The name or ARN of the project to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

DeleteSegment

$result = $client->deleteSegment([/* ... */]);
$promise = $client->deleteSegmentAsync([/* ... */]);

Deletes a segment. You can't delete a segment that is being used in a launch or experiment, even if that launch or experiment is not currently running.

Parameter Syntax

$result = $client->deleteSegment([
    'segment' => '<string>', // REQUIRED
]);

Parameter Details

Members

segment

Required: Yes
Type: string

Specifies the segment to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

EvaluateFeature

$result = $client->evaluateFeature([/* ... */]);
$promise = $client->evaluateFeatureAsync([/* ... */]);

This operation assigns a feature variation to one given user session. You pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation.

The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule.

If there is a current launch with this feature that uses segment overrides, and if the user session's evaluationContext matches a segment rule defined in a segment override, the configuration in the segment overrides is used. For more information about segments, see CreateSegment and Use segments to focus your audience.

If there is a launch with no segment overrides, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch.

If the experiment uses a segment, then only user sessions with evaluationContext values that match the segment rule are used in the experiment.

If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment.

If the user is not assigned to a launch or experiment, they are served the default variation.

Parameter Syntax

$result = $client->evaluateFeature([
    'entityId' => '<string>', // REQUIRED
    'evaluationContext' => '<string>',
    'feature' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

entityId

Required: Yes
Type: string

An internal ID that represents a unique user of the application. This entityID is checked against any override rules assigned for this feature.

evaluationContext

Type: string (string|number|array|map or anything parsable by json_encode)

A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.

If you include this parameter, the value must be a JSON object. A JSON array is not supported.

feature

Required: Yes
Type: string

The name of the feature being evaluated.

project

Required: Yes
Type: string

The name or ARN of the project that contains this feature.

Result Syntax

[
    'details' => '<string>',
    'reason' => '<string>',
    'value' => [
        'boolValue' => true || false,
        'doubleValue' => <float>,
        'longValue' => <integer>,
        'stringValue' => '<string>',
    ],
    'variation' => '<string>',
]

Result Details

Members

details

Type: string (string|number|array|map or anything parsable by json_encode)

If this user was assigned to a launch or experiment, this field lists the launch or experiment name.

reason

Type: string

Specifies the reason that the user session was assigned this variation. Possible values include DEFAULT, meaning the user was served the default variation; LAUNCH_RULE_MATCH, if the user session was enrolled in a launch; EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment; or ENTITY_OVERRIDES_MATCH, if the user's entityId matches an override rule.

value

Type: VariableValue structure

The value assigned to this variation to differentiate it from the other variations of this feature.

variation

Type: string

The name of the variation that was served to the user session.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

GetExperiment

$result = $client->getExperiment([/* ... */]);
$promise = $client->getExperimentAsync([/* ... */]);

Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.

Parameter Syntax

$result = $client->getExperiment([
    'experiment' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

experiment

Required: Yes
Type: string

The name of the experiment that you want to see the details of.

project

Required: Yes
Type: string

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

Result Syntax

[
    'experiment' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'execution' => [
            'endedTime' => <DateTime>,
            'startedTime' => <DateTime>,
        ],
        'lastUpdatedTime' => <DateTime>,
        'metricGoals' => [
            [
                'desiredChange' => 'INCREASE|DECREASE',
                'metricDefinition' => [
                    'entityIdKey' => '<string>',
                    'eventPattern' => '<string>',
                    'name' => '<string>',
                    'unitLabel' => '<string>',
                    'valueKey' => '<string>',
                ],
            ],
            // ...
        ],
        'name' => '<string>',
        'onlineAbDefinition' => [
            'controlTreatmentName' => '<string>',
            'treatmentWeights' => [<integer>, ...],
        ],
        'project' => '<string>',
        'randomizationSalt' => '<string>',
        'samplingRate' => <integer>,
        'schedule' => [
            'analysisCompleteTime' => <DateTime>,
        ],
        'segment' => '<string>',
        'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
        'statusReason' => '<string>',
        'tags' => ['<string>', ...],
        'treatments' => [
            [
                'description' => '<string>',
                'featureVariations' => ['<string>', ...],
                'name' => '<string>',
            ],
            // ...
        ],
        'type' => 'aws.evidently.onlineab',
    ],
]

Result Details

Members

experiment

Type: Experiment structure

A structure containing the configuration details of the experiment.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

GetExperimentResults

$result = $client->getExperimentResults([/* ... */]);
$promise = $client->getExperimentResultsAsync([/* ... */]);

Retrieves the results of a running or completed experiment. No results are available until there have been 100 events for each variation and at least 10 minutes have passed since the start of the experiment. To increase the statistical power, Evidently performs an additional offline p-value analysis at the end of the experiment. Offline p-value analysis can detect statistical significance in some cases where the anytime p-values used during the experiment do not find statistical significance.

Experiment results are available up to 63 days after the start of the experiment. They are not available after that because of CloudWatch data retention policies.

Parameter Syntax

$result = $client->getExperimentResults([
    'baseStat' => 'Mean',
    'endTime' => <integer || string || DateTime>,
    'experiment' => '<string>', // REQUIRED
    'metricNames' => ['<string>', ...], // REQUIRED
    'period' => <integer>,
    'project' => '<string>', // REQUIRED
    'reportNames' => ['<string>', ...],
    'resultStats' => ['<string>', ...],
    'startTime' => <integer || string || DateTime>,
    'treatmentNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

baseStat

Type: string

The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

endTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

experiment

Required: Yes
Type: string

The name of the experiment to retrieve the results of.

metricNames

Required: Yes
Type: Array of strings

The names of the experiment metrics that you want to see the results of.

period

Type: long (int|float)

In seconds, the amount of time to aggregate results together.

project

Required: Yes
Type: string

The name or ARN of the project that contains the experiment that you want to see the results of.

reportNames

Type: Array of strings

The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

resultStats

Type: Array of strings

The statistics that you want to see in the returned results.

PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.
ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.
TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.
BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

startTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the experiment started.

treatmentNames

Required: Yes
Type: Array of strings

The names of the experiment treatments that you want to see the results for.

Result Syntax

[
    'details' => '<string>',
    'reports' => [
        [
            'content' => '<string>',
            'metricName' => '<string>',
            'reportName' => 'BayesianInference',
            'treatmentName' => '<string>',
        ],
        // ...
    ],
    'resultsData' => [
        [
            'metricName' => '<string>',
            'resultStat' => 'Mean|TreatmentEffect|ConfidenceIntervalUpperBound|ConfidenceIntervalLowerBound|PValue',
            'treatmentName' => '<string>',
            'values' => [<float>, ...],
        ],
        // ...
    ],
    'timestamps' => [<DateTime>, ...],
]

Result Details

Members

details

Type: string

If the experiment doesn't yet have enough events to provide valid results, this field is returned with the message Not enough events to generate results. If there are enough events to provide valid results, this field is not returned.

reports

Type: Array of ExperimentReport structures

An array of structures that include the reports that you requested.

resultsData

Type: Array of ExperimentResultsData structures

An array of structures that include experiment results including metric names and values.

timestamps

Type: Array of timestamp (string|DateTime or anything parsable by strtotime)s

The timestamps of each result returned.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

GetFeature

$result = $client->getFeature([/* ... */]);
$promise = $client->getFeatureAsync([/* ... */]);

Returns the details about one feature. You must already know the feature name. To retrieve a list of features in your account, use ListFeatures.

Parameter Syntax

$result = $client->getFeature([
    'feature' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

feature

Required: Yes
Type: string

The name of the feature that you want to retrieve information for.

project

Required: Yes
Type: string

The name or ARN of the project that contains the feature.

Result Syntax

[
    'feature' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'defaultVariation' => '<string>',
        'description' => '<string>',
        'entityOverrides' => ['<string>', ...],
        'evaluationRules' => [
            [
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'evaluationStrategy' => 'ALL_RULES|DEFAULT_VARIATION',
        'lastUpdatedTime' => <DateTime>,
        'name' => '<string>',
        'project' => '<string>',
        'status' => 'AVAILABLE|UPDATING',
        'tags' => ['<string>', ...],
        'valueType' => 'STRING|LONG|DOUBLE|BOOLEAN',
        'variations' => [
            [
                'name' => '<string>',
                'value' => [
                    'boolValue' => true || false,
                    'doubleValue' => <float>,
                    'longValue' => <integer>,
                    'stringValue' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

feature

Required: Yes
Type: Feature structure

A structure containing the configuration details of the feature.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

GetLaunch

$result = $client->getLaunch([/* ... */]);
$promise = $client->getLaunchAsync([/* ... */]);

Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in your account, use ListLaunches.

Parameter Syntax

$result = $client->getLaunch([
    'launch' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

launch

Required: Yes
Type: string

The name of the launch that you want to see the details of.

project

Required: Yes
Type: string

The name or ARN of the project that contains the launch.

Result Syntax

[
    'launch' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'execution' => [
            'endedTime' => <DateTime>,
            'startedTime' => <DateTime>,
        ],
        'groups' => [
            [
                'description' => '<string>',
                'featureVariations' => ['<string>', ...],
                'name' => '<string>',
            ],
            // ...
        ],
        'lastUpdatedTime' => <DateTime>,
        'metricMonitors' => [
            [
                'metricDefinition' => [
                    'entityIdKey' => '<string>',
                    'eventPattern' => '<string>',
                    'name' => '<string>',
                    'unitLabel' => '<string>',
                    'valueKey' => '<string>',
                ],
            ],
            // ...
        ],
        'name' => '<string>',
        'project' => '<string>',
        'randomizationSalt' => '<string>',
        'scheduledSplitsDefinition' => [
            'steps' => [
                [
                    'groupWeights' => [<integer>, ...],
                    'segmentOverrides' => [
                        [
                            'evaluationOrder' => <integer>,
                            'segment' => '<string>',
                            'weights' => [<integer>, ...],
                        ],
                        // ...
                    ],
                    'startTime' => <DateTime>,
                ],
                // ...
            ],
        ],
        'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
        'statusReason' => '<string>',
        'tags' => ['<string>', ...],
        'type' => 'aws.evidently.splits',
    ],
]

Result Details

Members

launch

Type: Launch structure

A structure containing the configuration details of the launch.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

GetProject

$result = $client->getProject([/* ... */]);
$promise = $client->getProjectAsync([/* ... */]);

Returns the details about one launch. You must already know the project name. To retrieve a list of projects in your account, use ListProjects.

Parameter Syntax

$result = $client->getProject([
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

project

Required: Yes
Type: string

The name or ARN of the project that you want to see the details of.

Result Syntax

[
    'project' => [
        'activeExperimentCount' => <integer>,
        'activeLaunchCount' => <integer>,
        'appConfigResource' => [
            'applicationId' => '<string>',
            'configurationProfileId' => '<string>',
            'environmentId' => '<string>',
        ],
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'dataDelivery' => [
            'cloudWatchLogs' => [
                'logGroup' => '<string>',
            ],
            's3Destination' => [
                'bucket' => '<string>',
                'prefix' => '<string>',
            ],
        ],
        'description' => '<string>',
        'experimentCount' => <integer>,
        'featureCount' => <integer>,
        'lastUpdatedTime' => <DateTime>,
        'launchCount' => <integer>,
        'name' => '<string>',
        'status' => 'AVAILABLE|UPDATING',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

project

Required: Yes
Type: Project structure

A structure containing the configuration details of the project.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

GetSegment

$result = $client->getSegment([/* ... */]);
$promise = $client->getSegmentAsync([/* ... */]);

Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.

Parameter Syntax

$result = $client->getSegment([
    'segment' => '<string>', // REQUIRED
]);

Parameter Details

Members

segment

Required: Yes
Type: string

The ARN of the segment to return information for.

Result Syntax

[
    'segment' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'experimentCount' => <integer>,
        'lastUpdatedTime' => <DateTime>,
        'launchCount' => <integer>,
        'name' => '<string>',
        'pattern' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

segment

Required: Yes
Type: Segment structure

A structure that contains the complete information about the segment.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

ListExperiments

$result = $client->listExperiments([/* ... */]);
$promise = $client->listExperimentsAsync([/* ... */]);

Returns configuration details about all the experiments in the specified project.

Parameter Syntax

$result = $client->listExperiments([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'project' => '<string>', // REQUIRED
    'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
]);

Parameter Details

Members

maxResults

Type: int

The maximum number of results to include in the response.

nextToken

Type: string

The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.

project

Required: Yes
Type: string

The name or ARN of the project to return the experiment list from.

status

Type: string

Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.

Result Syntax

[
    'experiments' => [
        [
            'arn' => '<string>',
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'execution' => [
                'endedTime' => <DateTime>,
                'startedTime' => <DateTime>,
            ],
            'lastUpdatedTime' => <DateTime>,
            'metricGoals' => [
                [
                    'desiredChange' => 'INCREASE|DECREASE',
                    'metricDefinition' => [
                        'entityIdKey' => '<string>',
                        'eventPattern' => '<string>',
                        'name' => '<string>',
                        'unitLabel' => '<string>',
                        'valueKey' => '<string>',
                    ],
                ],
                // ...
            ],
            'name' => '<string>',
            'onlineAbDefinition' => [
                'controlTreatmentName' => '<string>',
                'treatmentWeights' => [<integer>, ...],
            ],
            'project' => '<string>',
            'randomizationSalt' => '<string>',
            'samplingRate' => <integer>,
            'schedule' => [
                'analysisCompleteTime' => <DateTime>,
            ],
            'segment' => '<string>',
            'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
            'statusReason' => '<string>',
            'tags' => ['<string>', ...],
            'treatments' => [
                [
                    'description' => '<string>',
                    'featureVariations' => ['<string>', ...],
                    'name' => '<string>',
                ],
                // ...
            ],
            'type' => 'aws.evidently.onlineab',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

experiments

Type: Array of Experiment structures

An array of structures that contain the configuration details of the experiments in the specified project.

nextToken

Type: string

The token to use in a subsequent ListExperiments operation to return the next set of results.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

ListFeatures

$result = $client->listFeatures([/* ... */]);
$promise = $client->listFeaturesAsync([/* ... */]);

Returns configuration details about all the features in the specified project.

Parameter Syntax

$result = $client->listFeatures([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

Type: int

The maximum number of results to include in the response.

nextToken

Type: string

The token to use when requesting the next set of results. You received this token from a previous ListFeatures operation.

project

Required: Yes
Type: string

The name or ARN of the project to return the feature list from.

Result Syntax

[
    'features' => [
        [
            'arn' => '<string>',
            'createdTime' => <DateTime>,
            'defaultVariation' => '<string>',
            'evaluationRules' => [
                [
                    'name' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'evaluationStrategy' => 'ALL_RULES|DEFAULT_VARIATION',
            'lastUpdatedTime' => <DateTime>,
            'name' => '<string>',
            'project' => '<string>',
            'status' => 'AVAILABLE|UPDATING',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

features

Type: Array of FeatureSummary structures

An array of structures that contain the configuration details of the features in the specified project.

nextToken

Type: string

The token to use in a subsequent ListFeatures operation to return the next set of results.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

ListLaunches

$result = $client->listLaunches([/* ... */]);
$promise = $client->listLaunchesAsync([/* ... */]);

Returns configuration details about all the launches in the specified project.

Parameter Syntax

$result = $client->listLaunches([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'project' => '<string>', // REQUIRED
    'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
]);

Parameter Details

Members

maxResults

Type: int

The maximum number of results to include in the response.

nextToken

Type: string

The token to use when requesting the next set of results. You received this token from a previous ListLaunches operation.

project

Required: Yes
Type: string

The name or ARN of the project to return the launch list from.

status

Type: string

Use this optional parameter to limit the returned results to only the launches with the status that you specify here.

Result Syntax

[
    'launches' => [
        [
            'arn' => '<string>',
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'execution' => [
                'endedTime' => <DateTime>,
                'startedTime' => <DateTime>,
            ],
            'groups' => [
                [
                    'description' => '<string>',
                    'featureVariations' => ['<string>', ...],
                    'name' => '<string>',
                ],
                // ...
            ],
            'lastUpdatedTime' => <DateTime>,
            'metricMonitors' => [
                [
                    'metricDefinition' => [
                        'entityIdKey' => '<string>',
                        'eventPattern' => '<string>',
                        'name' => '<string>',
                        'unitLabel' => '<string>',
                        'valueKey' => '<string>',
                    ],
                ],
                // ...
            ],
            'name' => '<string>',
            'project' => '<string>',
            'randomizationSalt' => '<string>',
            'scheduledSplitsDefinition' => [
                'steps' => [
                    [
                        'groupWeights' => [<integer>, ...],
                        'segmentOverrides' => [
                            [
                                'evaluationOrder' => <integer>,
                                'segment' => '<string>',
                                'weights' => [<integer>, ...],
                            ],
                            // ...
                        ],
                        'startTime' => <DateTime>,
                    ],
                    // ...
                ],
            ],
            'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
            'statusReason' => '<string>',
            'tags' => ['<string>', ...],
            'type' => 'aws.evidently.splits',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

launches

Type: Array of Launch structures

An array of structures that contain the configuration details of the launches in the specified project.

nextToken

Type: string

The token to use in a subsequent ListLaunches operation to return the next set of results.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

ListProjects

$result = $client->listProjects([/* ... */]);
$promise = $client->listProjectsAsync([/* ... */]);

Returns configuration details about all the projects in the current Region in your account.

Parameter Syntax

$result = $client->listProjects([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

Type: int

The maximum number of results to include in the response.

nextToken

Type: string

The token to use when requesting the next set of results. You received this token from a previous ListProjects operation.

Result Syntax

[
    'nextToken' => '<string>',
    'projects' => [
        [
            'activeExperimentCount' => <integer>,
            'activeLaunchCount' => <integer>,
            'arn' => '<string>',
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'experimentCount' => <integer>,
            'featureCount' => <integer>,
            'lastUpdatedTime' => <DateTime>,
            'launchCount' => <integer>,
            'name' => '<string>',
            'status' => 'AVAILABLE|UPDATING',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

The token to use in a subsequent ListProjects operation to return the next set of results.

projects

Type: Array of ProjectSummary structures

An array of structures that contain the configuration details of the projects in the Region.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

ListSegmentReferences

$result = $client->listSegmentReferences([/* ... */]);
$promise = $client->listSegmentReferencesAsync([/* ... */]);

Use this operation to find which experiments or launches are using a specified segment.

Parameter Syntax

$result = $client->listSegmentReferences([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'segment' => '<string>', // REQUIRED
    'type' => 'EXPERIMENT|LAUNCH', // REQUIRED
]);

Parameter Details

Members

maxResults

Type: int

The maximum number of results to include in the response. If you omit this, the default of 50 is used.

nextToken

Type: string

The token to use when requesting the next set of results. You received this token from a previous ListSegmentReferences operation.

segment

Required: Yes
Type: string

The ARN of the segment that you want to view information for.

type

Required: Yes
Type: string

Specifies whether to return information about launches or experiments that use this segment.

Result Syntax

[
    'nextToken' => '<string>',
    'referencedBy' => [
        [
            'arn' => '<string>',
            'endTime' => '<string>',
            'lastUpdatedOn' => '<string>',
            'name' => '<string>',
            'startTime' => '<string>',
            'status' => '<string>',
            'type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

The token to use in a subsequent ListSegmentReferences operation to return the next set of results.

referencedBy

Type: Array of RefResource structures

An array of structures, where each structure contains information about one experiment or launch that uses this segment.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

ListSegments

$result = $client->listSegments([/* ... */]);
$promise = $client->listSegmentsAsync([/* ... */]);

Returns a list of audience segments that you have created in your account in this Region.

Parameter Syntax

$result = $client->listSegments([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

Type: int

The maximum number of results to include in the response. If you omit this, the default of 50 is used.

nextToken

Type: string

The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.

Result Syntax

[
    'nextToken' => '<string>',
    'segments' => [
        [
            'arn' => '<string>',
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'experimentCount' => <integer>,
            'lastUpdatedTime' => <DateTime>,
            'launchCount' => <integer>,
            'name' => '<string>',
            'pattern' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

The token to use in a subsequent ListSegments operation to return the next set of results.

segments

Type: Array of Segment structures

An array of structures that contain information about the segments in this Region.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Displays the tags associated with an Evidently resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The ARN of the resource that you want to see the tags of.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values associated with the resource you specified.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ResourceNotFoundException:
The request references a resource that does not exist.

PutProjectEvents

$result = $client->putProjectEvents([/* ... */]);
$promise = $client->putProjectEventsAsync([/* ... */]);

Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment.

Parameter Syntax

$result = $client->putProjectEvents([
    'events' => [ // REQUIRED
        [
            'data' => '<string>', // REQUIRED
            'timestamp' => <integer || string || DateTime>, // REQUIRED
            'type' => 'aws.evidently.evaluation|aws.evidently.custom', // REQUIRED
        ],
        // ...
    ],
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

events

Required: Yes
Type: Array of Event structures

An array of event structures that contain the performance data that is being sent to Evidently.

project

Required: Yes
Type: string

The name or ARN of the project to write the events to.

Result Syntax

[
    'eventResults' => [
        [
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
            'eventId' => '<string>',
        ],
        // ...
    ],
    'failedEventCount' => <integer>,
]

Result Details

Members

eventResults

Type: Array of PutProjectEventsResultEntry structures

A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.

failedEventCount

Type: int

The number of events in the operation that could not be used by Evidently.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

StartExperiment

$result = $client->startExperiment([/* ... */]);
$promise = $client->startExperimentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startExperiment([
    'analysisCompleteTime' => <integer || string || DateTime>, // REQUIRED
    'experiment' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

analysisCompleteTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

experiment

Required: Yes
Type: string

The name of the experiment to start.

project

Required: Yes
Type: string

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

Result Syntax

[
    'startedTime' => <DateTime>,
]

Result Details

Members

startedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates when the experiment started.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

StartLaunch

$result = $client->startLaunch([/* ... */]);
$promise = $client->startLaunchAsync([/* ... */]);

Starts an existing launch. To create a launch, use CreateLaunch.

Parameter Syntax

$result = $client->startLaunch([
    'launch' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

launch

Required: Yes
Type: string

The name of the launch to start.

project

Required: Yes
Type: string

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

Result Syntax

[
    'launch' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'execution' => [
            'endedTime' => <DateTime>,
            'startedTime' => <DateTime>,
        ],
        'groups' => [
            [
                'description' => '<string>',
                'featureVariations' => ['<string>', ...],
                'name' => '<string>',
            ],
            // ...
        ],
        'lastUpdatedTime' => <DateTime>,
        'metricMonitors' => [
            [
                'metricDefinition' => [
                    'entityIdKey' => '<string>',
                    'eventPattern' => '<string>',
                    'name' => '<string>',
                    'unitLabel' => '<string>',
                    'valueKey' => '<string>',
                ],
            ],
            // ...
        ],
        'name' => '<string>',
        'project' => '<string>',
        'randomizationSalt' => '<string>',
        'scheduledSplitsDefinition' => [
            'steps' => [
                [
                    'groupWeights' => [<integer>, ...],
                    'segmentOverrides' => [
                        [
                            'evaluationOrder' => <integer>,
                            'segment' => '<string>',
                            'weights' => [<integer>, ...],
                        ],
                        // ...
                    ],
                    'startTime' => <DateTime>,
                ],
                // ...
            ],
        ],
        'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
        'statusReason' => '<string>',
        'tags' => ['<string>', ...],
        'type' => 'aws.evidently.splits',
    ],
]

Result Details

Members

launch

Required: Yes
Type: Launch structure

A structure that contains information about the launch that was started.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

StopExperiment

$result = $client->stopExperiment([/* ... */]);
$promise = $client->stopExperimentAsync([/* ... */]);

Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it.

Parameter Syntax

$result = $client->stopExperiment([
    'desiredState' => 'COMPLETED|CANCELLED',
    'experiment' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
    'reason' => '<string>',
]);

Parameter Details

Members

desiredState

Type: string

Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

experiment

Required: Yes
Type: string

The name of the experiment to stop.

project

Required: Yes
Type: string

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

reason

Type: string

A string that describes why you are stopping the experiment.

Result Syntax

[
    'endedTime' => <DateTime>,
]

Result Details

Members

endedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the experiment stopped.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

StopLaunch

$result = $client->stopLaunch([/* ... */]);
$promise = $client->stopLaunchAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopLaunch([
    'desiredState' => 'COMPLETED|CANCELLED',
    'launch' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
    'reason' => '<string>',
]);

Parameter Details

Members

desiredState

Type: string

Specify whether to consider the launch as COMPLETED or CANCELLED after it stops.

launch

Required: Yes
Type: string

The name of the launch to stop.

project

Required: Yes
Type: string

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

reason

Type: string

A string that describes why you are stopping the launch.

Result Syntax

[
    'endedTime' => <DateTime>,
]

Result Details

Members

endedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the launch stopped.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource. Projects, features, launches, and experiments can be tagged.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

For more information, see Tagging Amazon Web Services resources.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The ARN of the CloudWatch Evidently resource that you're adding tags to.

tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The list of key-value pairs to associate with the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ResourceNotFoundException:
The request references a resource that does not exist.

TestSegmentPattern

$result = $client->testSegmentPattern([/* ... */]);
$promise = $client->testSegmentPatternAsync([/* ... */]);

Use this operation to test a rules pattern that you plan to use to create an audience segment. For more information about segments, see CreateSegment.

Parameter Syntax

$result = $client->testSegmentPattern([
    'pattern' => '<string>', // REQUIRED
    'payload' => '<string>', // REQUIRED
]);

Parameter Details

Members

pattern

Required: Yes
Type: string (string|number|array|map or anything parsable by json_encode)

The pattern to test.

payload

Required: Yes
Type: string (string|number|array|map or anything parsable by json_encode)

A sample evaluationContext JSON block to test against the specified pattern.

Result Syntax

[
    'match' => true || false,
]

Result Details

Members

match

Required: Yes
Type: boolean

Returns true if the pattern matches the payload.

Errors

ThrottlingException:
The request was denied because of request throttling. Retry the request.
ValidationException:
The value of a parameter in the request caused an error.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The ARN of the CloudWatch Evidently resource that you're removing tags from.

tagKeys

Required: Yes
Type: Array of strings

The list of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ResourceNotFoundException:
The request references a resource that does not exist.

UpdateExperiment

$result = $client->updateExperiment([/* ... */]);
$promise = $client->updateExperimentAsync([/* ... */]);

Updates an Evidently experiment.

Don't use this operation to update an experiment's tag. Instead, use TagResource.

Parameter Syntax

$result = $client->updateExperiment([
    'description' => '<string>',
    'experiment' => '<string>', // REQUIRED
    'metricGoals' => [
        [
            'desiredChange' => 'INCREASE|DECREASE',
            'metricDefinition' => [ // REQUIRED
                'entityIdKey' => '<string>', // REQUIRED
                'eventPattern' => '<string>',
                'name' => '<string>', // REQUIRED
                'unitLabel' => '<string>',
                'valueKey' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'onlineAbConfig' => [
        'controlTreatmentName' => '<string>',
        'treatmentWeights' => [<integer>, ...],
    ],
    'project' => '<string>', // REQUIRED
    'randomizationSalt' => '<string>',
    'removeSegment' => true || false,
    'samplingRate' => <integer>,
    'segment' => '<string>',
    'treatments' => [
        [
            'description' => '<string>',
            'feature' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'variation' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

description

Type: string

An optional description of the experiment.

experiment

Required: Yes
Type: string

The name of the experiment to update.

metricGoals

Type: Array of MetricGoalConfig structures

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

onlineAbConfig

Type: OnlineAbConfig structure

A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

project

Required: Yes
Type: string

The name or ARN of the project that contains the experiment that you want to update.

randomizationSalt

Type: string

removeSegment

Type: boolean

Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.

samplingRate

Type: long (int|float)

This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.

segment

Type: string

Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.

treatments

Type: Array of TreatmentConfig structures

An array of structures that define the variations being tested in the experiment.

Result Syntax

[
    'experiment' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'execution' => [
            'endedTime' => <DateTime>,
            'startedTime' => <DateTime>,
        ],
        'lastUpdatedTime' => <DateTime>,
        'metricGoals' => [
            [
                'desiredChange' => 'INCREASE|DECREASE',
                'metricDefinition' => [
                    'entityIdKey' => '<string>',
                    'eventPattern' => '<string>',
                    'name' => '<string>',
                    'unitLabel' => '<string>',
                    'valueKey' => '<string>',
                ],
            ],
            // ...
        ],
        'name' => '<string>',
        'onlineAbDefinition' => [
            'controlTreatmentName' => '<string>',
            'treatmentWeights' => [<integer>, ...],
        ],
        'project' => '<string>',
        'randomizationSalt' => '<string>',
        'samplingRate' => <integer>,
        'schedule' => [
            'analysisCompleteTime' => <DateTime>,
        ],
        'segment' => '<string>',
        'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
        'statusReason' => '<string>',
        'tags' => ['<string>', ...],
        'treatments' => [
            [
                'description' => '<string>',
                'featureVariations' => ['<string>', ...],
                'name' => '<string>',
            ],
            // ...
        ],
        'type' => 'aws.evidently.onlineab',
    ],
]

Result Details

Members

experiment

Required: Yes
Type: Experiment structure

A structure containing the configuration details of the experiment that was updated.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

UpdateFeature

$result = $client->updateFeature([/* ... */]);
$promise = $client->updateFeatureAsync([/* ... */]);

Updates an existing feature.

You can't use this operation to update the tags of an existing feature. Instead, use TagResource.

Parameter Syntax

$result = $client->updateFeature([
    'addOrUpdateVariations' => [
        [
            'name' => '<string>', // REQUIRED
            'value' => [ // REQUIRED
                'boolValue' => true || false,
                'doubleValue' => <float>,
                'longValue' => <integer>,
                'stringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'defaultVariation' => '<string>',
    'description' => '<string>',
    'entityOverrides' => ['<string>', ...],
    'evaluationStrategy' => 'ALL_RULES|DEFAULT_VARIATION',
    'feature' => '<string>', // REQUIRED
    'project' => '<string>', // REQUIRED
    'removeVariations' => ['<string>', ...],
]);

Parameter Details

Members

addOrUpdateVariations

Type: Array of VariationConfig structures

To update variation configurations for this feature, or add new ones, specify this structure. In this array, include any variations that you want to add or update. If the array includes a variation name that already exists for this feature, it is updated. If it includes a new variation name, it is added as a new variation.

defaultVariation

Type: string

The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

description

Type: string

An optional description of the feature.

entityOverrides

Type: Associative array of custom strings keys (EntityId) to strings

Specified users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.

evaluationStrategy

Type: string

Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.

feature

Required: Yes
Type: string

The name of the feature to be updated.

project

Required: Yes
Type: string

The name or ARN of the project that contains the feature to be updated.

removeVariations

Type: Array of strings

Removes a variation from the feature. If the variation you specify doesn't exist, then this makes no change and does not report an error.

This operation fails if you try to remove a variation that is part of an ongoing launch or experiment.

Result Syntax

[
    'feature' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'defaultVariation' => '<string>',
        'description' => '<string>',
        'entityOverrides' => ['<string>', ...],
        'evaluationRules' => [
            [
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'evaluationStrategy' => 'ALL_RULES|DEFAULT_VARIATION',
        'lastUpdatedTime' => <DateTime>,
        'name' => '<string>',
        'project' => '<string>',
        'status' => 'AVAILABLE|UPDATING',
        'tags' => ['<string>', ...],
        'valueType' => 'STRING|LONG|DOUBLE|BOOLEAN',
        'variations' => [
            [
                'name' => '<string>',
                'value' => [
                    'boolValue' => true || false,
                    'doubleValue' => <float>,
                    'longValue' => <integer>,
                    'stringValue' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

feature

Required: Yes
Type: Feature structure

A structure that contains information about the updated feature.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

UpdateLaunch

$result = $client->updateLaunch([/* ... */]);
$promise = $client->updateLaunchAsync([/* ... */]);

Updates a launch of a given feature.

Don't use this operation to update the tags of an existing launch. Instead, use TagResource.

Parameter Syntax

$result = $client->updateLaunch([
    'description' => '<string>',
    'groups' => [
        [
            'description' => '<string>',
            'feature' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'variation' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'launch' => '<string>', // REQUIRED
    'metricMonitors' => [
        [
            'metricDefinition' => [ // REQUIRED
                'entityIdKey' => '<string>', // REQUIRED
                'eventPattern' => '<string>',
                'name' => '<string>', // REQUIRED
                'unitLabel' => '<string>',
                'valueKey' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'project' => '<string>', // REQUIRED
    'randomizationSalt' => '<string>',
    'scheduledSplitsConfig' => [
        'steps' => [ // REQUIRED
            [
                'groupWeights' => [<integer>, ...], // REQUIRED
                'segmentOverrides' => [
                    [
                        'evaluationOrder' => <integer>, // REQUIRED
                        'segment' => '<string>', // REQUIRED
                        'weights' => [<integer>, ...], // REQUIRED
                    ],
                    // ...
                ],
                'startTime' => <integer || string || DateTime>, // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

description

Type: string

An optional description for the launch.

groups

Type: Array of LaunchGroupConfig structures

An array of structures that contains the feature and variations that are to be used for the launch.

launch

Required: Yes
Type: string

The name of the launch that is to be updated.

metricMonitors

Type: Array of MetricMonitorConfig structures

An array of structures that define the metrics that will be used to monitor the launch performance.

project

Required: Yes
Type: string

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

randomizationSalt

Type: string

scheduledSplitsConfig

Type: ScheduledSplitsLaunchConfig structure

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

Result Syntax

[
    'launch' => [
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'execution' => [
            'endedTime' => <DateTime>,
            'startedTime' => <DateTime>,
        ],
        'groups' => [
            [
                'description' => '<string>',
                'featureVariations' => ['<string>', ...],
                'name' => '<string>',
            ],
            // ...
        ],
        'lastUpdatedTime' => <DateTime>,
        'metricMonitors' => [
            [
                'metricDefinition' => [
                    'entityIdKey' => '<string>',
                    'eventPattern' => '<string>',
                    'name' => '<string>',
                    'unitLabel' => '<string>',
                    'valueKey' => '<string>',
                ],
            ],
            // ...
        ],
        'name' => '<string>',
        'project' => '<string>',
        'randomizationSalt' => '<string>',
        'scheduledSplitsDefinition' => [
            'steps' => [
                [
                    'groupWeights' => [<integer>, ...],
                    'segmentOverrides' => [
                        [
                            'evaluationOrder' => <integer>,
                            'segment' => '<string>',
                            'weights' => [<integer>, ...],
                        ],
                        // ...
                    ],
                    'startTime' => <DateTime>,
                ],
                // ...
            ],
        ],
        'status' => 'CREATED|UPDATING|RUNNING|COMPLETED|CANCELLED',
        'statusReason' => '<string>',
        'tags' => ['<string>', ...],
        'type' => 'aws.evidently.splits',
    ],
]

Result Details

Members

launch

Required: Yes
Type: Launch structure

A structure that contains the new configuration of the launch that was updated.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

UpdateProject

$result = $client->updateProject([/* ... */]);
$promise = $client->updateProjectAsync([/* ... */]);

Updates the description of an existing project.

To create a new project, use CreateProject.

Don't use this operation to update the data storage options of a project. Instead, use UpdateProjectDataDelivery.

Don't use this operation to update the tags of a project. Instead, use TagResource.

Parameter Syntax

$result = $client->updateProject([
    'appConfigResource' => [
        'applicationId' => '<string>',
        'environmentId' => '<string>',
    ],
    'description' => '<string>',
    'project' => '<string>', // REQUIRED
]);

Parameter Details

Members

appConfigResource

Type: ProjectAppConfigResourceConfig structure

Use this parameter if the project will use client-side evaluation powered by AppConfig. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. allows you to

This parameter is a structure that contains information about the AppConfig application that will be used for client-side evaluation.

description

Type: string

An optional description of the project.

project

Required: Yes
Type: string

The name or ARN of the project to update.

Result Syntax

[
    'project' => [
        'activeExperimentCount' => <integer>,
        'activeLaunchCount' => <integer>,
        'appConfigResource' => [
            'applicationId' => '<string>',
            'configurationProfileId' => '<string>',
            'environmentId' => '<string>',
        ],
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'dataDelivery' => [
            'cloudWatchLogs' => [
                'logGroup' => '<string>',
            ],
            's3Destination' => [
                'bucket' => '<string>',
                'prefix' => '<string>',
            ],
        ],
        'description' => '<string>',
        'experimentCount' => <integer>,
        'featureCount' => <integer>,
        'lastUpdatedTime' => <DateTime>,
        'launchCount' => <integer>,
        'name' => '<string>',
        'status' => 'AVAILABLE|UPDATING',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

project

Required: Yes
Type: Project structure

A structure containing information about the updated project.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

UpdateProjectDataDelivery

$result = $client->updateProjectDataDelivery([/* ... */]);
$promise = $client->updateProjectDataDeliveryAsync([/* ... */]);

Updates the data storage options for this project. If you store evaluation events, you an keep them and analyze them on your own. If you choose not to store evaluation events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.

You can't specify both cloudWatchLogs and s3Destination in the same operation.

Parameter Syntax

$result = $client->updateProjectDataDelivery([
    'cloudWatchLogs' => [
        'logGroup' => '<string>',
    ],
    'project' => '<string>', // REQUIRED
    's3Destination' => [
        'bucket' => '<string>',
        'prefix' => '<string>',
    ],
]);

Parameter Details

Members

cloudWatchLogs

Type: CloudWatchLogsDestinationConfig structure

A structure containing the CloudWatch Logs log group where you want to store evaluation events.

project

Required: Yes
Type: string

The name or ARN of the project that you want to modify the data storage options for.

s3Destination

Type: S3DestinationConfig structure

A structure containing the S3 bucket name and bucket prefix where you want to store evaluation events.

Result Syntax

[
    'project' => [
        'activeExperimentCount' => <integer>,
        'activeLaunchCount' => <integer>,
        'appConfigResource' => [
            'applicationId' => '<string>',
            'configurationProfileId' => '<string>',
            'environmentId' => '<string>',
        ],
        'arn' => '<string>',
        'createdTime' => <DateTime>,
        'dataDelivery' => [
            'cloudWatchLogs' => [
                'logGroup' => '<string>',
            ],
            's3Destination' => [
                'bucket' => '<string>',
                'prefix' => '<string>',
            ],
        ],
        'description' => '<string>',
        'experimentCount' => <integer>,
        'featureCount' => <integer>,
        'lastUpdatedTime' => <DateTime>,
        'launchCount' => <integer>,
        'name' => '<string>',
        'status' => 'AVAILABLE|UPDATING',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

project

Required: Yes
Type: Project structure

A structure containing details about the project that you updated.

Errors

ValidationException:
The value of a parameter in the request caused an error.
ConflictException:
A resource was in an inconsistent state during an update or a deletion.
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
ResourceNotFoundException:
The request references a resource that does not exist.
AccessDeniedException:
You do not have sufficient permissions to perform this action.

Shapes

AccessDeniedException

Description

You do not have sufficient permissions to perform this action.

Members

message

Type: string

CloudWatchLogsDestination

Description

A structure containing the CloudWatch Logs log group where the project stores evaluation events.

Members

logGroup

Type: string

The name of the log group where the project stores evaluation events.

CloudWatchLogsDestinationConfig

Description

A structure containing the CloudWatch Logs log group where the project stores evaluation events.

Members

logGroup

Type: string

The name of the log group where the project stores evaluation events.

ConflictException

Description

A resource was in an inconsistent state during an update or a deletion.

Members

message

Type: string

resourceId

Type: string

The ID of the resource that caused the exception.

resourceType

Type: string

The type of the resource that is associated with the error.

EvaluationRequest

Description

This structure assigns a feature variation to one user session.

Members

entityId

Required: Yes
Type: string

An internal ID that represents a unique user session of the application. This entityID is checked against any override rules assigned for this feature.

evaluationContext

Type: string (string|number|array|map or anything parsable by json_encode)

A JSON block of attributes that you can optionally pass in. This JSON block is included in the evaluation events sent to Evidently from the user session.

feature

Required: Yes
Type: string

The name of the feature being evaluated.

EvaluationResult

Description

This structure displays the results of one feature evaluation assignment to one user session.

Members

details

Type: string (string|number|array|map or anything parsable by json_encode)

If this user was assigned to a launch or experiment, this field lists the launch or experiment name.

entityId

Required: Yes
Type: string

An internal ID that represents a unique user session of the application.

feature

Required: Yes
Type: string

The name of the feature being evaluated.

project

Type: string

The name or ARN of the project that contains the feature being evaluated.

reason

Type: string

Specifies the reason that the user session was assigned this variation. Possible values include DEFAULT, meaning the user was served the default variation; LAUNCH_RULE_MATCH, if the user session was enrolled in a launch; or EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment.

value

Type: VariableValue structure

The value assigned to this variation to differentiate it from the other variations of this feature.

variation

Type: string

The name of the variation that was served to the user session.

EvaluationRule

Description

A structure that contains the information about an evaluation rule for this feature, if it is used in a launch or experiment.

Members

name

Type: string

The name of the experiment or launch.

type

Required: Yes
Type: string

This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.

Event

Description

A structure that contains the information about one evaluation event or custom event sent to Evidently. This is a JSON payload. If this event specifies a pre-defined event type, the payload must follow the defined event schema.

Members

data

Required: Yes
Type: string (string|number|array|map or anything parsable by json_encode)

The event data.

timestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the event.

type

Required: Yes
Type: string

aws.evidently.evaluation specifies an evaluation event, which determines which feature variation that a user sees. aws.evidently.custom specifies a custom event, which generates metrics from user actions such as clicks and checkouts.

Experiment

Description

A structure containing the configuration details of an experiment.

Members

arn

Required: Yes
Type: string

The ARN of the experiment.

createdTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the experiment is first created.

description

Type: string

A description of the experiment.

execution

Type: ExperimentExecution structure

A structure that contains the date and time that the experiment started and ended.

lastUpdatedTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the experiment was most recently updated.

metricGoals

Type: Array of MetricGoal structures

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

name

Required: Yes
Type: string

The name of the experiment.

onlineAbDefinition

Type: OnlineAbDefinition structure

A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

project

Type: string

The name or ARN of the project that contains this experiment.

randomizationSalt

Type: string

This value is used when Evidently assigns a particular user session to the experiment. It helps 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.

samplingRate

Type: long (int|float)

In thousandths of a percent, the amount of the available audience that is allocated to this experiment. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

This is represented in thousandths of a percent, so a value of 10,000 is 10% of the available audience.

schedule

Type: ExperimentSchedule structure

A structure that contains the time and date that Evidently completed the analysis of the experiment.

segment

Type: string

The audience segment being used for the experiment, if a segment is being used.

status

Required: Yes
Type: string

The current state of the experiment.

statusReason

Type: string

If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values associated with this experiment.

treatments

Type: Array of Treatment structures

An array of structures that describe the configuration of each feature variation used in the experiment.

type

Required: Yes
Type: string

The type of this experiment. Currently, this value must be aws.experiment.onlineab.

ExperimentExecution

Description

This structure contains the date and time that the experiment started and ended.

Members

endedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the experiment ended.

startedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the experiment started.

ExperimentReport

Description

A structure that contains results of an experiment.

Members

content

Type: string (string|number|array|map or anything parsable by json_encode)

The content of the report.

metricName

Type: string

The name of the metric that is analyzed in this experiment report.

reportName

Type: string

The type of analysis used for this report.

treatmentName

Type: string

The name of the variation that this report pertains to.

ExperimentResultsData

Description

A structure that contains experiment results for one metric that is monitored in the experiment.

Members

metricName

Type: string

The name of the metric.

resultStat

Type: string

The experiment statistic that these results pertain to.

treatmentName

Type: string

The treatment, or variation, that returned the values in this structure.

values

Type: Array of doubles

The values for the metricName that were recorded in the experiment.

ExperimentSchedule

Description

This structure contains the time and date that Evidently completed the analysis of the experiment.

Members

analysisCompleteTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time and date that Evidently completed the analysis of the experiment.

Feature

Description

This structure contains information about one Evidently feature in your account.

Members

arn

Required: Yes
Type: string

The ARN of the feature.

createdTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the feature is created.

defaultVariation

Type: string

The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

This variation must also be listed in the variations structure.

If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

description

Type: string

The description of the feature.

entityOverrides

Type: Associative array of custom strings keys (EntityId) to strings

A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.

evaluationRules

Type: Array of EvaluationRule structures

An array of structures that define the evaluation rules for the feature.

evaluationStrategy

Required: Yes
Type: string

If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.

lastUpdatedTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the feature was most recently updated.

name

Required: Yes
Type: string

The name of the feature.

project

Type: string

The name or ARN of the project that contains the feature.

status

Required: Yes
Type: string

The current state of the feature.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values associated with this feature.

valueType

Required: Yes
Type: string

Defines the type of value used to define the different feature variations. For more information, see Variation types

variations

Required: Yes
Type: Array of Variation structures

An array of structures that contain the configuration of the feature's different variations.

FeatureSummary

Description

This structure contains information about one Evidently feature in your account.

Members

arn

Required: Yes
Type: string

The ARN of the feature.

createdTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the feature is created.

defaultVariation

Type: string

The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

evaluationRules

Type: Array of EvaluationRule structures

An array of structures that define

evaluationStrategy

Required: Yes
Type: string

lastUpdatedTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the feature was most recently updated.

name

Required: Yes
Type: string

The name of the feature.

project

Type: string

The name or ARN of the project that contains the feature.

status

Required: Yes
Type: string

The current state of the feature.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values associated with this feature.

InternalServerException

Description

Unexpected error while processing the request. Retry the request.

Members

message

Type: string

Launch

Description

This structure contains the configuration details of one Evidently launch.

Members

arn

Required: Yes
Type: string

The ARN of the launch.

createdTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the launch is created.

description

Type: string

The description of the launch.

execution

Type: LaunchExecution structure

A structure that contains information about the start and end times of the launch.

groups

Type: Array of LaunchGroup structures

An array of structures that define the feature variations that are being used in the launch.

lastUpdatedTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the launch was most recently updated.

metricMonitors

Type: Array of MetricMonitor structures

An array of structures that define the metrics that are being used to monitor the launch performance.

name

Required: Yes
Type: string

The name of the launch.

project

Type: string

The name or ARN of the project that contains the launch.

randomizationSalt

Type: string

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.

scheduledSplitsDefinition

Type: ScheduledSplitsLaunchDefinition structure

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

status

Required: Yes
Type: string

The current state of the launch.

statusReason

Type: string

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.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values associated with this launch.

type

Required: Yes
Type: string

The type of launch.

LaunchExecution

Description

This structure contains information about the start and end times of the launch.

Members

endedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the launch ended.

startedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the launch started.

LaunchGroup

Description

A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.

Members

description

Type: string

A description of the launch group.

featureVariations

Required: Yes
Type: Associative array of custom strings keys (FeatureName) to strings

The feature variation for this launch group. This is a key-value pair.

name

Required: Yes
Type: string

The name of the launch group.

LaunchGroupConfig

Description

A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.

Members

description

Type: string

A description of the launch group.

feature

Required: Yes
Type: string

The feature that this launch is using.

name

Required: Yes
Type: string

A name for this launch group.

variation

Required: Yes
Type: string

The feature variation to use for this launch group.

MetricDefinition

Description

This structure defines a metric that is being used to evaluate the variations during a launch or experiment.

Members

entityIdKey

Type: string

The entity, such as a user or session, that does an action that causes a metric value to be recorded.

eventPattern

Type: string (string|number|array|map or anything parsable by json_encode)

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

name

Type: string

The name of the metric.

unitLabel

Type: string

The label for the units that the metric is measuring.

valueKey

Type: string

The value that is tracked to produce the metric.

MetricDefinitionConfig

Description

This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.

Members

entityIdKey

Required: Yes
Type: string

The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID.

eventPattern

Type: string (string|number|array|map or anything parsable by json_encode)

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

name

Required: Yes
Type: string

A name for the metric.

unitLabel

Type: string

A label for the units that the metric is measuring.

valueKey

Required: Yes
Type: string

The value that is tracked to produce the metric.

MetricGoal

Description

A structure that tells Evidently whether higher or lower values are desired for a metric that is used in an experiment.

Members

desiredChange

Type: string

INCREASE means that a variation with a higher number for this metric is performing better.

DECREASE means that a variation with a lower number for this metric is performing better.

metricDefinition

Required: Yes
Type: MetricDefinition structure

A structure that contains details about the metric.

MetricGoalConfig

Description

Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.

Members

desiredChange

Type: string

INCREASE means that a variation with a higher number for this metric is performing better.

DECREASE means that a variation with a lower number for this metric is performing better.

metricDefinition

Required: Yes
Type: MetricDefinitionConfig structure

A structure that contains details about the metric.

MetricMonitor

Description

A structure that defines a metric to be used to monitor performance of the variations during a launch.

Members

metricDefinition

Required: Yes
Type: MetricDefinition structure

A structure that defines the metric.

MetricMonitorConfig

Description

A structure that defines a metric to be used to monitor performance of the variations during a launch.

Members

metricDefinition

Required: Yes
Type: MetricDefinitionConfig structure

A structure that defines the metric.

OnlineAbConfig

Description

Members

controlTreatmentName

Type: string

The name of the variation that is to be the default variation that the other variations are compared to.

treatmentWeights

Type: Associative array of custom strings keys (TreatmentName) to long (int|float)s

A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

OnlineAbDefinition

Description

Members

controlTreatmentName

Type: string

The name of the variation that is the default variation that the other variations are compared to.

treatmentWeights

Type: Associative array of custom strings keys (TreatmentName) to long (int|float)s

A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

Project

Description

This structure defines a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.

Members

activeExperimentCount

Type: long (int|float)

The number of ongoing experiments currently in the project.

activeLaunchCount

Type: long (int|float)

The number of ongoing launches currently in the project.

appConfigResource

Type: ProjectAppConfigResource structure

This structure defines the configuration of how your application integrates with AppConfig to run client-side evaluation.

arn

Required: Yes
Type: string

The name or ARN of the project.

createdTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the project is created.

dataDelivery

Type: ProjectDataDelivery structure

A structure that contains information about where Evidently is to store evaluation events for longer term storage.

description

Type: string

The user-entered description of the project.

experimentCount

Type: long (int|float)

The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.

featureCount

Type: long (int|float)

The number of features currently in the project.

lastUpdatedTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the project was most recently updated.

launchCount

Type: long (int|float)

The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.

name

Required: Yes
Type: string

The name of the project.

status

Required: Yes
Type: string

The current state of the project.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values associated with this project.

ProjectAppConfigResource

Description

This is a structure that defines the configuration of how your application integrates with AppConfig to run client-side evaluation.

Members

applicationId

Required: Yes
Type: string

The ID of the AppConfig application to use for client-side evaluation.

configurationProfileId

Required: Yes
Type: string

The ID of the AppConfig profile to use for client-side evaluation.

environmentId

Required: Yes
Type: string

The ID of the AppConfig environment to use for client-side evaluation. This must be an environment that is within the application that you specify for applicationId.

ProjectAppConfigResourceConfig

Description

Use this parameter to configure client-side evaluation for your project. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation to assign the variations. This mitigates the latency and availability risks that come with an API call.

ProjectAppConfigResource is a structure that defines the configuration of how your application integrates with AppConfig to run client-side evaluation.

Members

applicationId

Type: string

The ID of the AppConfig application to use for client-side evaluation.

environmentId

Type: string

The ID of the AppConfig environment to use for client-side evaluation. This must be an environment that is within the application that you specify for applicationId.

ProjectDataDelivery

Description

A structure that contains information about where Evidently is to store evaluation events for longer term storage.

Members

cloudWatchLogs

Type: CloudWatchLogsDestination structure

If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

s3Destination

Type: S3Destination structure

If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

ProjectDataDeliveryConfig

Description

A structure that contains information about where Evidently is to store evaluation events for longer term storage.

Members

cloudWatchLogs

Type: CloudWatchLogsDestinationConfig structure

If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

s3Destination

Type: S3DestinationConfig structure

If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

ProjectSummary

Description

A structure that contains configuration information about an Evidently project.

Members

activeExperimentCount

Type: long (int|float)

The number of experiments currently in the project.

activeLaunchCount

Type: long (int|float)

The number of ongoing launches currently in the project.

arn

Required: Yes
Type: string

The name or ARN of the project.

createdTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the project is created.

description

Type: string

The description of the project.

experimentCount

Type: long (int|float)

The number of experiments currently in the project.

featureCount

Type: long (int|float)

The number of features currently in the project.

lastUpdatedTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the project was most recently updated.

launchCount

Type: long (int|float)

The number of launches currently in the project, including launches that are ongoing, completed, and not started yet.

name

Required: Yes
Type: string

The name of the project.

status

Required: Yes
Type: string

The current state of the project.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values associated with this project.

PutProjectEventsResultEntry

Description

A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.

Members

errorCode

Type: string

If the PutProjectEvents operation has an error, the error code is returned here.

errorMessage

Type: string

If the PutProjectEvents operation has an error, the error message is returned here.

eventId

Type: string

A unique ID assigned to this PutProjectEvents operation.

RefResource

Description

A structure that contains information about one experiment or launch that uses the specified segment.

Members

arn

Type: string

The ARN of the experiment or launch.

endTime

Type: string

The day and time that this experiment or launch ended.

lastUpdatedOn

Type: string

The day and time that this experiment or launch was most recently updated.

name

Required: Yes
Type: string

The name of the experiment or launch.

startTime

Type: string

The day and time that this experiment or launch started.

status

Type: string

The status of the experiment or launch.

type

Required: Yes
Type: string

Specifies whether the resource that this structure contains information about is an experiment or a launch.

ResourceNotFoundException

Description

The request references a resource that does not exist.

Members

message

Type: string

resourceId

Type: string

The ID of the resource that caused the exception.

resourceType

Type: string

The type of the resource that is associated with the error.

S3Destination

Description

If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

Members

bucket

Type: string

The name of the bucket in which Evidently stores evaluation events.

prefix

Type: string

The bucket prefix in which Evidently stores evaluation events.

S3DestinationConfig

Description

If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

Members

bucket

Type: string

The name of the bucket in which Evidently stores evaluation events.

prefix

Type: string

The bucket prefix in which Evidently stores evaluation events.

ScheduledSplit

Description

This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

Members

groupWeights

Type: Associative array of custom strings keys (GroupName) to long (int|float)s

The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.

segmentOverrides

Type: Array of SegmentOverride structures

Use this parameter to specify different traffic splits for one or more audience segments. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

startTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that this step of the launch starts.

ScheduledSplitConfig

Description

This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

Members

groupWeights

Required: Yes
Type: Associative array of custom strings keys (GroupName) to long (int|float)s

The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

segmentOverrides

Type: Array of SegmentOverride structures

This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

startTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that this step of the launch starts.

ScheduledSplitsLaunchConfig

Description

An array of structures that define the traffic allocation percentages among the feature variations during each step of a launch. This also defines the start time of each step.

Members

steps

Required: Yes
Type: Array of ScheduledSplitConfig structures

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

ScheduledSplitsLaunchDefinition

Description

An array of structures that define the traffic allocation percentages among the feature variations during each step of a launch. This also defines the start time of each step.

Members

steps

Type: Array of ScheduledSplit structures

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

Segment

Description

This structure contains information about one audience segment. You can use segments in your experiments and launches to narrow the user sessions used for experiment or launch to only the user sessions that match one or more criteria.

Members

arn

Required: Yes
Type: string

The ARN of the segment.

createdTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that this segment was created.

description

Type: string

The customer-created description for this segment.

experimentCount

Type: long (int|float)

The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.

lastUpdatedTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that this segment was most recently updated.

launchCount

Type: long (int|float)

The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.

name

Required: Yes
Type: string

The name of the segment.

pattern

Required: Yes
Type: string (string|number|array|map or anything parsable by json_encode)

The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of tag keys and values associated with this launch.

SegmentOverride

Description

This structure specifies a segment that you have already created, and defines the traffic split for that segment to be used in a launch.

Members

evaluationOrder

Required: Yes
Type: long (int|float)

A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.

segment

Required: Yes
Type: string

The ARN of the segment to use.

weights

Required: Yes
Type: Associative array of custom strings keys (GroupName) to long (int|float)s

The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

ServiceQuotaExceededException

Description

The request would cause a service quota to be exceeded.

Members

message

Type: string

quotaCode

Type: string

The ID of the service quota that was exceeded.

resourceId

Type: string

The ID of the resource that caused the exception.

resourceType

Type: string

The type of the resource that is associated with the error.

serviceCode

Type: string

The ID of the service that is associated with the error.

ServiceUnavailableException

Description

The service was unavailable. Retry the request.

Members

message

Type: string

ThrottlingException

Description

The request was denied because of request throttling. Retry the request.

Members

message

Type: string

quotaCode

Type: string

The ID of the service quota that was exceeded.

serviceCode

Type: string

The ID of the service that is associated with the error.

Treatment

Description

A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.

Members

description

Type: string

The description of the treatment.

featureVariations

Type: Associative array of custom strings keys (FeatureName) to strings

The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

name

Required: Yes
Type: string

The name of this treatment.

TreatmentConfig

Description

A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.

Members

description

Type: string

A description for this treatment.

feature

Required: Yes
Type: string

The feature that this experiment is testing.

name

Required: Yes
Type: string

A name for this treatment.

variation

Required: Yes
Type: string

The name of the variation to use as this treatment in the experiment.

ValidationException

Description

The value of a parameter in the request caused an error.

Members

fieldList

Type: Array of ValidationExceptionField structures

The parameter that caused the exception.

message

Type: string

reason

Type: string

A reason for the error.

ValidationExceptionField

Description

A structure containing an error name and message.

Members

message

Required: Yes
Type: string

The error message.

name

Required: Yes
Type: string

The error name.

VariableValue

Description

The value assigned to a feature variation. This structure must contain exactly one field. It can be boolValue, doubleValue, longValue, or stringValue.

Members

boolValue

Type: boolean

If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

doubleValue

Type: double

If this feature uses the double integer variation type, this field contains the double integer value of this variation.

longValue

Type: long (int|float)

If this feature uses the long variation type, this field contains the long value of this variation.

stringValue

Type: string

If this feature uses the string variation type, this field contains the string value of this variation.

Variation

Description

This structure contains the name and variation value of one variation of a feature.

Members

name

Type: string

The name of the variation.

value

Type: VariableValue structure

The value assigned to this variation.

VariationConfig

Description

This structure contains the name and variation value of one variation of a feature.

Members

name

Required: Yes
Type: string

The name of the variation.

value

Required: Yes
Type: VariableValue structure

The value assigned to this variation.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon CloudWatch Evidently 2021-02-01

Operation Summary

Paginators

Operations

BatchEvaluateFeature

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateExperiment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFeature

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLaunch

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateProject

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateSegment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteExperiment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteFeature

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteLaunch

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteProject