Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

GetExperimentDefinition

Retrieves information about an experiment definition.

Request Syntax


GET /applications/ApplicationIdentifier/experimentdefinitions/ExperimentDefinitionIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationIdentifier

The application ID or name.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

ExperimentDefinitionIdentifier

The experiment definition ID or name.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "AudienceDescription": "string",
   "AudienceRule": "string",
   "ConfigurationProfileId": "string",
   "Control": { 
      "Description": "string",
      "FlagValue": { 
         "AttributeValues": { 
            "string" : { ... }
         },
         "Enabled": boolean
      },
      "Key": "string",
      "Weight": number
   },
   "CreatedAt": "string",
   "EnvironmentId": "string",
   "FlagKey": "string",
   "Hypothesis": "string",
   "Id": "string",
   "KmsKeyIdentifier": "string",
   "LaunchCriteria": "string",
   "Name": "string",
   "Status": "string",
   "Treatments": [ 
      { 
         "Description": "string",
         "FlagValue": { 
            "AttributeValues": { 
               "string" : { ... }
            },
            "Enabled": boolean
         },
         "Key": "string",
         "Weight": number
      }
   ],
   "UpdatedAt": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApplicationId

The application ID.

Type: String

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

AudienceDescription

A description of the intended audience for the experiment.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

AudienceRule

The rule that defines which users are eligible to be assigned to treatments.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 16384.

ConfigurationProfileId

The configuration profile ID associated with the experiment.

Type: String

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

Control

The control treatment used as the baseline for comparison.

Type: Treatment object

CreatedAt

The date and time the experiment definition was created, in ISO 8601 format.

Type: Timestamp

EnvironmentId

The environment ID where the experiment runs.

Type: String

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

FlagKey

The key of the feature flag used by the experiment.

Type: String

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

Hypothesis

The hypothesis that the experiment is designed to validate.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Id

The experiment definition ID.

Type: String

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

KmsKeyIdentifier

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt experiment data.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

LaunchCriteria

The conditions under which the winning treatment should be launched.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Name

The name of the experiment definition.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Status

The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED.

Type: String

Valid Values: ACTIVE | IDLE | ARCHIVED

Treatments

The list of treatments defined for the experiment.

Type: Array of Treatment objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

UpdatedAt

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Error Types.

BadRequestException

The input fails to satisfy the constraints specified by an AWS service.

Details: Detailed information about the input that failed to satisfy the constraints specified by a call.

HTTP Status Code: 400

InternalServerException

There was an internal failure in the AWS AppConfig service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of GetExperimentDefinition.

Sample Request


GET /applications/abc1234/experimentdefinitions/bsxyd7k HTTP/1.1
Host: appconfig.us-east-1.amazonaws.com
User-Agent: aws-cli
X-Amz-Date: 20210916T175455Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE

Sample Response


{
	"ApplicationId": "abc1234",
	"AudienceRule": "(eq $country \"US\")",
	"ConfigurationProfileId": "ur8hx2f",
	"Control": {
		"FlagValue": {
			"Enabled": false
		},
		"Key": "c",
		"Weight": 50.0
	},
	"CreatedAt": "2026-06-16T17:54:55.847Z",
	"EnvironmentId": "env1234",
	"FlagKey": "my-feature-flag",
	"Id": "bsxyd7k",
	"Name": "Example-Experiment-Definition",
	"Status": "IDLE",
	"Treatments": [
		{
			"FlagValue": {
				"Enabled": true
			},
			"Key": "t1",
			"Weight": 50.0
		}
	],
	"UpdatedAt": "2026-06-16T17:57:36Z"
}