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

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

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

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

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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 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 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

Result Syntax

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

Result Details

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

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

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

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

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[
    'startedTime' => <DateTime>,
]

Result Details

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

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

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

Result Syntax

[
    'endedTime' => <DateTime>,
]

Result Details

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

Result Syntax

[
    'endedTime' => <DateTime>,
]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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

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

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

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

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

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

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

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.