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.
get-experiment-definition¶
Synopsis¶
get-experiment-definition
--application-identifier <value>
--experiment-definition-identifier <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.
--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.
Id -> (string)
The experiment definition ID.
Name -> (string)
The name of the experiment definition.
Hypothesis -> (string)
The hypothesis that the experiment is designed to validate.
Status -> (string)
The current status of the experiment definition. Valid values:ACTIVE,IDLE,ARCHIVED.
ConfigurationProfileId -> (string)
The configuration profile ID associated with the experiment.
EnvironmentId -> (string)
The environment ID where the experiment runs.
FlagKey -> (string)
The key of the feature flag used by the experiment.
AudienceRule -> (string)
The rule that defines which users are eligible to be assigned to treatments.
AudienceDescription -> (string)
A description of the intended audience for the experiment.
LaunchCriteria -> (string)
The conditions under which the winning treatment should be launched.
Treatments -> (list)
The list of treatments defined for the experiment.
(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 used as the baseline for comparison.
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)
CreatedAt -> (timestamp)
The date and time the experiment definition was created, in ISO 8601 format.
UpdatedAt -> (timestamp)
The date and time the experiment definition was last updated, in ISO 8601 format.
KmsKeyIdentifier -> (string)
The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.