GetConfigurationProfile - AWS AppConfig


Retrieves information about a configuration profile.

Request Syntax

GET /applications/ApplicationId/configurationprofiles/ConfigurationProfileId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The ID of the application that includes the configuration profile you want to get.

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

Required: Yes


The ID of the configuration profile that you want to get.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ApplicationId": "string", "Description": "string", "Id": "string", "LocationUri": "string", "Name": "string", "RetrievalRoleArn": "string", "Type": "string", "Validators": [ { "Content": "string", "Type": "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.


The application ID.

Type: String

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


The configuration profile description.

Type: String

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


The configuration profile ID.

Type: String

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


The URI location of the configuration.

Type: String

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


The name of the configuration profile.

Type: String

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


The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

Type: String

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

Pattern: ^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\d{12}:role[/].*)$


The type of configurations contained in the profile. AWS AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type:



Type: String

Pattern: ^[a-zA-Z\.]+


A list of methods for validating the configuration.

Type: Array of Validator objects

Array Members: Minimum number of 0 items. Maximum number of 2 items.


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


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

HTTP Status Code: 400


There was an internal failure in the AWS AppConfig service.

HTTP Status Code: 500


The requested resource could not be found.

HTTP Status Code: 404



This example illustrates one usage of GetConfigurationProfile.

Sample Request

GET /applications/abc1234/configurationprofiles/ur8hx2f HTTP/1.1 Host: Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/appconfig.get-configuration-profile X-Amz-Date: 20210917T221417Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE

Sample Response

{ "ApplicationId": "abc1234", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: