2026/06/29 - Amazon AppConfig - 11 new 4 updated api methods
Changes AWS AppConfig introduces Experimentation tools - enhanced capabilities within AWS AppConfig that enable you to run AB tests, multivariate tests, and gradual feature rollouts across your application stack.
Stops a running experiment. Stopping an experiment run ends audience exposure and returns users to the currently deployed feature flag configuration.
See also: AWS API Documentation
Request Syntax
client.stop_experiment_run(
ApplicationIdentifier='string',
ExperimentDefinitionIdentifier='string',
Run=123,
Result={
'ExecutiveSummary': 'string',
'ReasonsToLaunch': 'string',
'ReasonsNotToLaunch': 'string'
},
DeploymentParameters={
'DynamicExtensionParameters': {
'string': 'string'
},
'Tags': {
'string': 'string'
}
}
)
string
[REQUIRED]
The application ID or name.
string
[REQUIRED]
The experiment definition ID or name.
integer
[REQUIRED]
The run number to stop.
dict
The result of the experiment run, including an executive summary and reasons for or against launching.
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.
dict
Optional deployment parameters for the stop operation.
DynamicExtensionParameters (dict) --
A map of extension parameters for the deployment.
(string) --
(string) --
Tags (dict) --
The tags to assign to the deployment.
(string) --
(string) --
dict
Response Syntax
{
'ApplicationId': 'string',
'ExperimentDefinitionId': 'string',
'Run': 123,
'Description': 'string',
'Status': 'RUNNING'|'DONE',
'ExposurePercentage': ...,
'TreatmentOverrides': {
'Inline': {
'string': 'string'
}
},
'Result': {
'ExecutiveSummary': 'string',
'ReasonsToLaunch': 'string',
'ReasonsNotToLaunch': 'string'
},
'StartedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1),
'ExperimentDefinitionSnapshot': {
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Hypothesis': 'string',
'ConfigurationProfileId': 'string',
'EnvironmentId': 'string',
'FlagKey': 'string',
'AudienceRule': 'string',
'AudienceDescription': 'string',
'LaunchCriteria': 'string',
'Treatments': [
{
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
],
'Control': {
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
}
}
}
Response Structure
(dict) --
Describes an experiment run, including its status, exposure settings, and treatment overrides.
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 (dict) --
Treatment assignment overrides that assign specific entity IDs to treatments.
Inline (dict) --
A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.
(string) --
(string) --
Result (dict) --
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 (datetime) --
The date and time the experiment run started, in ISO 8601 format.
UpdatedAt (datetime) --
The date and time the experiment run was last updated, in ISO 8601 format.
EndedAt (datetime) --
The date and time the experiment run ended, in ISO 8601 format.
ExperimentDefinitionSnapshot (dict) --
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.
(dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
Control (dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
Retrieves information about an experiment run, including its status, start time, and exposure settings.
See also: AWS API Documentation
Request Syntax
client.get_experiment_run(
ApplicationIdentifier='string',
ExperimentDefinitionIdentifier='string',
Run=123
)
string
[REQUIRED]
The application ID or name.
string
[REQUIRED]
The experiment definition ID or name.
integer
[REQUIRED]
The run number to retrieve.
dict
Response Syntax
{
'ApplicationId': 'string',
'ExperimentDefinitionId': 'string',
'Run': 123,
'Description': 'string',
'Status': 'RUNNING'|'DONE',
'ExposurePercentage': ...,
'TreatmentOverrides': {
'Inline': {
'string': 'string'
}
},
'Result': {
'ExecutiveSummary': 'string',
'ReasonsToLaunch': 'string',
'ReasonsNotToLaunch': 'string'
},
'StartedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1),
'ExperimentDefinitionSnapshot': {
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Hypothesis': 'string',
'ConfigurationProfileId': 'string',
'EnvironmentId': 'string',
'FlagKey': 'string',
'AudienceRule': 'string',
'AudienceDescription': 'string',
'LaunchCriteria': 'string',
'Treatments': [
{
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
],
'Control': {
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
}
}
}
Response Structure
(dict) --
Describes an experiment run, including its status, exposure settings, and treatment overrides.
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 (dict) --
Treatment assignment overrides that assign specific entity IDs to treatments.
Inline (dict) --
A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.
(string) --
(string) --
Result (dict) --
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 (datetime) --
The date and time the experiment run started, in ISO 8601 format.
UpdatedAt (datetime) --
The date and time the experiment run was last updated, in ISO 8601 format.
EndedAt (datetime) --
The date and time the experiment run ended, in ISO 8601 format.
ExperimentDefinitionSnapshot (dict) --
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.
(dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
Control (dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
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
Request Syntax
client.update_experiment_run(
ApplicationIdentifier='string',
ExperimentDefinitionIdentifier='string',
Run=123,
Description='string',
ExposurePercentage=...,
TreatmentOverrides={
'Inline': {
'string': 'string'
}
},
DeploymentParameters={
'DynamicExtensionParameters': {
'string': 'string'
},
'Tags': {
'string': 'string'
}
}
)
string
[REQUIRED]
The application ID or name.
string
[REQUIRED]
The experiment definition ID or name.
integer
[REQUIRED]
The run number to update.
string
An updated description for the experiment run.
float
The new exposure percentage. This value can only be increased from the current setting.
dict
Updated treatment assignment overrides.
Inline (dict) --
A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.
(string) --
(string) --
dict
Updated deployment parameters.
DynamicExtensionParameters (dict) --
A map of extension parameters for the deployment.
(string) --
(string) --
Tags (dict) --
The tags to assign to the deployment.
(string) --
(string) --
dict
Response Syntax
{
'ApplicationId': 'string',
'ExperimentDefinitionId': 'string',
'Run': 123,
'Description': 'string',
'Status': 'RUNNING'|'DONE',
'ExposurePercentage': ...,
'TreatmentOverrides': {
'Inline': {
'string': 'string'
}
},
'Result': {
'ExecutiveSummary': 'string',
'ReasonsToLaunch': 'string',
'ReasonsNotToLaunch': 'string'
},
'StartedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1),
'ExperimentDefinitionSnapshot': {
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Hypothesis': 'string',
'ConfigurationProfileId': 'string',
'EnvironmentId': 'string',
'FlagKey': 'string',
'AudienceRule': 'string',
'AudienceDescription': 'string',
'LaunchCriteria': 'string',
'Treatments': [
{
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
],
'Control': {
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
}
}
}
Response Structure
(dict) --
Describes an experiment run, including its status, exposure settings, and treatment overrides.
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 (dict) --
Treatment assignment overrides that assign specific entity IDs to treatments.
Inline (dict) --
A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.
(string) --
(string) --
Result (dict) --
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 (datetime) --
The date and time the experiment run started, in ISO 8601 format.
UpdatedAt (datetime) --
The date and time the experiment run was last updated, in ISO 8601 format.
EndedAt (datetime) --
The date and time the experiment run ended, in ISO 8601 format.
ExperimentDefinitionSnapshot (dict) --
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.
(dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
Control (dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
Deletes an experiment definition. You can archive the definition to hide it from the active list while preserving it for future reference, or permanently delete it along with all associated run history.
See also: AWS API Documentation
Request Syntax
client.delete_experiment_definition(
ApplicationIdentifier='string',
ExperimentDefinitionIdentifier='string',
DeleteType='ARCHIVE'|'DESTROY'
)
string
[REQUIRED]
The application ID or name.
string
[REQUIRED]
The experiment definition ID or name.
string
The type of deletion to perform. Valid values include archive (hide but preserve) and permanent (delete permanently).
None
Creates an experiment definition in AppConfig. An experiment definition describes the purpose, scope, and operational configuration of an experiment, including the target audience, feature flag, and treatment configurations.
See also: AWS API Documentation
Request Syntax
client.create_experiment_definition(
ApplicationIdentifier='string',
Name='string',
ConfigurationProfileIdentifier='string',
EnvironmentIdentifier='string',
FlagKey='string',
Treatments=[
{
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
],
Control={
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
AudienceRule='string',
Hypothesis='string',
AudienceDescription='string',
LaunchCriteria='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The application ID or name.
string
[REQUIRED]
A name for the experiment definition.
string
[REQUIRED]
The configuration profile ID or name that stores the feature flag.
string
[REQUIRED]
The environment ID or name where the experiment will run.
string
[REQUIRED]
The key of the existing feature flag to use with the experiment.
list
[REQUIRED]
A list of treatments to evaluate during the experiment. Each treatment defines a distinct variation compared to the control.
(dict) --
Input structure for defining a treatment when creating or updating an experiment definition.
Weight (float) -- [REQUIRED]
The traffic allocation weight for this treatment.
Description (string) --
A description of the treatment.
FlagValue (dict) -- [REQUIRED]
The feature flag value to serve to users assigned to this treatment.
Enabled (boolean) -- [REQUIRED]
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
dict
[REQUIRED]
The control treatment that represents the baseline experience for comparison.
Weight (float) -- [REQUIRED]
The traffic allocation weight for this treatment.
Description (string) --
A description of the treatment.
FlagValue (dict) -- [REQUIRED]
The feature flag value to serve to users assigned to this treatment.
Enabled (boolean) -- [REQUIRED]
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
string
[REQUIRED]
A rule that defines which users are eligible to be assigned to treatments during the experiment.
string
A description of the goal or hypothesis the experiment is designed to validate.
string
A description of the intended audience for the experiment.
string
Information about the conditions under which you would launch the winning treatment.
dict
The tags to assign to the experiment definition. Tags help organize and categorize your AppConfig resources.
(string) --
(string) --
dict
Response Syntax
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Hypothesis': 'string',
'Status': 'ACTIVE'|'IDLE'|'ARCHIVED',
'ConfigurationProfileId': 'string',
'EnvironmentId': 'string',
'FlagKey': 'string',
'AudienceRule': 'string',
'AudienceDescription': 'string',
'LaunchCriteria': 'string',
'Treatments': [
{
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
],
'Control': {
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'KmsKeyIdentifier': 'string'
}
Response Structure
(dict) --
Describes an experiment definition, including the target audience, feature flag, treatments, and current status.
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.
(dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
Control (dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
CreatedAt (datetime) --
The date and time the experiment definition was created, in ISO 8601 format.
UpdatedAt (datetime) --
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.
Lists the experiment runs for a specified experiment definition. You can filter by status.
See also: AWS API Documentation
Request Syntax
client.list_experiment_runs(
ApplicationIdentifier='string',
ExperimentDefinitionIdentifier='string',
MaxResults=123,
NextToken='string',
Status='RUNNING'|'DONE'
)
string
[REQUIRED]
The application ID or name.
string
[REQUIRED]
The experiment definition ID or name.
integer
The maximum number of items to return.
string
A token to start the list from a previously truncated response.
string
A filter for the experiment run status.
dict
Response Syntax
{
'Items': [
{
'ExperimentDefinitionId': 'string',
'Run': 123,
'Description': 'string',
'Status': 'RUNNING'|'DONE',
'StartedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response for a list experiment runs request.
Items (list) --
The list of experiment runs.
(dict) --
Summary information about an experiment run.
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.
StartedAt (datetime) --
The date and time the experiment run started, in ISO 8601 format.
UpdatedAt (datetime) --
The date and time the experiment run was last updated, in ISO 8601 format.
EndedAt (datetime) --
The date and time the experiment run ended, in ISO 8601 format.
NextToken (string) --
A token to use for the next set of results.
Lists the events for a specified experiment run. Events provide a timeline of actions and state changes that occurred during the run.
See also: AWS API Documentation
Request Syntax
client.list_experiment_run_events(
ApplicationIdentifier='string',
ExperimentDefinitionIdentifier='string',
Run=123,
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The application ID or name.
string
[REQUIRED]
The experiment definition ID or name.
integer
[REQUIRED]
The run number.
integer
The maximum number of items to return.
string
A token to start the list from a previously truncated response.
dict
Response Syntax
{
'Items': [
{
'Description': 'string',
'AssociatedDeployment': 'string',
'EventType': 'RUN_STARTED'|'EXPOSURE_UPDATED'|'OVERRIDES_UPDATED'|'RUN_STOPPED',
'OccurredAt': datetime(2015, 1, 1),
'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
'ExposurePercentage': ...,
'TreatmentOverrides': {
'Inline': {
'string': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response for a list experiment run events request.
Items (list) --
The list of experiment run events.
(dict) --
Describes an event that occurred during an experiment run.
Description (string) --
A description of the event.
AssociatedDeployment (string) --
The Amazon Resource Name (ARN) of the deployment associated with this event.
EventType (string) --
The type of event. Valid values: RUN_STARTED, EXPOSURE_UPDATED, OVERRIDES_UPDATED, RUN_STOPPED.
OccurredAt (datetime) --
The date and time the event occurred, in ISO 8601 format.
TriggeredBy (string) --
The principal that triggered the event.
ExposurePercentage (float) --
The exposure percentage at the time of the event.
TreatmentOverrides (dict) --
The treatment overrides at the time of the event.
Inline (dict) --
A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.
(string) --
(string) --
NextToken (string) --
A token to use for the next set of results.
Lists the experiment definitions for an account. You can filter results by application, configuration profile, environment, or status.
See also: AWS API Documentation
Request Syntax
client.list_experiment_definitions(
ApplicationIdentifier='string',
ConfigurationProfileIdentifier='string',
EnvironmentIdentifier='string',
Status='ACTIVE'|'IDLE'|'ARCHIVED',
MaxResults=123,
NextToken='string'
)
string
The application ID or name to filter results.
string
The configuration profile ID or name to filter results.
string
The environment ID or name to filter results.
string
A filter for the experiment definition status.
integer
The maximum number of items to return for this call.
string
A token to start the list from a previously truncated response.
dict
Response Syntax
{
'Items': [
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Hypothesis': 'string',
'Status': 'ACTIVE'|'IDLE'|'ARCHIVED',
'ConfigurationProfileId': 'string',
'EnvironmentId': 'string',
'FlagKey': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response for a list experiment definitions request.
Items (list) --
The list of experiment definitions.
(dict) --
Summary information about an experiment definition.
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.
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.
CreatedAt (datetime) --
The date and time the experiment definition was created, in ISO 8601 format.
UpdatedAt (datetime) --
The date and time the experiment definition was last updated, in ISO 8601 format.
NextToken (string) --
A token to use for the next set of results.
Starts an experiment run for the specified experiment definition. An experiment run delivers treatments to the target audience and collects metrics. You can start multiple experiment runs from the same experiment definition.
See also: AWS API Documentation
Request Syntax
client.start_experiment_run(
ApplicationIdentifier='string',
ExperimentDefinitionIdentifier='string',
Description='string',
ExposurePercentage=...,
TreatmentOverrides={
'Inline': {
'string': 'string'
}
},
Tags={
'string': 'string'
},
DeploymentParameters={
'DynamicExtensionParameters': {
'string': 'string'
},
'Tags': {
'string': 'string'
}
}
)
string
[REQUIRED]
The application ID or name.
string
[REQUIRED]
The experiment definition ID or name.
string
A description of this experiment run.
float
The percentage of the target audience to expose to treatments. Set to 0 to validate the experiment before exposing production users.
dict
Treatment assignment overrides that assign specific entity IDs to treatments directly, bypassing random assignment.
Inline (dict) --
A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.
(string) --
(string) --
dict
The tags to assign to the experiment run.
(string) --
(string) --
dict
Optional deployment parameters including a KMS key for encryption.
DynamicExtensionParameters (dict) --
A map of extension parameters for the deployment.
(string) --
(string) --
Tags (dict) --
The tags to assign to the deployment.
(string) --
(string) --
dict
Response Syntax
{
'ApplicationId': 'string',
'ExperimentDefinitionId': 'string',
'Run': 123,
'Description': 'string',
'Status': 'RUNNING'|'DONE',
'ExposurePercentage': ...,
'TreatmentOverrides': {
'Inline': {
'string': 'string'
}
},
'Result': {
'ExecutiveSummary': 'string',
'ReasonsToLaunch': 'string',
'ReasonsNotToLaunch': 'string'
},
'StartedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1),
'ExperimentDefinitionSnapshot': {
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Hypothesis': 'string',
'ConfigurationProfileId': 'string',
'EnvironmentId': 'string',
'FlagKey': 'string',
'AudienceRule': 'string',
'AudienceDescription': 'string',
'LaunchCriteria': 'string',
'Treatments': [
{
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
],
'Control': {
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
}
}
}
Response Structure
(dict) --
Describes an experiment run, including its status, exposure settings, and treatment overrides.
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 (dict) --
Treatment assignment overrides that assign specific entity IDs to treatments.
Inline (dict) --
A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.
(string) --
(string) --
Result (dict) --
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 (datetime) --
The date and time the experiment run started, in ISO 8601 format.
UpdatedAt (datetime) --
The date and time the experiment run was last updated, in ISO 8601 format.
EndedAt (datetime) --
The date and time the experiment run ended, in ISO 8601 format.
ExperimentDefinitionSnapshot (dict) --
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.
(dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
Control (dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
Retrieves information about an experiment definition.
See also: AWS API Documentation
Request Syntax
client.get_experiment_definition(
ApplicationIdentifier='string',
ExperimentDefinitionIdentifier='string'
)
string
[REQUIRED]
The application ID or name.
string
[REQUIRED]
The experiment definition ID or name.
dict
Response Syntax
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Hypothesis': 'string',
'Status': 'ACTIVE'|'IDLE'|'ARCHIVED',
'ConfigurationProfileId': 'string',
'EnvironmentId': 'string',
'FlagKey': 'string',
'AudienceRule': 'string',
'AudienceDescription': 'string',
'LaunchCriteria': 'string',
'Treatments': [
{
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
],
'Control': {
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'KmsKeyIdentifier': 'string'
}
Response Structure
(dict) --
Describes an experiment definition, including the target audience, feature flag, treatments, and current status.
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.
(dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
Control (dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
CreatedAt (datetime) --
The date and time the experiment definition was created, in ISO 8601 format.
UpdatedAt (datetime) --
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.
Updates an experiment definition. You can update treatments, the control, audience rules, and other properties. You cannot update an experiment definition while an experiment run is active.
See also: AWS API Documentation
Request Syntax
client.update_experiment_definition(
ApplicationIdentifier='string',
ExperimentDefinitionIdentifier='string',
Treatments=[
{
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
],
Control={
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
Hypothesis='string',
AudienceRule='string',
AudienceDescription='string',
LaunchCriteria='string'
)
string
[REQUIRED]
The application ID or name.
string
[REQUIRED]
The experiment definition ID or name.
list
An updated list of treatments.
(dict) --
Input structure for defining a treatment when creating or updating an experiment definition.
Weight (float) -- [REQUIRED]
The traffic allocation weight for this treatment.
Description (string) --
A description of the treatment.
FlagValue (dict) -- [REQUIRED]
The feature flag value to serve to users assigned to this treatment.
Enabled (boolean) -- [REQUIRED]
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
dict
An updated control treatment.
Weight (float) -- [REQUIRED]
The traffic allocation weight for this treatment.
Description (string) --
A description of the treatment.
FlagValue (dict) -- [REQUIRED]
The feature flag value to serve to users assigned to this treatment.
Enabled (boolean) -- [REQUIRED]
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
string
An updated hypothesis.
string
An updated audience rule.
string
An updated audience description.
string
Updated launch criteria.
dict
Response Syntax
{
'ApplicationId': 'string',
'Id': 'string',
'Name': 'string',
'Hypothesis': 'string',
'Status': 'ACTIVE'|'IDLE'|'ARCHIVED',
'ConfigurationProfileId': 'string',
'EnvironmentId': 'string',
'FlagKey': 'string',
'AudienceRule': 'string',
'AudienceDescription': 'string',
'LaunchCriteria': 'string',
'Treatments': [
{
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
],
'Control': {
'Key': 'string',
'Weight': ...,
'Description': 'string',
'FlagValue': {
'Enabled': True|False,
'AttributeValues': {
'string': {
'StringValue': 'string',
'NumberValue': 123.0,
'BooleanValue': True|False,
'StringArray': [
'string',
],
'NumberArray': [
123.0,
]
}
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'KmsKeyIdentifier': 'string'
}
Response Structure
(dict) --
Describes an experiment definition, including the target audience, feature flag, treatments, and current status.
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.
(dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
Control (dict) --
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 (dict) --
The feature flag value served to users assigned to this treatment.
Enabled (boolean) --
Whether the feature flag is enabled for this treatment.
AttributeValues (dict) --
The attribute values associated with this flag value.
(string) --
(dict) --
A value for a feature flag attribute. Only one of the members can be set.
StringValue (string) --
A string value for the attribute.
NumberValue (float) --
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.
(float) --
CreatedAt (datetime) --
The date and time the experiment definition was created, in ISO 8601 format.
UpdatedAt (datetime) --
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.
{'VendedMetrics': {'Enabled': 'boolean'}}
Returns information about the status of the DeletionProtection parameter.
See also: AWS API Documentation
Request Syntax
client.get_account_settings()
dict
Response Syntax
{
'DeletionProtection': {
'Enabled': True|False,
'ProtectionPeriodInMinutes': 123
},
'VendedMetrics': {
'Enabled': True|False
}
}
Response Structure
(dict) --
DeletionProtection (dict) --
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for ProtectionPeriodInMinutes is 60.
Enabled (boolean) --
A parameter that indicates if deletion protection is enabled or not.
ProtectionPeriodInMinutes (integer) --
The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either or .
VendedMetrics (dict) --
Configuration for vended metrics in the account.
Enabled (boolean) --
Whether vended metrics are enabled for the account.
{'Items': {'ConfigurationProfileId': 'string', 'Type': 'USER | MANAGED'}}
Lists the deployments for an environment in descending deployment number order.
See also: AWS API Documentation
Request Syntax
client.list_deployments(
ApplicationId='string',
EnvironmentId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
The environment ID.
integer
The maximum number of items that may be returned for this call. If there are items that have not yet been returned, the response will include a non-null NextToken that you can provide in a subsequent call to get the next set of results.
string
The token returned by a prior call to this operation indicating the next set of results to be returned. If not specified, the operation will return the first set of results.
dict
Response Syntax
{
'Items': [
{
'DeploymentNumber': 123,
'ConfigurationProfileId': 'string',
'ConfigurationName': 'string',
'ConfigurationVersion': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED',
'PercentageComplete': ...,
'StartedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1),
'VersionLabel': 'string',
'Type': 'USER'|'MANAGED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The elements from this collection.
(dict) --
Information about the deployment.
DeploymentNumber (integer) --
The sequence number of the deployment.
ConfigurationProfileId (string) --
The ID of the configuration profile that was deployed.
ConfigurationName (string) --
The name of the configuration.
ConfigurationVersion (string) --
The version of the configuration.
DeploymentDurationInMinutes (integer) --
Total amount of time the deployment lasted.
GrowthType (string) --
The algorithm used to define how percentage grows over time.
GrowthFactor (float) --
The percentage of targets to receive a deployed configuration during each interval.
FinalBakeTimeInMinutes (integer) --
The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
State (string) --
The state of the deployment.
PercentageComplete (float) --
The percentage of targets for which the deployment is available.
StartedAt (datetime) --
Time the deployment started.
CompletedAt (datetime) --
Time the deployment completed.
VersionLabel (string) --
A user-defined label for an AppConfig hosted configuration version.
Type (string) --
The type of deployment.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
{'LatestDeploymentNumber': 'integer'}
Starts a deployment.
See also: AWS API Documentation
Request Syntax
client.start_deployment(
ApplicationId='string',
EnvironmentId='string',
DeploymentStrategyId='string',
ConfigurationProfileId='string',
ConfigurationVersion='string',
Description='string',
Tags={
'string': 'string'
},
KmsKeyIdentifier='string',
DynamicExtensionParameters={
'string': 'string'
},
LatestDeploymentNumber=123
)
string
[REQUIRED]
The application ID.
string
[REQUIRED]
The environment ID.
string
[REQUIRED]
The deployment strategy ID.
string
[REQUIRED]
The configuration profile ID.
string
[REQUIRED]
The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.
string
A description of the deployment.
dict
Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
(string) --
(string) --
string
The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
dict
A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.
(string) --
(string) --
integer
The number of the latest deployment. Use this value to ensure that the deployment starts from the expected state and to prevent conflicting updates.
dict
Response Syntax
{
'ApplicationId': 'string',
'EnvironmentId': 'string',
'DeploymentStrategyId': 'string',
'ConfigurationProfileId': 'string',
'DeploymentNumber': 123,
'ConfigurationName': 'string',
'ConfigurationLocationUri': 'string',
'ConfigurationVersion': 'string',
'Description': 'string',
'DeploymentDurationInMinutes': 123,
'GrowthType': 'LINEAR'|'EXPONENTIAL',
'GrowthFactor': ...,
'FinalBakeTimeInMinutes': 123,
'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK'|'REVERTED',
'EventLog': [
{
'EventType': 'PERCENTAGE_UPDATED'|'ROLLBACK_STARTED'|'ROLLBACK_COMPLETED'|'BAKE_TIME_STARTED'|'DEPLOYMENT_STARTED'|'DEPLOYMENT_COMPLETED'|'REVERT_COMPLETED',
'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
'Description': 'string',
'ActionInvocations': [
{
'ExtensionIdentifier': 'string',
'ActionName': 'string',
'Uri': 'string',
'RoleArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'InvocationId': 'string'
},
],
'OccurredAt': datetime(2015, 1, 1)
},
],
'PercentageComplete': ...,
'StartedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1),
'AppliedExtensions': [
{
'ExtensionId': 'string',
'ExtensionAssociationId': 'string',
'VersionNumber': 123,
'Parameters': {
'string': 'string'
}
},
],
'KmsKeyArn': 'string',
'KmsKeyIdentifier': 'string',
'VersionLabel': 'string'
}
Response Structure
(dict) --
ApplicationId (string) --
The ID of the application that was deployed.
EnvironmentId (string) --
The ID of the environment that was deployed.
DeploymentStrategyId (string) --
The ID of the deployment strategy that was deployed.
ConfigurationProfileId (string) --
The ID of the configuration profile that was deployed.
DeploymentNumber (integer) --
The sequence number of the deployment.
ConfigurationName (string) --
The name of the configuration.
ConfigurationLocationUri (string) --
Information about the source location of the configuration.
ConfigurationVersion (string) --
The configuration version that was deployed.
Description (string) --
The description of the deployment.
DeploymentDurationInMinutes (integer) --
Total amount of time the deployment lasted.
GrowthType (string) --
The algorithm used to define how percentage grew over time.
GrowthFactor (float) --
The percentage of targets to receive a deployed configuration during each interval.
FinalBakeTimeInMinutes (integer) --
The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
State (string) --
The state of the deployment.
EventLog (list) --
A list containing all events related to a deployment. The most recent events are displayed first.
(dict) --
An object that describes a deployment event.
EventType (string) --
The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; and the start or completion of a rollback.
TriggeredBy (string) --
The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.
Description (string) --
A description of the deployment event. Descriptions include, but are not limited to, the following:
The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.
The percentage of hosts that received the deployment.
A recommendation to attempt a new deployment (in the case of an internal error).
ActionInvocations (list) --
The list of extensions that were invoked as part of the deployment.
(dict) --
An extension that was invoked as part of a deployment event.
ExtensionIdentifier (string) --
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
ActionName (string) --
The name of the action.
Uri (string) --
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
RoleArn (string) --
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
ErrorMessage (string) --
The error message when an extension invocation fails.
ErrorCode (string) --
The error code when an extension invocation fails.
InvocationId (string) --
A system-generated ID for this invocation.
OccurredAt (datetime) --
The date and time the event occurred.
PercentageComplete (float) --
The percentage of targets for which the deployment is available.
StartedAt (datetime) --
The time the deployment started.
CompletedAt (datetime) --
The time the deployment completed.
AppliedExtensions (list) --
A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.
(dict) --
An extension that was invoked during a deployment.
ExtensionId (string) --
The system-generated ID of the extension.
ExtensionAssociationId (string) --
The system-generated ID for the association.
VersionNumber (integer) --
The extension version number.
Parameters (dict) --
One or more parameters for the actions called by the extension.
(string) --
(string) --
KmsKeyArn (string) --
The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
KmsKeyIdentifier (string) --
The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
VersionLabel (string) --
A user-defined label for an AppConfig hosted configuration version.
{'VendedMetrics': {'Enabled': 'boolean'}}
Updates the value of the DeletionProtection parameter.
See also: AWS API Documentation
Request Syntax
client.update_account_settings(
DeletionProtection={
'Enabled': True|False,
'ProtectionPeriodInMinutes': 123
},
VendedMetrics={
'Enabled': True|False
}
)
dict
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for ProtectionPeriodInMinutes is 60.
Enabled (boolean) --
A parameter that indicates if deletion protection is enabled or not.
ProtectionPeriodInMinutes (integer) --
The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either or .
dict
Configuration for vended metrics in the account.
Enabled (boolean) --
Whether vended metrics are enabled for the account.
dict
Response Syntax
{
'DeletionProtection': {
'Enabled': True|False,
'ProtectionPeriodInMinutes': 123
},
'VendedMetrics': {
'Enabled': True|False
}
}
Response Structure
(dict) --
DeletionProtection (dict) --
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for ProtectionPeriodInMinutes is 60.
Enabled (boolean) --
A parameter that indicates if deletion protection is enabled or not.
ProtectionPeriodInMinutes (integer) --
The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either or .
VendedMetrics (dict) --
Configuration for vended metrics in the account.
Enabled (boolean) --
Whether vended metrics are enabled for the account.