Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . appconfig ]

get-experiment-run

Description

Retrieves information about an experiment run, including its status, start time, and exposure settings.

See also: AWS API Documentation

Synopsis

  get-experiment-run
--application-identifier <value>
--experiment-definition-identifier <value>
--run <value>
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--application-identifier (string)

The application ID or name.

--experiment-definition-identifier (string)

The experiment definition ID or name.

--run (integer)

The run number to retrieve.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

ApplicationId -> (string)

The application ID.

ExperimentDefinitionId -> (string)

The experiment definition ID.

Run -> (integer)

The experiment run number.

Description -> (string)

A description of the experiment run.

Status -> (string)

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

ExposurePercentage -> (float)

The percentage of the target audience exposed to treatments.

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.

key -> (string)

value -> (string)

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.

ReasonsToLaunch -> (string)

Evidence in favor of launching the winning treatment.

ReasonsNotToLaunch -> (string)

Evidence against launching the treatment.

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.

Id -> (string)

The experiment definition ID.

Name -> (string)

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

Hypothesis -> (string)

The hypothesis at the time the run was started.

ConfigurationProfileId -> (string)

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

EnvironmentId -> (string)

The environment ID at the time the run was started.

FlagKey -> (string)

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

AudienceRule -> (string)

The audience rule at the time the run was started.

AudienceDescription -> (string)

The audience description at the time the run was started.

LaunchCriteria -> (string)

The launch criteria at the time the run was started.

Treatments -> (list)

The treatments at the time the run was started.

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

Weight -> (float)

The traffic allocation weight for this treatment.

Description -> (string)

A description of the treatment.

FlagValue -> (structure)

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

Enabled -> (boolean)

Specifies whether the feature flag is enabled for this treatment.

AttributeValues -> (map)

The attribute values associated with this flag value.

key -> (string)

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.

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.

(string)

NumberArray -> (list)

An array of numeric values for the attribute.

(double)

Control -> (structure)

The control treatment at the time the run was started.

Key -> (string)

The unique key that identifies this treatment.

Weight -> (float)

The traffic allocation weight for this treatment.

Description -> (string)

A description of the treatment.

FlagValue -> (structure)

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

Enabled -> (boolean)

Specifies whether the feature flag is enabled for this treatment.

AttributeValues -> (map)

The attribute values associated with this flag value.

key -> (string)

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.

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.

(string)

NumberArray -> (list)

An array of numeric values for the attribute.

(double)