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

UpdateConfigurationProfile

Updates a configuration profile.

Request Syntax


PATCH /applications/ApplicationId/configurationprofiles/ConfigurationProfileId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "KmsKeyIdentifier": "string",
   "Name": "string",
   "RetrievalRoleArn": "string",
   "Validators": [ 
      { 
         "Content": "string",
         "Type": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

ApplicationId

The application ID.

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

Required: Yes

ConfigurationProfileId

The ID of the configuration profile.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

A description of the configuration profile.

Type: String

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

Required: No

KmsKeyIdentifier

The identifier for a AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. The identifier can be an AWS KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.

Type: String

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

Required: No

Name

The name of the configuration profile.

Type: String

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

Required: No

RetrievalRoleArn

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[/].*)$

Required: No

Validators

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.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Description": "string",
   "Id": "string",
   "KmsKeyArn": "string",
   "KmsKeyIdentifier": "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.

ApplicationId

The application ID.

Type: String

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

Description

The configuration profile description.

Type: String

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

Id

The configuration profile ID.

Type: String

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

KmsKeyArn

The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.

Type: String

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

Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+

KmsKeyIdentifier

The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

Type: String

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

LocationUri

The URI location of the configuration.

Type: String

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

Name

The name of the configuration profile.

Type: String

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

RetrievalRoleArn

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[/].*)$

Type

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:

AWS.AppConfig.FeatureFlags

AWS.Freeform

Type: String

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

Validators

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.

Errors

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

BadRequestException

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

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

Sample Request


PATCH /applications/abc1234/configurationprofiles/ur8hx2f HTTP/1.1
Host: appconfig.us-east-1.amazonaws.com
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.update-configuration-profile
X-Amz-Date: 20210920T213335Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 59

{
    "Description": "Configuration profile used for examples."
}

Sample Response


{
    "ApplicationId": "abc1234",
    "Id": "ur8hx2f",
    "Name": "Example-Configuration-Profile",
    "Description": "Configuration profile used for examples.",
    "LocationUri": "ssm-parameter://Example-Parameter",
    "RetrievalRoleArn": "arn:aws:iam::682428703967:role/Example-App-Config-Role"
}