AWS CLI Command Reference

[ aws . appconfig ]

update-experiment-run

Description

Updates a running experiment. Use this operation to increase audience exposure, modify treatment assignment overrides, or update the description of an active experiment run. Audience exposure can only be increased, not decreased.

See also: AWS API Documentation

Synopsis

  update-experiment-run
--application-identifier <value>
--experiment-definition-identifier <value>
--run <value>
[--description <value>]
[--exposure-percentage <value>]
[--treatment-overrides <value>]
[--deployment-parameters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--application-identifier (string) [required]

The application ID or name.

Constraints:

  • min: 1
  • max: 2048

--experiment-definition-identifier (string) [required]

The experiment definition ID or name.

Constraints:

  • min: 1
  • max: 2048

--run (integer) [required]

The run number to update.

Constraints:

  • min: 1

--description (string)

An updated description for the experiment run.

Constraints:

  • min: 0
  • max: 1024

--exposure-percentage (float)

The new exposure percentage. This value can only be increased from the current setting.

Constraints:

  • min: 0.0
  • max: 100.0

--treatment-overrides (tagged union structure)

Updated treatment assignment overrides.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Inline.

Inline -> (map)

A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.

Constraints:

  • min: 0
  • max: 32

key -> (string)

Constraints:

  • min: 1
  • max: 2048

value -> (string)

Constraints:

  • pattern: ^[a-zA-Z0-9]{1,8}

Shorthand Syntax:

Inline={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "Inline": {"string": "string"
    ...}
}

--deployment-parameters (structure)

Updated deployment parameters.

DynamicExtensionParameters -> (map)

A map of extension parameters for the deployment.

Constraints:

  • min: 1
  • max: 10

key -> (string)

Constraints:

  • pattern: ^([^#\n]{1,96})#([^\/#\n]{1,64})$

value -> (string)

Constraints:

  • min: 1
  • max: 2048

Tags -> (map)

The tags to assign to the deployment.

Constraints:

  • min: 0
  • max: 50

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (string)

Constraints:

  • max: 256

Shorthand Syntax:

DynamicExtensionParameters={KeyName1=string,KeyName2=string},Tags={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "DynamicExtensionParameters": {"string": "string"
    ...},
  "Tags": {"string": "string"
    ...}
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

ApplicationId -> (string)

The application ID.

Constraints:

  • pattern: [a-z0-9]{4,7}

ExperimentDefinitionId -> (string)

The experiment definition ID.

Constraints:

  • pattern: [a-z0-9]{4,7}

Run -> (integer)

The experiment run number.

Description -> (string)

A description of the experiment run.

Constraints:

  • min: 0
  • max: 1024

Status -> (string)

The current status of the experiment run. Valid values: RUNNING , DONE .

Possible values:

  • RUNNING
  • DONE

ExposurePercentage -> (float)

The percentage of the target audience exposed to treatments.

Constraints:

  • min: 0.0
  • max: 100.0

TreatmentOverrides -> (tagged union structure)

Treatment assignment overrides that assign specific entity IDs to treatments.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Inline.

Inline -> (map)

A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.

Constraints:

  • min: 0
  • max: 32

key -> (string)

Constraints:

  • min: 1
  • max: 2048

value -> (string)

Constraints:

  • pattern: ^[a-zA-Z0-9]{1,8}

Result -> (structure)

The result of the experiment run, including the executive summary and launch decision rationale.

ExecutiveSummary -> (string)

A summary of the experiment outcome and key findings.

Constraints:

  • min: 0
  • max: 1024

ReasonsToLaunch -> (string)

Evidence in favor of launching the winning treatment.

Constraints:

  • min: 0
  • max: 1024

ReasonsNotToLaunch -> (string)

Evidence against launching the treatment.

Constraints:

  • min: 0
  • max: 1024

StartedAt -> (timestamp)

The date and time the experiment run started, in ISO 8601 format.

UpdatedAt -> (timestamp)

The date and time the experiment run was last updated, in ISO 8601 format.

EndedAt -> (timestamp)

The date and time the experiment run ended, in ISO 8601 format.

ExperimentDefinitionSnapshot -> (structure)

A snapshot of the experiment definition at the time the run was started.

ApplicationId -> (string)

The application ID at the time the run was started.

Constraints:

  • pattern: [a-z0-9]{4,7}

Id -> (string)

The experiment definition ID.

Constraints:

  • pattern: [a-z0-9]{4,7}

Name -> (string)

The name of the experiment definition at the time the run was started.

Constraints:

  • min: 1
  • max: 64

Hypothesis -> (string)

The hypothesis at the time the run was started.

Constraints:

  • min: 0
  • max: 1024

ConfigurationProfileId -> (string)

The configuration profile ID at the time the run was started.

Constraints:

  • pattern: [a-z0-9]{4,7}

EnvironmentId -> (string)

The environment ID at the time the run was started.

Constraints:

  • pattern: [a-z0-9]{4,7}

FlagKey -> (string)

The feature flag key at the time the run was started.

Constraints:

  • pattern: ^[a-z][a-zA-Z0-9_-]{1,64}

AudienceRule -> (string)

The audience rule at the time the run was started.

Constraints:

  • min: 1
  • max: 16384

AudienceDescription -> (string)

The audience description at the time the run was started.

Constraints:

  • min: 0
  • max: 1024

LaunchCriteria -> (string)

The launch criteria at the time the run was started.

Constraints:

  • min: 0
  • max: 1024

Treatments -> (list)

The treatments at the time the run was started.

Constraints:

  • min: 1
  • max: 5

(structure)

Describes a treatment in an experiment, including its traffic allocation weight and feature flag value.

Key -> (string)

The unique key that identifies this treatment.

Constraints:

  • pattern: ^[a-zA-Z0-9]{1,8}

Weight -> (float) [required]

The traffic allocation weight for this treatment.

Constraints:

  • min: 0.0

Description -> (string)

A description of the treatment.

Constraints:

  • min: 0
  • max: 1024

FlagValue -> (structure) [required]

The feature flag value served to users assigned to this treatment.

Enabled -> (boolean) [required]

Whether the feature flag is enabled for this treatment.

AttributeValues -> (map)

The attribute values associated with this flag value.

Constraints:

  • min: 0
  • max: 25

key -> (string)

Constraints:

  • pattern: (?!enabled$)[a-z][a-zA-Z0-9_-]{0,63}

value -> (tagged union structure)

A value for a feature flag attribute. Only one of the members can be set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: StringValue, NumberValue, BooleanValue, StringArray, NumberArray.

StringValue -> (string)

A string value for the attribute.

Constraints:

  • min: 0
  • max: 1024

NumberValue -> (double)

A numeric value for the attribute.

BooleanValue -> (boolean)

A Boolean value for the attribute.

StringArray -> (list)

An array of string values for the attribute.

Constraints:

  • min: 0
  • max: 25

(string)

Constraints:

  • min: 0
  • max: 1024

NumberArray -> (list)

An array of numeric values for the attribute.

Constraints:

  • min: 0
  • max: 25

(double)

Control -> (structure)

The control treatment at the time the run was started.

Key -> (string)

The unique key that identifies this treatment.

Constraints:

  • pattern: ^[a-zA-Z0-9]{1,8}

Weight -> (float) [required]

The traffic allocation weight for this treatment.

Constraints:

  • min: 0.0

Description -> (string)

A description of the treatment.

Constraints:

  • min: 0
  • max: 1024

FlagValue -> (structure) [required]

The feature flag value served to users assigned to this treatment.

Enabled -> (boolean) [required]

Whether the feature flag is enabled for this treatment.

AttributeValues -> (map)

The attribute values associated with this flag value.

Constraints:

  • min: 0
  • max: 25

key -> (string)

Constraints:

  • pattern: (?!enabled$)[a-z][a-zA-Z0-9_-]{0,63}

value -> (tagged union structure)

A value for a feature flag attribute. Only one of the members can be set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: StringValue, NumberValue, BooleanValue, StringArray, NumberArray.

StringValue -> (string)

A string value for the attribute.

Constraints:

  • min: 0
  • max: 1024

NumberValue -> (double)

A numeric value for the attribute.

BooleanValue -> (boolean)

A Boolean value for the attribute.

StringArray -> (list)

An array of string values for the attribute.

Constraints:

  • min: 0
  • max: 25

(string)

Constraints:

  • min: 0
  • max: 1024

NumberArray -> (list)

An array of numeric values for the attribute.

Constraints:

  • min: 0
  • max: 25

(double)

© Copyright 2026, Amazon Web Services. Created using Sphinx.