

# Actions
<a name="API_Operations"></a>

The following actions are supported by AWS AppConfig:
+  [CreateApplication](API_CreateApplication.md) 
+  [CreateConfigurationProfile](API_CreateConfigurationProfile.md) 
+  [CreateDeploymentStrategy](API_CreateDeploymentStrategy.md) 
+  [CreateEnvironment](API_CreateEnvironment.md) 
+  [CreateExtension](API_CreateExtension.md) 
+  [CreateExtensionAssociation](API_CreateExtensionAssociation.md) 
+  [CreateHostedConfigurationVersion](API_CreateHostedConfigurationVersion.md) 
+  [DeleteApplication](API_DeleteApplication.md) 
+  [DeleteConfigurationProfile](API_DeleteConfigurationProfile.md) 
+  [DeleteDeploymentStrategy](API_DeleteDeploymentStrategy.md) 
+  [DeleteEnvironment](API_DeleteEnvironment.md) 
+  [DeleteExtension](API_DeleteExtension.md) 
+  [DeleteExtensionAssociation](API_DeleteExtensionAssociation.md) 
+  [DeleteHostedConfigurationVersion](API_DeleteHostedConfigurationVersion.md) 
+  [GetAccountSettings](API_GetAccountSettings.md) 
+  [GetApplication](API_GetApplication.md) 
+  [GetConfiguration](API_GetConfiguration.md) 
+  [GetConfigurationProfile](API_GetConfigurationProfile.md) 
+  [GetDeployment](API_GetDeployment.md) 
+  [GetDeploymentStrategy](API_GetDeploymentStrategy.md) 
+  [GetEnvironment](API_GetEnvironment.md) 
+  [GetExtension](API_GetExtension.md) 
+  [GetExtensionAssociation](API_GetExtensionAssociation.md) 
+  [GetHostedConfigurationVersion](API_GetHostedConfigurationVersion.md) 
+  [ListApplications](API_ListApplications.md) 
+  [ListConfigurationProfiles](API_ListConfigurationProfiles.md) 
+  [ListDeployments](API_ListDeployments.md) 
+  [ListDeploymentStrategies](API_ListDeploymentStrategies.md) 
+  [ListEnvironments](API_ListEnvironments.md) 
+  [ListExtensionAssociations](API_ListExtensionAssociations.md) 
+  [ListExtensions](API_ListExtensions.md) 
+  [ListHostedConfigurationVersions](API_ListHostedConfigurationVersions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [StartDeployment](API_StartDeployment.md) 
+  [StopDeployment](API_StopDeployment.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAccountSettings](API_UpdateAccountSettings.md) 
+  [UpdateApplication](API_UpdateApplication.md) 
+  [UpdateConfigurationProfile](API_UpdateConfigurationProfile.md) 
+  [UpdateDeploymentStrategy](API_UpdateDeploymentStrategy.md) 
+  [UpdateEnvironment](API_UpdateEnvironment.md) 
+  [UpdateExtension](API_UpdateExtension.md) 
+  [UpdateExtensionAssociation](API_UpdateExtensionAssociation.md) 
+  [ValidateConfiguration](API_ValidateConfiguration.md) 

The following actions are supported by AWS AppConfig Data:
+  [GetLatestConfiguration](API_appconfigdata_GetLatestConfiguration.md) 
+  [StartConfigurationSession](API_appconfigdata_StartConfigurationSession.md) 

# AWS AppConfig
<a name="API_Operations_Amazon_AppConfig"></a>

The following actions are supported by AWS AppConfig:
+  [CreateApplication](API_CreateApplication.md) 
+  [CreateConfigurationProfile](API_CreateConfigurationProfile.md) 
+  [CreateDeploymentStrategy](API_CreateDeploymentStrategy.md) 
+  [CreateEnvironment](API_CreateEnvironment.md) 
+  [CreateExtension](API_CreateExtension.md) 
+  [CreateExtensionAssociation](API_CreateExtensionAssociation.md) 
+  [CreateHostedConfigurationVersion](API_CreateHostedConfigurationVersion.md) 
+  [DeleteApplication](API_DeleteApplication.md) 
+  [DeleteConfigurationProfile](API_DeleteConfigurationProfile.md) 
+  [DeleteDeploymentStrategy](API_DeleteDeploymentStrategy.md) 
+  [DeleteEnvironment](API_DeleteEnvironment.md) 
+  [DeleteExtension](API_DeleteExtension.md) 
+  [DeleteExtensionAssociation](API_DeleteExtensionAssociation.md) 
+  [DeleteHostedConfigurationVersion](API_DeleteHostedConfigurationVersion.md) 
+  [GetAccountSettings](API_GetAccountSettings.md) 
+  [GetApplication](API_GetApplication.md) 
+  [GetConfiguration](API_GetConfiguration.md) 
+  [GetConfigurationProfile](API_GetConfigurationProfile.md) 
+  [GetDeployment](API_GetDeployment.md) 
+  [GetDeploymentStrategy](API_GetDeploymentStrategy.md) 
+  [GetEnvironment](API_GetEnvironment.md) 
+  [GetExtension](API_GetExtension.md) 
+  [GetExtensionAssociation](API_GetExtensionAssociation.md) 
+  [GetHostedConfigurationVersion](API_GetHostedConfigurationVersion.md) 
+  [ListApplications](API_ListApplications.md) 
+  [ListConfigurationProfiles](API_ListConfigurationProfiles.md) 
+  [ListDeployments](API_ListDeployments.md) 
+  [ListDeploymentStrategies](API_ListDeploymentStrategies.md) 
+  [ListEnvironments](API_ListEnvironments.md) 
+  [ListExtensionAssociations](API_ListExtensionAssociations.md) 
+  [ListExtensions](API_ListExtensions.md) 
+  [ListHostedConfigurationVersions](API_ListHostedConfigurationVersions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [StartDeployment](API_StartDeployment.md) 
+  [StopDeployment](API_StopDeployment.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAccountSettings](API_UpdateAccountSettings.md) 
+  [UpdateApplication](API_UpdateApplication.md) 
+  [UpdateConfigurationProfile](API_UpdateConfigurationProfile.md) 
+  [UpdateDeploymentStrategy](API_UpdateDeploymentStrategy.md) 
+  [UpdateEnvironment](API_UpdateEnvironment.md) 
+  [UpdateExtension](API_UpdateExtension.md) 
+  [UpdateExtensionAssociation](API_UpdateExtensionAssociation.md) 
+  [ValidateConfiguration](API_ValidateConfiguration.md) 

# CreateApplication
<a name="API_CreateApplication"></a>

Creates an application. In AWS AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.

## Request Syntax
<a name="API_CreateApplication_RequestSyntax"></a>

```
POST /applications HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateApplication_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateApplication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateApplication_RequestSyntax) **   <a name="appconfig-CreateApplication-request-Description"></a>
A description of the application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [Name](#API_CreateApplication_RequestSyntax) **   <a name="appconfig-CreateApplication-request-Name"></a>
A name for the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** [Tags](#API_CreateApplication_RequestSyntax) **   <a name="appconfig-CreateApplication-request-Tags"></a>
Metadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateApplication_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "Description": "string",
   "Id": "string",
   "Name": "string"
}
```

## Response Elements
<a name="API_CreateApplication_ResponseElements"></a>

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

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

 ** [Description](#API_CreateApplication_ResponseSyntax) **   <a name="appconfig-CreateApplication-response-Description"></a>
The description of the application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_CreateApplication_ResponseSyntax) **   <a name="appconfig-CreateApplication-response-Id"></a>
The application ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Name](#API_CreateApplication_ResponseSyntax) **   <a name="appconfig-CreateApplication-response-Name"></a>
The application name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Errors
<a name="API_CreateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ServiceQuotaExceededException **   
The number of one more AWS AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:  
Applications: 100 max  
Deployment strategies: 20 max  
Configuration profiles: 100 max per application  
Environments: 20 max per application  
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see [Service quotas for AWS AppConfig](https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig) in the Amazon Web Services General Reference.  
HTTP Status Code: 402

## Examples
<a name="API_CreateApplication_Examples"></a>

### Example
<a name="API_CreateApplication_Example_1"></a>

This example illustrates one usage of CreateApplication.

#### Sample Request
<a name="API_CreateApplication_Example_1_Request"></a>

```
POST /applications 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.create-application
X-Amz-Date: 20210916T175455Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 91

{
	"Name": "test-application", 
	"Description": "An application used for creating an example."
}
```

#### Sample Response
<a name="API_CreateApplication_Example_1_Response"></a>

```
{
	"Description": "An application used for creating an example.",
	"Id": "abc1234",
	"Name": "test-application"
}
```

## See Also
<a name="API_CreateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/CreateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/CreateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/CreateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/CreateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/CreateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/CreateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/CreateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/CreateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/CreateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/CreateApplication) 

# CreateConfigurationProfile
<a name="API_CreateConfigurationProfile"></a>

Creates a configuration profile, which is information that enables AWS AppConfig to access the configuration source. Valid configuration sources include the following:
+ Configuration data in YAML, JSON, and other formats stored in the AWS AppConfig hosted configuration store
+ Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket
+ Pipelines stored in AWS CodePipeline 
+ Secrets stored in AWS Secrets Manager 
+ Standard and secure string parameters stored in AWS Systems Manager Parameter Store
+ Configuration data in SSM documents stored in the Systems Manager document store

A configuration profile includes the following information:
+ The URI location of the configuration data.
+ The AWS Identity and Access Management (IAM) role that provides access to the configuration data.
+ A validator for the configuration data. Available validators include either a JSON Schema or an AWS Lambda function.

For more information, see [Create a Configuration and a Configuration Profile](http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) in the * AWS AppConfig User Guide*.

## Request Syntax
<a name="API_CreateConfigurationProfile_RequestSyntax"></a>

```
POST /applications/ApplicationId/configurationprofiles HTTP/1.1
Content-type: application/json

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

## URI Request Parameters
<a name="API_CreateConfigurationProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_CreateConfigurationProfile_RequestSyntax) **   <a name="appconfig-CreateConfigurationProfile-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_CreateConfigurationProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateConfigurationProfile_RequestSyntax) **   <a name="appconfig-CreateConfigurationProfile-request-Description"></a>
A description of the configuration profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [KmsKeyIdentifier](#API_CreateConfigurationProfile_RequestSyntax) **   <a name="appconfig-CreateConfigurationProfile-request-KmsKeyIdentifier"></a>
The identifier for an 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 1. Maximum length of 2048.  
Required: No

 ** [LocationUri](#API_CreateConfigurationProfile_RequestSyntax) **   <a name="appconfig-CreateConfigurationProfile-request-LocationUri"></a>
A URI to locate the configuration. You can specify the following:  
+ For the AWS AppConfig hosted configuration store and for feature flags, specify `hosted`.
+ For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in the format `ssm-parameter://<parameter name>` or the ARN.
+ For an AWS CodePipeline pipeline, specify the URI in the following format: `codepipeline`://<pipeline name>.
+ For an AWS Secrets Manager secret, specify the URI in the following format: `secretsmanager`://<secret name>.
+ For an Amazon S3 object, specify the URI in the following format: `s3://<bucket>/<objectKey> `. Here is an example: `s3://amzn-s3-demo-bucket/my-app/us-east-1/my-config.json` 
+ For an SSM document, specify either the document name in the format `ssm-document://<document name>` or the Amazon Resource Name (ARN).
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [Name](#API_CreateConfigurationProfile_RequestSyntax) **   <a name="appconfig-CreateConfigurationProfile-request-Name"></a>
A name for the configuration profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** [RetrievalRoleArn](#API_CreateConfigurationProfile_RequestSyntax) **   <a name="appconfig-CreateConfigurationProfile-request-RetrievalRoleArn"></a>
The ARN of an IAM role with permission to access the configuration at the specified `LocationUri`.  
A retrieval role ARN is not required for configurations stored in AWS CodePipeline or the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration. 
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|aws-eusc):(iam)::\d{12}:role[/].*)$`   
Required: No

 ** [Tags](#API_CreateConfigurationProfile_RequestSyntax) **   <a name="appconfig-CreateConfigurationProfile-request-Tags"></a>
Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [Type](#API_CreateConfigurationProfile_RequestSyntax) **   <a name="appconfig-CreateConfigurationProfile-request-Type"></a>
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\.]+`   
Required: No

 ** [Validators](#API_CreateConfigurationProfile_RequestSyntax) **   <a name="appconfig-CreateConfigurationProfile-request-Validators"></a>
A list of methods for validating the configuration.  
Type: Array of [Validator](API_Validator.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

## Response Syntax
<a name="API_CreateConfigurationProfile_ResponseSyntax"></a>

```
HTTP/1.1 201
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
<a name="API_CreateConfigurationProfile_ResponseElements"></a>

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

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

 ** [ApplicationId](#API_CreateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-CreateConfigurationProfile-response-ApplicationId"></a>
The application ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Description](#API_CreateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-CreateConfigurationProfile-response-Description"></a>
The configuration profile description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_CreateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-CreateConfigurationProfile-response-Id"></a>
The configuration profile ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [KmsKeyArn](#API_CreateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-CreateConfigurationProfile-response-KmsKeyArn"></a>
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]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [KmsKeyIdentifier](#API_CreateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-CreateConfigurationProfile-response-KmsKeyIdentifier"></a>
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](#API_CreateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-CreateConfigurationProfile-response-LocationUri"></a>
The URI location of the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Name](#API_CreateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-CreateConfigurationProfile-response-Name"></a>
The name of the configuration profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [RetrievalRoleArn](#API_CreateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-CreateConfigurationProfile-response-RetrievalRoleArn"></a>
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|aws-eusc):(iam)::\d{12}:role[/].*)$` 

 ** [Type](#API_CreateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-CreateConfigurationProfile-response-Type"></a>
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](#API_CreateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-CreateConfigurationProfile-response-Validators"></a>
A list of methods for validating the configuration.  
Type: Array of [Validator](API_Validator.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.

## Errors
<a name="API_CreateConfigurationProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ServiceQuotaExceededException **   
The number of one more AWS AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:  
Applications: 100 max  
Deployment strategies: 20 max  
Configuration profiles: 100 max per application  
Environments: 20 max per application  
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see [Service quotas for AWS AppConfig](https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig) in the Amazon Web Services General Reference.  
HTTP Status Code: 402

## Examples
<a name="API_CreateConfigurationProfile_Examples"></a>

### Example
<a name="API_CreateConfigurationProfile_Example_1"></a>

This example illustrates one usage of CreateConfigurationProfile.

#### Sample Request
<a name="API_CreateConfigurationProfile_Example_1_Request"></a>

```
POST /applications/abc1234/configurationprofiles 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.create-configuration-profile
X-Amz-Date: 20210916T190059Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 171

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

#### Sample Response
<a name="API_CreateConfigurationProfile_Example_1_Response"></a>

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

## See Also
<a name="API_CreateConfigurationProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/CreateConfigurationProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/CreateConfigurationProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/CreateConfigurationProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/CreateConfigurationProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/CreateConfigurationProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/CreateConfigurationProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/CreateConfigurationProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/CreateConfigurationProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/CreateConfigurationProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/CreateConfigurationProfile) 

# CreateDeploymentStrategy
<a name="API_CreateDeploymentStrategy"></a>

Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

## Request Syntax
<a name="API_CreateDeploymentStrategy_RequestSyntax"></a>

```
POST /deploymentstrategies HTTP/1.1
Content-type: application/json

{
   "DeploymentDurationInMinutes": number,
   "Description": "string",
   "FinalBakeTimeInMinutes": number,
   "GrowthFactor": number,
   "GrowthType": "string",
   "Name": "string",
   "ReplicateTo": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateDeploymentStrategy_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateDeploymentStrategy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DeploymentDurationInMinutes](#API_CreateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-CreateDeploymentStrategy-request-DeploymentDurationInMinutes"></a>
Total amount of time for a deployment to last.  
 AWS AppConfig Agent supports deploying feature flag or free-form configuration data to specific segments or individual users during a gradual rollout. Entity-based gradual deployments ensure that once a user or segment receives a configuration version, they continue to receive that same version throughout the deployment period, regardless of which compute resource serves their requests. For more information, see [Using AWS AppConfig Agent for user-based or entity-based gradual deployments](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-agent-how-to-use.html#appconfig-entity-based-gradual-deployments) 
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.  
Required: Yes

 ** [Description](#API_CreateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-CreateDeploymentStrategy-request-Description"></a>
A description of the deployment strategy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [FinalBakeTimeInMinutes](#API_CreateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-CreateDeploymentStrategy-request-FinalBakeTimeInMinutes"></a>
Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AWS AppConfig rolls back the deployment. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms. For more information, see [Configuring permissions for rollback based on Amazon CloudWatch alarms](https://docs.aws.amazon.com/appconfig/latest/userguide/getting-started-with-appconfig-cloudwatch-alarms-permissions.html) in the * AWS AppConfig User Guide*.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.  
Required: No

 ** [GrowthFactor](#API_CreateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-CreateDeploymentStrategy-request-GrowthFactor"></a>
The percentage of targets to receive a deployed configuration during each interval.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.  
Required: Yes

 ** [GrowthType](#API_CreateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-CreateDeploymentStrategy-request-GrowthType"></a>
The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:  
 **Linear**: For this type, AWS AppConfig processes the deployment by dividing the total number of targets by the value specified for `Step percentage`. For example, a linear deployment that uses a `Step percentage` of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.  
 **Exponential**: For this type, AWS AppConfig processes the deployment exponentially using the following formula: `G*(2^N)`. In this formula, `G` is the growth factor specified by the user and `N` is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:  
 `2*(2^0)`   
 `2*(2^1)`   
 `2*(2^2)`   
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.  
Type: String  
Valid Values: `LINEAR | EXPONENTIAL`   
Required: No

 ** [Name](#API_CreateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-CreateDeploymentStrategy-request-Name"></a>
A name for the deployment strategy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** [ReplicateTo](#API_CreateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-CreateDeploymentStrategy-request-ReplicateTo"></a>
Save the deployment strategy to a Systems Manager (SSM) document.  
Type: String  
Valid Values: `NONE | SSM_DOCUMENT`   
Required: No

 ** [Tags](#API_CreateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-CreateDeploymentStrategy-request-Tags"></a>
Metadata to assign to the deployment strategy. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateDeploymentStrategy_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "DeploymentDurationInMinutes": number,
   "Description": "string",
   "FinalBakeTimeInMinutes": number,
   "GrowthFactor": number,
   "GrowthType": "string",
   "Id": "string",
   "Name": "string",
   "ReplicateTo": "string"
}
```

## Response Elements
<a name="API_CreateDeploymentStrategy_ResponseElements"></a>

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

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

 ** [DeploymentDurationInMinutes](#API_CreateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-CreateDeploymentStrategy-response-DeploymentDurationInMinutes"></a>
Total amount of time the deployment lasted.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [Description](#API_CreateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-CreateDeploymentStrategy-response-Description"></a>
The description of the deployment strategy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [FinalBakeTimeInMinutes](#API_CreateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-CreateDeploymentStrategy-response-FinalBakeTimeInMinutes"></a>
The amount of time that AWS AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [GrowthFactor](#API_CreateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-CreateDeploymentStrategy-response-GrowthFactor"></a>
The percentage of targets that received a deployed configuration during each interval.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.

 ** [GrowthType](#API_CreateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-CreateDeploymentStrategy-response-GrowthType"></a>
The algorithm used to define how percentage grew over time.  
Type: String  
Valid Values: `LINEAR | EXPONENTIAL` 

 ** [Id](#API_CreateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-CreateDeploymentStrategy-response-Id"></a>
The deployment strategy ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Name](#API_CreateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-CreateDeploymentStrategy-response-Name"></a>
The name of the deployment strategy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [ReplicateTo](#API_CreateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-CreateDeploymentStrategy-response-ReplicateTo"></a>
Save the deployment strategy to a Systems Manager (SSM) document.  
Type: String  
Valid Values: `NONE | SSM_DOCUMENT` 

## Errors
<a name="API_CreateDeploymentStrategy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ServiceQuotaExceededException **   
The number of one more AWS AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:  
Applications: 100 max  
Deployment strategies: 20 max  
Configuration profiles: 100 max per application  
Environments: 20 max per application  
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see [Service quotas for AWS AppConfig](https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig) in the Amazon Web Services General Reference.  
HTTP Status Code: 402

## Examples
<a name="API_CreateDeploymentStrategy_Examples"></a>

### Example
<a name="API_CreateDeploymentStrategy_Example_1"></a>

This example illustrates one usage of CreateDeploymentStrategy.

#### Sample Request
<a name="API_CreateDeploymentStrategy_Example_1_Request"></a>

```
POST /deploymentstrategies 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.create-deployment-strategy
X-Amz-Date: 20210916T214947Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 118

{
	"Name": "Example-Deployment", 
	"DeploymentDurationInMinutes": 15, 
	"GrowthFactor": 25.0, 
	"ReplicateTo": "SSM_DOCUMENT"
}
```

#### Sample Response
<a name="API_CreateDeploymentStrategy_Example_1_Response"></a>

```
{
	"DeploymentDurationInMinutes": 15,
	"Description": null,
	"FinalBakeTimeInMinutes": 0,
	"GrowthFactor": 25.0,
	"GrowthType": "LINEAR",
	"Id": "1225qzk",
	"Name": "Example-Deployment",
	"ReplicateTo": "SSM_DOCUMENT"
}
```

## See Also
<a name="API_CreateDeploymentStrategy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/CreateDeploymentStrategy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/CreateDeploymentStrategy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/CreateDeploymentStrategy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/CreateDeploymentStrategy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/CreateDeploymentStrategy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/CreateDeploymentStrategy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/CreateDeploymentStrategy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/CreateDeploymentStrategy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/CreateDeploymentStrategy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/CreateDeploymentStrategy) 

# CreateEnvironment
<a name="API_CreateEnvironment"></a>

Creates an environment. For each application, you define one or more environments. An environment is a deployment group of AWS AppConfig targets, such as applications in a `Beta` or `Production` environment. You can also define environments for application subcomponents such as the `Web`, `Mobile` and `Back-end` components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

## Request Syntax
<a name="API_CreateEnvironment_RequestSyntax"></a>

```
POST /applications/ApplicationId/environments HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Monitors": [ 
      { 
         "AlarmArn": "string",
         "AlarmRoleArn": "string"
      }
   ],
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateEnvironment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_CreateEnvironment_RequestSyntax) **   <a name="appconfig-CreateEnvironment-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_CreateEnvironment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateEnvironment_RequestSyntax) **   <a name="appconfig-CreateEnvironment-request-Description"></a>
A description of the environment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [Monitors](#API_CreateEnvironment_RequestSyntax) **   <a name="appconfig-CreateEnvironment-request-Monitors"></a>
Amazon CloudWatch alarms to monitor during the deployment process.  
Type: Array of [Monitor](API_Monitor.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [Name](#API_CreateEnvironment_RequestSyntax) **   <a name="appconfig-CreateEnvironment-request-Name"></a>
A name for the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** [Tags](#API_CreateEnvironment_RequestSyntax) **   <a name="appconfig-CreateEnvironment-request-Tags"></a>
Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateEnvironment_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "ApplicationId": "string",
   "Description": "string",
   "Id": "string",
   "Monitors": [ 
      { 
         "AlarmArn": "string",
         "AlarmRoleArn": "string"
      }
   ],
   "Name": "string",
   "State": "string"
}
```

## Response Elements
<a name="API_CreateEnvironment_ResponseElements"></a>

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

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

 ** [ApplicationId](#API_CreateEnvironment_ResponseSyntax) **   <a name="appconfig-CreateEnvironment-response-ApplicationId"></a>
The application ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Description](#API_CreateEnvironment_ResponseSyntax) **   <a name="appconfig-CreateEnvironment-response-Description"></a>
The description of the environment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_CreateEnvironment_ResponseSyntax) **   <a name="appconfig-CreateEnvironment-response-Id"></a>
The environment ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Monitors](#API_CreateEnvironment_ResponseSyntax) **   <a name="appconfig-CreateEnvironment-response-Monitors"></a>
Amazon CloudWatch alarms monitored during the deployment.  
Type: Array of [Monitor](API_Monitor.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

 ** [Name](#API_CreateEnvironment_ResponseSyntax) **   <a name="appconfig-CreateEnvironment-response-Name"></a>
The name of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [State](#API_CreateEnvironment_ResponseSyntax) **   <a name="appconfig-CreateEnvironment-response-State"></a>
The state of the environment. An environment can be in one of the following states: `READY_FOR_DEPLOYMENT`, `DEPLOYING`, `ROLLING_BACK`, or `ROLLED_BACK`   
Type: String  
Valid Values: `READY_FOR_DEPLOYMENT | DEPLOYING | ROLLING_BACK | ROLLED_BACK | REVERTED` 

## Errors
<a name="API_CreateEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ServiceQuotaExceededException **   
The number of one more AWS AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:  
Applications: 100 max  
Deployment strategies: 20 max  
Configuration profiles: 100 max per application  
Environments: 20 max per application  
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see [Service quotas for AWS AppConfig](https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig) in the Amazon Web Services General Reference.  
HTTP Status Code: 402

## Examples
<a name="API_CreateEnvironment_Examples"></a>

### Example
<a name="API_CreateEnvironment_Example_1"></a>

This example illustrates one usage of CreateEnvironment.

#### Sample Request
<a name="API_CreateEnvironment_Example_1_Request"></a>

```
POST /applications/abc1234/environments 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.create-environment
X-Amz-Date: 20210916T221023Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 31

{
	"Name": "Example-Environment"
}
```

#### Sample Response
<a name="API_CreateEnvironment_Example_1_Response"></a>

```
{
	"ApplicationId": "abc1234",
	"Description": null,
	"Id": "54j1r29",
	"Monitors": null,
	"Name": "Example-Environment",
	"State": "ReadyForDeployment"
}
```

## See Also
<a name="API_CreateEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/CreateEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/CreateEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/CreateEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/CreateEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/CreateEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/CreateEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/CreateEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/CreateEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/CreateEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/CreateEnvironment) 

# CreateExtension
<a name="API_CreateExtension"></a>

Creates an AWS AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AWS AppConfig workflow of creating or deploying a configuration.

You can create your own extensions or use the AWS authored extensions provided by AWS AppConfig. For an AWS AppConfig extension that uses AWS Lambda, you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the AWS authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the `Uri` field for the new extension version.
+ For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the `Uri` field.
+ For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the `Uri` field.
+ For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the `Uri` field. 

For more information about extensions, see [Extending workflows](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the * AWS AppConfig User Guide*.

## Request Syntax
<a name="API_CreateExtension_RequestSyntax"></a>

```
POST /extensions HTTP/1.1
Latest-Version-Number: LatestVersionNumber
Content-type: application/json

{
   "Actions": { 
      "string" : [ 
         { 
            "Description": "string",
            "Name": "string",
            "RoleArn": "string",
            "Uri": "string"
         }
      ]
   },
   "Description": "string",
   "Name": "string",
   "Parameters": { 
      "string" : { 
         "Description": "string",
         "Dynamic": boolean,
         "Required": boolean
      }
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateExtension_RequestParameters"></a>

The request uses the following URI parameters.

 ** [LatestVersionNumber](#API_CreateExtension_RequestSyntax) **   <a name="appconfig-CreateExtension-request-LatestVersionNumber"></a>
You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.

## Request Body
<a name="API_CreateExtension_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Actions](#API_CreateExtension_RequestSyntax) **   <a name="appconfig-CreateExtension-request-Actions"></a>
The actions defined in the extension.  
Type: String to array of [Action](API_Action.md) objects map  
Map Entries: Maximum number of 5 items.  
Valid Keys: `PRE_CREATE_HOSTED_CONFIGURATION_VERSION | PRE_START_DEPLOYMENT | AT_DEPLOYMENT_TICK | ON_DEPLOYMENT_START | ON_DEPLOYMENT_STEP | ON_DEPLOYMENT_BAKING | ON_DEPLOYMENT_COMPLETE | ON_DEPLOYMENT_ROLLED_BACK`   
Array Members: Fixed number of 1 item.  
Required: Yes

 ** [Description](#API_CreateExtension_RequestSyntax) **   <a name="appconfig-CreateExtension-request-Description"></a>
Information about the extension.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [Name](#API_CreateExtension_RequestSyntax) **   <a name="appconfig-CreateExtension-request-Name"></a>
A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.  
Type: String  
Pattern: `^[^\/#:\n]{1,64}$`   
Required: Yes

 ** [Parameters](#API_CreateExtension_RequestSyntax) **   <a name="appconfig-CreateExtension-request-Parameters"></a>
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AWS AppConfig resource by using the `CreateExtensionAssociation` API action. For AWS Lambda extension actions, these parameters are included in the Lambda request object.  
Type: String to [Parameter](API_Parameter.md) object map  
Map Entries: Maximum number of 10 items.  
Key Pattern: `^[^\/#:\n]{1,64}$`   
Required: No

 ** [Tags](#API_CreateExtension_RequestSyntax) **   <a name="appconfig-CreateExtension-request-Tags"></a>
Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.   
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateExtension_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "Actions": { 
      "string" : [ 
         { 
            "Description": "string",
            "Name": "string",
            "RoleArn": "string",
            "Uri": "string"
         }
      ]
   },
   "Arn": "string",
   "Description": "string",
   "Id": "string",
   "Name": "string",
   "Parameters": { 
      "string" : { 
         "Description": "string",
         "Dynamic": boolean,
         "Required": boolean
      }
   },
   "VersionNumber": number
}
```

## Response Elements
<a name="API_CreateExtension_ResponseElements"></a>

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

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

 ** [Actions](#API_CreateExtension_ResponseSyntax) **   <a name="appconfig-CreateExtension-response-Actions"></a>
The actions defined in the extension.  
Type: String to array of [Action](API_Action.md) objects map  
Map Entries: Maximum number of 5 items.  
Valid Keys: `PRE_CREATE_HOSTED_CONFIGURATION_VERSION | PRE_START_DEPLOYMENT | AT_DEPLOYMENT_TICK | ON_DEPLOYMENT_START | ON_DEPLOYMENT_STEP | ON_DEPLOYMENT_BAKING | ON_DEPLOYMENT_COMPLETE | ON_DEPLOYMENT_ROLLED_BACK`   
Array Members: Fixed number of 1 item.

 ** [Arn](#API_CreateExtension_ResponseSyntax) **   <a name="appconfig-CreateExtension-response-Arn"></a>
The system-generated Amazon Resource Name (ARN) for the extension.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [Description](#API_CreateExtension_ResponseSyntax) **   <a name="appconfig-CreateExtension-response-Description"></a>
Information about the extension.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_CreateExtension_ResponseSyntax) **   <a name="appconfig-CreateExtension-response-Id"></a>
The system-generated ID of the extension.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Name](#API_CreateExtension_ResponseSyntax) **   <a name="appconfig-CreateExtension-response-Name"></a>
The extension name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [Parameters](#API_CreateExtension_ResponseSyntax) **   <a name="appconfig-CreateExtension-response-Parameters"></a>
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AWS AppConfig resource by using the `CreateExtensionAssociation` API action. For AWS Lambda extension actions, these parameters are included in the Lambda request object.  
Type: String to [Parameter](API_Parameter.md) object map  
Map Entries: Maximum number of 10 items.  
Key Pattern: `^[^\/#:\n]{1,64}$` 

 ** [VersionNumber](#API_CreateExtension_ResponseSyntax) **   <a name="appconfig-CreateExtension-response-VersionNumber"></a>
The extension version number.  
Type: Integer

## Errors
<a name="API_CreateExtension_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
There was an internal failure in the AWS AppConfig service.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The number of one more AWS AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:  
Applications: 100 max  
Deployment strategies: 20 max  
Configuration profiles: 100 max per application  
Environments: 20 max per application  
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see [Service quotas for AWS AppConfig](https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig) in the Amazon Web Services General Reference.  
HTTP Status Code: 402

## Examples
<a name="API_CreateExtension_Examples"></a>

### Example
<a name="API_CreateExtension_Example_1"></a>

This example illustrates one usage of CreateExtension.

#### Sample Request
<a name="API_CreateExtension_Example_1_Request"></a>

```
POST /extensions HTTP/1.1
Host: appconfig.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Type: application/json
User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/appconfig.create-extension
X-Amz-Date: 20220803T202954Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 304

{
	"Name": "my-test-extension",
	"Actions": {
		"PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [{
			"Name": "S3backup",
			"Uri": "arn:aws:lambda:us-west-2:111122223333:function:mytestfunction",
			"RoleArn": "arn:aws:iam::111122223333:role/mytestextensionrole"
		}]
	},
	"Parameters": {
		"MyParamKey": {
			"Required": true
		}
	}
}
```

#### Sample Response
<a name="API_CreateExtension_Example_1_Response"></a>

```
{
	"Actions": {
		"PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [{
			"Description": null,
			"Name": "S3backup",
			"RoleArn": "arn:aws:iam::111122223333:role/mytestextensionrole",
			"Uri": "arn:aws:lambda:us-west-2:111122223333:function:mytestfunction"
		}]
	}
```

## See Also
<a name="API_CreateExtension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/CreateExtension) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/CreateExtension) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/CreateExtension) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/CreateExtension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/CreateExtension) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/CreateExtension) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/CreateExtension) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/CreateExtension) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/CreateExtension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/CreateExtension) 

# CreateExtensionAssociation
<a name="API_CreateExtensionAssociation"></a>

When you create an extension or configure an AWS authored extension, you associate the extension with an AWS AppConfig application, environment, or configuration profile. For example, you can choose to run the ` AWS AppConfig deployment events to Amazon SNS` AWS authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AWS AppConfig resource is called an *extension association*. An extension association is a specified relationship between an extension and an AWS AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see [Extending workflows](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the * AWS AppConfig User Guide*.

## Request Syntax
<a name="API_CreateExtensionAssociation_RequestSyntax"></a>

```
POST /extensionassociations HTTP/1.1
Content-type: application/json

{
   "ExtensionIdentifier": "string",
   "ExtensionVersionNumber": number,
   "Parameters": { 
      "string" : "string" 
   },
   "ResourceIdentifier": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateExtensionAssociation_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateExtensionAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ExtensionIdentifier](#API_CreateExtensionAssociation_RequestSyntax) **   <a name="appconfig-CreateExtensionAssociation-request-ExtensionIdentifier"></a>
The name, the ID, or the Amazon Resource Name (ARN) of the extension.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [ExtensionVersionNumber](#API_CreateExtensionAssociation_RequestSyntax) **   <a name="appconfig-CreateExtensionAssociation-request-ExtensionVersionNumber"></a>
The version number of the extension. If not specified, AWS AppConfig uses the maximum version of the extension.  
Type: Integer  
Required: No

 ** [Parameters](#API_CreateExtensionAssociation_RequestSyntax) **   <a name="appconfig-CreateExtensionAssociation-request-Parameters"></a>
The parameter names and values defined in the extensions. Extension parameters marked `Required` must be entered for this field.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Pattern: `^[^\/#:\n]{1,64}$`   
Value Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [ResourceIdentifier](#API_CreateExtensionAssociation_RequestSyntax) **   <a name="appconfig-CreateExtensionAssociation-request-ResourceIdentifier"></a>
The ARN of an application, configuration profile, or environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [Tags](#API_CreateExtensionAssociation_RequestSyntax) **   <a name="appconfig-CreateExtensionAssociation-request-Tags"></a>
Adds one or more tags for the specified extension association. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.   
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateExtensionAssociation_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "Arn": "string",
   "ExtensionArn": "string",
   "ExtensionVersionNumber": number,
   "Id": "string",
   "Parameters": { 
      "string" : "string" 
   },
   "ResourceArn": "string"
}
```

## Response Elements
<a name="API_CreateExtensionAssociation_ResponseElements"></a>

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

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

 ** [Arn](#API_CreateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-CreateExtensionAssociation-response-Arn"></a>
The system-generated Amazon Resource Name (ARN) for the extension.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [ExtensionArn](#API_CreateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-CreateExtensionAssociation-response-ExtensionArn"></a>
The ARN of the extension defined in the association.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [ExtensionVersionNumber](#API_CreateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-CreateExtensionAssociation-response-ExtensionVersionNumber"></a>
The version number for the extension defined in the association.  
Type: Integer

 ** [Id](#API_CreateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-CreateExtensionAssociation-response-Id"></a>
The system-generated ID for the association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Parameters](#API_CreateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-CreateExtensionAssociation-response-Parameters"></a>
The parameter names and values defined in the association.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Pattern: `^[^\/#:\n]{1,64}$`   
Value Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [ResourceArn](#API_CreateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-CreateExtensionAssociation-response-ResourceArn"></a>
The ARNs of applications, configuration profiles, or environments defined in the association.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

## Errors
<a name="API_CreateExtensionAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ServiceQuotaExceededException **   
The number of one more AWS AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:  
Applications: 100 max  
Deployment strategies: 20 max  
Configuration profiles: 100 max per application  
Environments: 20 max per application  
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see [Service quotas for AWS AppConfig](https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig) in the Amazon Web Services General Reference.  
HTTP Status Code: 402

## Examples
<a name="API_CreateExtensionAssociation_Examples"></a>

### Example
<a name="API_CreateExtensionAssociation_Example_1"></a>

This example illustrates one usage of CreateExtensionAssociation.

#### Sample Request
<a name="API_CreateExtensionAssociation_Example_1_Request"></a>

```
POST /extensionassociations HTTP/1.1
Host: appconfig.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Type: application/json
User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/appconfig.create-extension-association
X-Amz-Date: 20220803T214332Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 180

{"ExtensionIdentifier": "my-test-extension", "ResourceIdentifier": "arn:aws:appconfig:us-west-2:111122223333:application/xlmtExample", "Parameters": {"MyParamKey": "MyParamValue"}}
```

#### Sample Response
<a name="API_CreateExtensionAssociation_Example_1_Response"></a>

```
{
	"Arn": null,
	"ExtensionArn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czatq1/1",
	"ExtensionVersionNumber": 1,
	"Id": "rnekru4",
	"Parameters": {
		"MyParamKey": "MyParamValue"
	},
	"ResourceArn": "arn:aws:appconfig:us-west-2:111122223333:application/xlmtExample"
}
```

## See Also
<a name="API_CreateExtensionAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/CreateExtensionAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/CreateExtensionAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/CreateExtensionAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/CreateExtensionAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/CreateExtensionAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/CreateExtensionAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/CreateExtensionAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/CreateExtensionAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/CreateExtensionAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/CreateExtensionAssociation) 

# CreateHostedConfigurationVersion
<a name="API_CreateHostedConfigurationVersion"></a>

Creates a new configuration in the AWS AppConfig hosted configuration store. If you're creating a feature flag, we recommend you familiarize yourself with the JSON schema for feature flag data. For more information, see [Type reference for AWS.AppConfig.FeatureFlags](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-type-reference-feature-flags.html) in the * AWS AppConfig User Guide*.

## Request Syntax
<a name="API_CreateHostedConfigurationVersion_RequestSyntax"></a>

```
POST /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/hostedconfigurationversions HTTP/1.1
Description: Description
Content-Type: ContentType
Latest-Version-Number: LatestVersionNumber
VersionLabel: VersionLabel

Content
```

## URI Request Parameters
<a name="API_CreateHostedConfigurationVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_CreateHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ConfigurationProfileId](#API_CreateHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-request-uri-ConfigurationProfileId"></a>
The configuration profile ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ContentType](#API_CreateHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-request-ContentType"></a>
A standard MIME type describing the format of the configuration content. For more information, see [Content-Type](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17).  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [Description](#API_CreateHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-request-Description"></a>
A description of the configuration.  
Due to HTTP limitations, this field only supports ASCII characters.
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [LatestVersionNumber](#API_CreateHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-request-LatestVersionNumber"></a>
An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.

 ** [VersionLabel](#API_CreateHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-request-VersionLabel"></a>
An optional, user-defined label for the AWS AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*[^0-9].*` 

## Request Body
<a name="API_CreateHostedConfigurationVersion_RequestBody"></a>

The request accepts the following binary data.

 ** [Content](#API_CreateHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-request-Content"></a>
The configuration data, as bytes.  
 AWS AppConfig accepts any type of data, including text formats like JSON or TOML, or binary formats like protocol buffers or compressed data.
Required: Yes

## Response Syntax
<a name="API_CreateHostedConfigurationVersion_ResponseSyntax"></a>

```
HTTP/1.1 201
Application-Id: ApplicationId
Configuration-Profile-Id: ConfigurationProfileId
Version-Number: VersionNumber
Description: Description
Content-Type: ContentType
VersionLabel: VersionLabel
KmsKeyArn: KmsKeyArn

Content
```

## Response Elements
<a name="API_CreateHostedConfigurationVersion_ResponseElements"></a>

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

The response returns the following HTTP headers.

 ** [ApplicationId](#API_CreateHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-response-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}` 

 ** [ConfigurationProfileId](#API_CreateHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-response-ConfigurationProfileId"></a>
The configuration profile ID.  
Pattern: `[a-z0-9]{4,7}` 

 ** [ContentType](#API_CreateHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-response-ContentType"></a>
A standard MIME type describing the format of the configuration content. For more information, see [Content-Type](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17).  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Description](#API_CreateHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-response-Description"></a>
A description of the configuration.  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [KmsKeyArn](#API_CreateHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-response-KmsKeyArn"></a>
The Amazon Resource Name of the AWS Key Management Service key that was used to encrypt this specific version of the configuration data in the AWS AppConfig hosted configuration store.  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [VersionLabel](#API_CreateHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-response-VersionLabel"></a>
A user-defined label for an AWS AppConfig hosted configuration version.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*[^0-9].*` 

 ** [VersionNumber](#API_CreateHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-response-VersionNumber"></a>
The configuration version.

The response returns the following as the HTTP body.

 ** [Content](#API_CreateHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-CreateHostedConfigurationVersion-response-Content"></a>
The content of the configuration or the configuration data.

## Errors
<a name="API_CreateHostedConfigurationVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
There was an internal failure in the AWS AppConfig service.  
HTTP Status Code: 500

 ** PayloadTooLargeException **   
The configuration size is too large.  
HTTP Status Code: 413

 ** ResourceNotFoundException **   
The requested resource could not be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The number of one more AWS AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:  
Applications: 100 max  
Deployment strategies: 20 max  
Configuration profiles: 100 max per application  
Environments: 20 max per application  
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see [Service quotas for AWS AppConfig](https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig) in the Amazon Web Services General Reference.  
HTTP Status Code: 402

## Examples
<a name="API_CreateHostedConfigurationVersion_Examples"></a>

### Example
<a name="API_CreateHostedConfigurationVersion_Example_1"></a>

This example illustrates one usage of CreateHostedConfigurationVersion.

#### Sample Request
<a name="API_CreateHostedConfigurationVersion_Example_1_Request"></a>

```
POST /applications/abc1234/configurationprofiles/ur8hx2f/hostedconfigurationversions HTTP/1.1
Host: appconfig.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Type: application/json
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.create-hosted-configuration-version
X-Amz-Date: 20210917T184857Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 27

{ "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 }
```

#### Sample Response
<a name="API_CreateHostedConfigurationVersion_Example_1_Response"></a>

```
{
    "ApplicationId": "abc1234",
    "ConfigurationProfileId": "ur8hx2f",
    "VersionNumber": "1",
    "ContentType": "application/json"
}
```

## See Also
<a name="API_CreateHostedConfigurationVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/CreateHostedConfigurationVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/CreateHostedConfigurationVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/CreateHostedConfigurationVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/CreateHostedConfigurationVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/CreateHostedConfigurationVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/CreateHostedConfigurationVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/CreateHostedConfigurationVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/CreateHostedConfigurationVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/CreateHostedConfigurationVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/CreateHostedConfigurationVersion) 

# DeleteApplication
<a name="API_DeleteApplication"></a>

Deletes an application.

## Request Syntax
<a name="API_DeleteApplication_RequestSyntax"></a>

```
DELETE /applications/ApplicationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_DeleteApplication_RequestSyntax) **   <a name="appconfig-DeleteApplication-request-uri-ApplicationId"></a>
The ID of the application to delete.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_DeleteApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteApplication_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteApplication_Examples"></a>

### Example
<a name="API_DeleteApplication_Example_1"></a>

This example illustrates one usage of DeleteApplication.

#### Sample Request
<a name="API_DeleteApplication_Example_1_Request"></a>

```
DELETE /applications/339ohji 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.delete-application
X-Amz-Date: 20210920T222013Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_DeleteApplication_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/DeleteApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/DeleteApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/DeleteApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/DeleteApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/DeleteApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/DeleteApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/DeleteApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/DeleteApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/DeleteApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/DeleteApplication) 

# DeleteConfigurationProfile
<a name="API_DeleteConfigurationProfile"></a>

Deletes a configuration profile.

To prevent users from unintentionally deleting actively-used configuration profiles, enable [deletion protection](https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html).

## Request Syntax
<a name="API_DeleteConfigurationProfile_RequestSyntax"></a>

```
DELETE /applications/ApplicationId/configurationprofiles/ConfigurationProfileId HTTP/1.1
x-amzn-deletion-protection-check: DeletionProtectionCheck
```

## URI Request Parameters
<a name="API_DeleteConfigurationProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_DeleteConfigurationProfile_RequestSyntax) **   <a name="appconfig-DeleteConfigurationProfile-request-uri-ApplicationId"></a>
The application ID that includes the configuration profile you want to delete.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ConfigurationProfileId](#API_DeleteConfigurationProfile_RequestSyntax) **   <a name="appconfig-DeleteConfigurationProfile-request-uri-ConfigurationProfileId"></a>
The ID of the configuration profile you want to delete.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [DeletionProtectionCheck](#API_DeleteConfigurationProfile_RequestSyntax) **   <a name="appconfig-DeleteConfigurationProfile-request-DeletionProtectionCheck"></a>
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile if your application has called either [GetLatestConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) or [GetConfiguration](API_GetConfiguration.md) for the configuration profile during the specified interval.   
This parameter supports the following values:  
+  `BYPASS`: Instructs AWS AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.
+  `APPLY`: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. `APPLY` also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks. 
+  `ACCOUNT_DEFAULT`: The default setting, which instructs AWS AppConfig to implement the deletion protection value specified in the `UpdateAccountSettings` API.
Valid Values: `ACCOUNT_DEFAULT | APPLY | BYPASS` 

## Request Body
<a name="API_DeleteConfigurationProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteConfigurationProfile_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteConfigurationProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteConfigurationProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** 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
<a name="API_DeleteConfigurationProfile_Examples"></a>

### Example
<a name="API_DeleteConfigurationProfile_Example_1"></a>

This example illustrates one usage of DeleteConfigurationProfile.

#### Sample Request
<a name="API_DeleteConfigurationProfile_Example_1_Request"></a>

```
DELETE /applications/339ohji/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.delete-configuration-profile
X-Amz-Date: 20210920T221708Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_DeleteConfigurationProfile_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteConfigurationProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/DeleteConfigurationProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/DeleteConfigurationProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/DeleteConfigurationProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/DeleteConfigurationProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/DeleteConfigurationProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/DeleteConfigurationProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/DeleteConfigurationProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/DeleteConfigurationProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/DeleteConfigurationProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/DeleteConfigurationProfile) 

# DeleteDeploymentStrategy
<a name="API_DeleteDeploymentStrategy"></a>

Deletes a deployment strategy.

## Request Syntax
<a name="API_DeleteDeploymentStrategy_RequestSyntax"></a>

```
DELETE /deployementstrategies/DeploymentStrategyId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDeploymentStrategy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DeploymentStrategyId](#API_DeleteDeploymentStrategy_RequestSyntax) **   <a name="appconfig-DeleteDeploymentStrategy-request-uri-DeploymentStrategyId"></a>
The ID of the deployment strategy you want to delete.  
Pattern: `(^[a-z0-9]{4,7}$|^AppConfig\.[A-Za-z0-9]{9,40}$)`   
Required: Yes

## Request Body
<a name="API_DeleteDeploymentStrategy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDeploymentStrategy_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteDeploymentStrategy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteDeploymentStrategy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteDeploymentStrategy_Examples"></a>

### Example
<a name="API_DeleteDeploymentStrategy_Example_1"></a>

This example illustrates one usage of DeleteDeploymentStrategy.

#### Sample Request
<a name="API_DeleteDeploymentStrategy_Example_1_Request"></a>

```
DELETE /deployementstrategies/1225qzk 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.delete-deployment-strategy
X-Amz-Date: 20210920T221109Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_DeleteDeploymentStrategy_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteDeploymentStrategy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/DeleteDeploymentStrategy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/DeleteDeploymentStrategy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/DeleteDeploymentStrategy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/DeleteDeploymentStrategy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/DeleteDeploymentStrategy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/DeleteDeploymentStrategy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/DeleteDeploymentStrategy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/DeleteDeploymentStrategy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/DeleteDeploymentStrategy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/DeleteDeploymentStrategy) 

# DeleteEnvironment
<a name="API_DeleteEnvironment"></a>

Deletes an environment.

To prevent users from unintentionally deleting actively-used environments, enable [deletion protection](https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html).

## Request Syntax
<a name="API_DeleteEnvironment_RequestSyntax"></a>

```
DELETE /applications/ApplicationId/environments/EnvironmentId HTTP/1.1
x-amzn-deletion-protection-check: DeletionProtectionCheck
```

## URI Request Parameters
<a name="API_DeleteEnvironment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_DeleteEnvironment_RequestSyntax) **   <a name="appconfig-DeleteEnvironment-request-uri-ApplicationId"></a>
The application ID that includes the environment that you want to delete.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [DeletionProtectionCheck](#API_DeleteEnvironment_RequestSyntax) **   <a name="appconfig-DeleteEnvironment-request-DeletionProtectionCheck"></a>
A parameter to configure deletion protection. Deletion protection prevents a user from deleting an environment if your application called either [GetLatestConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) or [GetConfiguration](API_GetConfiguration.md) in the environment during the specified interval.   
This parameter supports the following values:  
+  `BYPASS`: Instructs AWS AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it. 
+  `APPLY`: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. `APPLY` also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.
+  `ACCOUNT_DEFAULT`: The default setting, which instructs AWS AppConfig to implement the deletion protection value specified in the `UpdateAccountSettings` API.
Valid Values: `ACCOUNT_DEFAULT | APPLY | BYPASS` 

 ** [EnvironmentId](#API_DeleteEnvironment_RequestSyntax) **   <a name="appconfig-DeleteEnvironment-request-uri-EnvironmentId"></a>
The ID of the environment that you want to delete.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_DeleteEnvironment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteEnvironment_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteEnvironment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** 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
<a name="API_DeleteEnvironment_Examples"></a>

### Example
<a name="API_DeleteEnvironment_Example_1"></a>

This example illustrates one usage of DeleteEnvironment.

#### Sample Request
<a name="API_DeleteEnvironment_Example_1_Request"></a>

```
DELETE /applications/abc1234/environments/54j1r29 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.delete-environment
X-Amz-Date: 20210920T220756Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_DeleteEnvironment_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/DeleteEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/DeleteEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/DeleteEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/DeleteEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/DeleteEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/DeleteEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/DeleteEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/DeleteEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/DeleteEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/DeleteEnvironment) 

# DeleteExtension
<a name="API_DeleteExtension"></a>

Deletes an AWS AppConfig extension. You must delete all associations to an extension before you delete the extension.

## Request Syntax
<a name="API_DeleteExtension_RequestSyntax"></a>

```
DELETE /extensions/ExtensionIdentifier?version=VersionNumber HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteExtension_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ExtensionIdentifier](#API_DeleteExtension_RequestSyntax) **   <a name="appconfig-DeleteExtension-request-uri-ExtensionIdentifier"></a>
The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [VersionNumber](#API_DeleteExtension_RequestSyntax) **   <a name="appconfig-DeleteExtension-request-uri-VersionNumber"></a>
A specific version of an extension to delete. If omitted, the highest version is deleted.

## Request Body
<a name="API_DeleteExtension_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteExtension_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteExtension_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteExtension_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteExtension_Examples"></a>

### Example
<a name="API_DeleteExtension_Example_1"></a>

This example illustrates one usage of DeleteExtension.

#### Sample Request
<a name="API_DeleteExtension_Example_1_Request"></a>

```
DELETE /extensions/my-test-extension HTTP/1.1
Host: appconfig.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/appconfig.delete-extension
X-Amz-Date: 20220803T223549Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_DeleteExtension_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteExtension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/DeleteExtension) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/DeleteExtension) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/DeleteExtension) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/DeleteExtension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/DeleteExtension) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/DeleteExtension) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/DeleteExtension) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/DeleteExtension) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/DeleteExtension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/DeleteExtension) 

# DeleteExtensionAssociation
<a name="API_DeleteExtensionAssociation"></a>

Deletes an extension association. This action doesn't delete extensions defined in the association.

## Request Syntax
<a name="API_DeleteExtensionAssociation_RequestSyntax"></a>

```
DELETE /extensionassociations/ExtensionAssociationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteExtensionAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ExtensionAssociationId](#API_DeleteExtensionAssociation_RequestSyntax) **   <a name="appconfig-DeleteExtensionAssociation-request-uri-ExtensionAssociationId"></a>
The ID of the extension association to delete.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_DeleteExtensionAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteExtensionAssociation_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteExtensionAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteExtensionAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteExtensionAssociation_Examples"></a>

### Example
<a name="API_DeleteExtensionAssociation_Example_1"></a>

This example illustrates one usage of DeleteExtensionAssociation.

#### Sample Request
<a name="API_DeleteExtensionAssociation_Example_1_Request"></a>

```
DELETE /extensionassociations/rnekru4 HTTP/1.1
Host: appconfig.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/appconfig.delete-extension-association
X-Amz-Date: 20220803T223105Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_DeleteExtensionAssociation_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteExtensionAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/DeleteExtensionAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/DeleteExtensionAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/DeleteExtensionAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/DeleteExtensionAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/DeleteExtensionAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/DeleteExtensionAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/DeleteExtensionAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/DeleteExtensionAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/DeleteExtensionAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/DeleteExtensionAssociation) 

# DeleteHostedConfigurationVersion
<a name="API_DeleteHostedConfigurationVersion"></a>

Deletes a version of a configuration from the AWS AppConfig hosted configuration store.

## Request Syntax
<a name="API_DeleteHostedConfigurationVersion_RequestSyntax"></a>

```
DELETE /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/hostedconfigurationversions/VersionNumber HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteHostedConfigurationVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_DeleteHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-DeleteHostedConfigurationVersion-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ConfigurationProfileId](#API_DeleteHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-DeleteHostedConfigurationVersion-request-uri-ConfigurationProfileId"></a>
The configuration profile ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [VersionNumber](#API_DeleteHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-DeleteHostedConfigurationVersion-request-uri-VersionNumber"></a>
The versions number to delete.  
Required: Yes

## Request Body
<a name="API_DeleteHostedConfigurationVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteHostedConfigurationVersion_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteHostedConfigurationVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteHostedConfigurationVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteHostedConfigurationVersion_Examples"></a>

### Example
<a name="API_DeleteHostedConfigurationVersion_Example_1"></a>

This example illustrates one usage of DeleteHostedConfigurationVersion.

#### Sample Request
<a name="API_DeleteHostedConfigurationVersion_Example_1_Request"></a>

```
DELETE /applications/339ohji/configurationprofiles/ur8hx2f/hostedconfigurationversions/1 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.delete-hosted-configuration-version
X-Amz-Date: 20210920T220442Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_DeleteHostedConfigurationVersion_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteHostedConfigurationVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/DeleteHostedConfigurationVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/DeleteHostedConfigurationVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/DeleteHostedConfigurationVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/DeleteHostedConfigurationVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/DeleteHostedConfigurationVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/DeleteHostedConfigurationVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/DeleteHostedConfigurationVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/DeleteHostedConfigurationVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/DeleteHostedConfigurationVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/DeleteHostedConfigurationVersion) 

# GetAccountSettings
<a name="API_GetAccountSettings"></a>

Returns information about the status of the `DeletionProtection` parameter.

## Request Syntax
<a name="API_GetAccountSettings_RequestSyntax"></a>

```
GET /settings HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAccountSettings_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetAccountSettings_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAccountSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DeletionProtection": { 
      "Enabled": boolean,
      "ProtectionPeriodInMinutes": number
   }
}
```

## Response Elements
<a name="API_GetAccountSettings_ResponseElements"></a>

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

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

 ** [DeletionProtection](#API_GetAccountSettings_ResponseSyntax) **   <a name="appconfig-GetAccountSettings-response-DeletionProtection"></a>
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AWS AppConfig has called either [GetLatestConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) or [GetConfiguration](API_GetConfiguration.md) for the configuration profile or from the environment during the specified interval. The default interval for `ProtectionPeriodInMinutes` is 60.  
Type: [DeletionProtectionSettings](API_DeletionProtectionSettings.md) object

## Errors
<a name="API_GetAccountSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetAccountSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/GetAccountSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/GetAccountSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/GetAccountSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/GetAccountSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/GetAccountSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/GetAccountSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/GetAccountSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/GetAccountSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/GetAccountSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/GetAccountSettings) 

# GetApplication
<a name="API_GetApplication"></a>

Retrieves information about an application.

## Request Syntax
<a name="API_GetApplication_RequestSyntax"></a>

```
GET /applications/ApplicationId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_GetApplication_RequestSyntax) **   <a name="appconfig-GetApplication-request-uri-ApplicationId"></a>
The ID of the application you want to get.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_GetApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Description": "string",
   "Id": "string",
   "Name": "string"
}
```

## Response Elements
<a name="API_GetApplication_ResponseElements"></a>

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

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

 ** [Description](#API_GetApplication_ResponseSyntax) **   <a name="appconfig-GetApplication-response-Description"></a>
The description of the application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_GetApplication_ResponseSyntax) **   <a name="appconfig-GetApplication-response-Id"></a>
The application ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Name](#API_GetApplication_ResponseSyntax) **   <a name="appconfig-GetApplication-response-Name"></a>
The application name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Errors
<a name="API_GetApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetApplication_Examples"></a>

### Example
<a name="API_GetApplication_Example_1"></a>

This example illustrates one usage of GetApplication.

#### Sample Request
<a name="API_GetApplication_Example_1_Request"></a>

```
GET /applications/abc1234 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.get-application
X-Amz-Date: 20210917T180608Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetApplication_Example_1_Response"></a>

```
{
	"Description": "An application used for creating an example.",
	"Id": "abc1234",
	"Name": "example-application"
}
```

## See Also
<a name="API_GetApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/GetApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/GetApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/GetApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/GetApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/GetApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/GetApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/GetApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/GetApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/GetApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/GetApplication) 

# GetConfiguration
<a name="API_GetConfiguration"></a>

(Deprecated) Retrieves the latest deployed configuration.

**Important**  
Note the following important information.  
This API action is deprecated. Calls to receive configuration data should use the [StartConfigurationSession](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html) and [GetLatestConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) APIs instead. 
 [GetConfiguration](#API_GetConfiguration) is a priced call. For more information, see [Pricing](https://aws.amazon.com/systems-manager/pricing/).

## Request Syntax
<a name="API_GetConfiguration_RequestSyntax"></a>

```
GET /applications/Application/environments/Environment/configurations/Configuration?client_configuration_version=ClientConfigurationVersion&client_id=ClientId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Application](#API_GetConfiguration_RequestSyntax) **   <a name="appconfig-GetConfiguration-request-uri-Application"></a>
The application to get. Specify either the application name or the application ID.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** [ClientConfigurationVersion](#API_GetConfiguration_RequestSyntax) **   <a name="appconfig-GetConfiguration-request-uri-ClientConfigurationVersion"></a>
The configuration version returned in the most recent [GetConfiguration](#API_GetConfiguration) response.  
 AWS AppConfig uses the value of the `ClientConfigurationVersion` parameter to identify the configuration version on your clients. If you don’t send `ClientConfigurationVersion` with each call to [GetConfiguration](#API_GetConfiguration), your clients receive the current configuration. You are charged each time your clients receive a configuration.  
To avoid excess charges, we recommend you use the [StartConfigurationSession](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/StartConfigurationSession.html) and [GetLatestConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/GetLatestConfiguration.html) APIs, which track the client configuration version on your behalf. If you choose to continue using [GetConfiguration](#API_GetConfiguration), we recommend that you include the `ClientConfigurationVersion` value with every call to [GetConfiguration](#API_GetConfiguration). The value to use for `ClientConfigurationVersion` comes from the `ConfigurationVersion` attribute returned by [GetConfiguration](#API_GetConfiguration) when there is new or updated data, and should be saved for subsequent calls to [GetConfiguration](#API_GetConfiguration).
For more information about working with configurations, see [Retrieving feature flags and configuration data in AWS AppConfig](http://docs.aws.amazon.com/appconfig/latest/userguide/retrieving-feature-flags.html) in the * AWS AppConfig User Guide*.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [ClientId](#API_GetConfiguration_RequestSyntax) **   <a name="appconfig-GetConfiguration-request-uri-ClientId"></a>
The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AWS AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** [Configuration](#API_GetConfiguration_RequestSyntax) **   <a name="appconfig-GetConfiguration-request-uri-Configuration"></a>
The configuration to get. Specify either the configuration name or the configuration ID.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** [Environment](#API_GetConfiguration_RequestSyntax) **   <a name="appconfig-GetConfiguration-request-uri-Environment"></a>
The environment to get. Specify either the environment name or the environment ID.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

## Request Body
<a name="API_GetConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Configuration-Version: ConfigurationVersion
Content-Type: ContentType

Content
```

## Response Elements
<a name="API_GetConfiguration_ResponseElements"></a>

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

The response returns the following HTTP headers.

 ** [ConfigurationVersion](#API_GetConfiguration_ResponseSyntax) **   <a name="appconfig-GetConfiguration-response-ConfigurationVersion"></a>
The configuration version.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [ContentType](#API_GetConfiguration_ResponseSyntax) **   <a name="appconfig-GetConfiguration-response-ContentType"></a>
A standard MIME type describing the format of the configuration content. For more information, see [Content-Type](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17).

The response returns the following as the HTTP body.

 ** [Content](#API_GetConfiguration_ResponseSyntax) **   <a name="appconfig-GetConfiguration-response-Content"></a>
The content of the configuration or the configuration data.  
The `Content` attribute only contains data if the system finds new or updated configuration data. If there is no new or updated data and `ClientConfigurationVersion` matches the version of the current configuration, AWS AppConfig returns a `204 No Content` HTTP response code and the `Content` value will be empty.

## Errors
<a name="API_GetConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetConfiguration_Examples"></a>

### Example
<a name="API_GetConfiguration_Example_1"></a>

This example illustrates one usage of GetConfiguration.

#### Sample Request
<a name="API_GetConfiguration_Example_1_Request"></a>

```
GET /applications/test-application/environments/Example-Environment/configurations/Example-Configuration-Profile?client_id=test-id 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.get-configuration
X-Amz-Date: 20210917T215745Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetConfiguration_Example_1_Response"></a>

```
{
    "ConfigurationVersion": "1",
    "ContentType": "application/octet-stream"
}
```

## See Also
<a name="API_GetConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/GetConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/GetConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/GetConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/GetConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/GetConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/GetConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/GetConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/GetConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/GetConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/GetConfiguration) 

# GetConfigurationProfile
<a name="API_GetConfigurationProfile"></a>

Retrieves information about a configuration profile.

## Request Syntax
<a name="API_GetConfigurationProfile_RequestSyntax"></a>

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

## URI Request Parameters
<a name="API_GetConfigurationProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_GetConfigurationProfile_RequestSyntax) **   <a name="appconfig-GetConfigurationProfile-request-uri-ApplicationId"></a>
The ID of the application that includes the configuration profile you want to get.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ConfigurationProfileId](#API_GetConfigurationProfile_RequestSyntax) **   <a name="appconfig-GetConfigurationProfile-request-uri-ConfigurationProfileId"></a>
The ID of the configuration profile that you want to get.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_GetConfigurationProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetConfigurationProfile_ResponseSyntax"></a>

```
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
<a name="API_GetConfigurationProfile_ResponseElements"></a>

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](#API_GetConfigurationProfile_ResponseSyntax) **   <a name="appconfig-GetConfigurationProfile-response-ApplicationId"></a>
The application ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Description](#API_GetConfigurationProfile_ResponseSyntax) **   <a name="appconfig-GetConfigurationProfile-response-Description"></a>
The configuration profile description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_GetConfigurationProfile_ResponseSyntax) **   <a name="appconfig-GetConfigurationProfile-response-Id"></a>
The configuration profile ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [KmsKeyArn](#API_GetConfigurationProfile_ResponseSyntax) **   <a name="appconfig-GetConfigurationProfile-response-KmsKeyArn"></a>
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]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [KmsKeyIdentifier](#API_GetConfigurationProfile_ResponseSyntax) **   <a name="appconfig-GetConfigurationProfile-response-KmsKeyIdentifier"></a>
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](#API_GetConfigurationProfile_ResponseSyntax) **   <a name="appconfig-GetConfigurationProfile-response-LocationUri"></a>
The URI location of the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Name](#API_GetConfigurationProfile_ResponseSyntax) **   <a name="appconfig-GetConfigurationProfile-response-Name"></a>
The name of the configuration profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [RetrievalRoleArn](#API_GetConfigurationProfile_ResponseSyntax) **   <a name="appconfig-GetConfigurationProfile-response-RetrievalRoleArn"></a>
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|aws-eusc):(iam)::\d{12}:role[/].*)$` 

 ** [Type](#API_GetConfigurationProfile_ResponseSyntax) **   <a name="appconfig-GetConfigurationProfile-response-Type"></a>
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](#API_GetConfigurationProfile_ResponseSyntax) **   <a name="appconfig-GetConfigurationProfile-response-Validators"></a>
A list of methods for validating the configuration.  
Type: Array of [Validator](API_Validator.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.

## Errors
<a name="API_GetConfigurationProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetConfigurationProfile_Examples"></a>

### Example
<a name="API_GetConfigurationProfile_Example_1"></a>

This example illustrates one usage of GetConfigurationProfile.

#### Sample Request
<a name="API_GetConfigurationProfile_Example_1_Request"></a>

```
GET /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.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
<a name="API_GetConfigurationProfile_Example_1_Response"></a>

```
{
    "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
<a name="API_GetConfigurationProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/GetConfigurationProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/GetConfigurationProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/GetConfigurationProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/GetConfigurationProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/GetConfigurationProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/GetConfigurationProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/GetConfigurationProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/GetConfigurationProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/GetConfigurationProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/GetConfigurationProfile) 

# GetDeployment
<a name="API_GetDeployment"></a>

Retrieves information about a configuration deployment.

## Request Syntax
<a name="API_GetDeployment_RequestSyntax"></a>

```
GET /applications/ApplicationId/environments/EnvironmentId/deployments/DeploymentNumber HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDeployment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_GetDeployment_RequestSyntax) **   <a name="appconfig-GetDeployment-request-uri-ApplicationId"></a>
The ID of the application that includes the deployment you want to get.   
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [DeploymentNumber](#API_GetDeployment_RequestSyntax) **   <a name="appconfig-GetDeployment-request-uri-DeploymentNumber"></a>
The sequence number of the deployment.  
Required: Yes

 ** [EnvironmentId](#API_GetDeployment_RequestSyntax) **   <a name="appconfig-GetDeployment-request-uri-EnvironmentId"></a>
The ID of the environment that includes the deployment you want to get.   
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_GetDeployment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDeployment_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "AppliedExtensions": [ 
      { 
         "ExtensionAssociationId": "string",
         "ExtensionId": "string",
         "Parameters": { 
            "string" : "string" 
         },
         "VersionNumber": number
      }
   ],
   "CompletedAt": "string",
   "ConfigurationLocationUri": "string",
   "ConfigurationName": "string",
   "ConfigurationProfileId": "string",
   "ConfigurationVersion": "string",
   "DeploymentDurationInMinutes": number,
   "DeploymentNumber": number,
   "DeploymentStrategyId": "string",
   "Description": "string",
   "EnvironmentId": "string",
   "EventLog": [ 
      { 
         "ActionInvocations": [ 
            { 
               "ActionName": "string",
               "ErrorCode": "string",
               "ErrorMessage": "string",
               "ExtensionIdentifier": "string",
               "InvocationId": "string",
               "RoleArn": "string",
               "Uri": "string"
            }
         ],
         "Description": "string",
         "EventType": "string",
         "OccurredAt": "string",
         "TriggeredBy": "string"
      }
   ],
   "FinalBakeTimeInMinutes": number,
   "GrowthFactor": number,
   "GrowthType": "string",
   "KmsKeyArn": "string",
   "KmsKeyIdentifier": "string",
   "PercentageComplete": number,
   "StartedAt": "string",
   "State": "string",
   "VersionLabel": "string"
}
```

## Response Elements
<a name="API_GetDeployment_ResponseElements"></a>

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](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-ApplicationId"></a>
The ID of the application that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [AppliedExtensions](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-AppliedExtensions"></a>
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.  
Type: Array of [AppliedExtension](API_AppliedExtension.md) objects

 ** [CompletedAt](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-CompletedAt"></a>
The time the deployment completed.   
Type: Timestamp

 ** [ConfigurationLocationUri](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-ConfigurationLocationUri"></a>
Information about the source location of the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [ConfigurationName](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-ConfigurationName"></a>
The name of the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [ConfigurationProfileId](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-ConfigurationProfileId"></a>
The ID of the configuration profile that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [ConfigurationVersion](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-ConfigurationVersion"></a>
The configuration version that was deployed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [DeploymentDurationInMinutes](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-DeploymentDurationInMinutes"></a>
Total amount of time the deployment lasted.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [DeploymentNumber](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-DeploymentNumber"></a>
The sequence number of the deployment.  
Type: Integer

 ** [DeploymentStrategyId](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-DeploymentStrategyId"></a>
The ID of the deployment strategy that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Description](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-Description"></a>
The description of the deployment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [EnvironmentId](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-EnvironmentId"></a>
The ID of the environment that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [EventLog](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-EventLog"></a>
A list containing all events related to a deployment. The most recent events are displayed first.  
Type: Array of [DeploymentEvent](API_DeploymentEvent.md) objects

 ** [FinalBakeTimeInMinutes](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-FinalBakeTimeInMinutes"></a>
The amount of time that AWS AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [GrowthFactor](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-GrowthFactor"></a>
The percentage of targets to receive a deployed configuration during each interval.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.

 ** [GrowthType](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-GrowthType"></a>
The algorithm used to define how percentage grew over time.  
Type: String  
Valid Values: `LINEAR | EXPONENTIAL` 

 ** [KmsKeyArn](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-KmsKeyArn"></a>
The Amazon Resource Name of the AWS Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in AWS Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in AWS Systems Manager Parameter Store.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [KmsKeyIdentifier](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-KmsKeyIdentifier"></a>
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.

 ** [PercentageComplete](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-PercentageComplete"></a>
The percentage of targets for which the deployment is available.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.

 ** [StartedAt](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-StartedAt"></a>
The time the deployment started.  
Type: Timestamp

 ** [State](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-State"></a>
The state of the deployment.  
Type: String  
Valid Values: `BAKING | VALIDATING | DEPLOYING | COMPLETE | ROLLING_BACK | ROLLED_BACK | REVERTED` 

 ** [VersionLabel](#API_GetDeployment_ResponseSyntax) **   <a name="appconfig-GetDeployment-response-VersionLabel"></a>
A user-defined label for an AWS AppConfig hosted configuration version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*[^0-9].*` 

## Errors
<a name="API_GetDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetDeployment_Examples"></a>

### Example
<a name="API_GetDeployment_Example_1"></a>

This example illustrates one usage of GetDeployment.

#### Sample Request
<a name="API_GetDeployment_Example_1_Request"></a>

```
GET /applications/abc1234/environments/54j1r29/deployments/1 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.get-deployment
X-Amz-Date: 20210917T222704Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetDeployment_Example_1_Response"></a>

```
{
    "ApplicationId": "abc1234",
    "EnvironmentId": "54j1r29",
    "DeploymentStrategyId": "1225qzk",
    "ConfigurationProfileId": "ur8hx2f",
    "DeploymentNumber": 1,
    "ConfigurationName": "Example-Configuration-Profile",
    "ConfigurationLocationUri": "ssm-parameter://Example-Parameter",
    "ConfigurationVersion": "1",
    "DeploymentDurationInMinutes": 15,
    "GrowthType": "LINEAR",
    "GrowthFactor": 25.0,
    "FinalBakeTimeInMinutes": 0,
    "State": "COMPLETE",
    "EventLog": [
        {
            "EventType": "DEPLOYMENT_COMPLETED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Deployment completed",
            "OccurredAt": "2021-09-17T21:59:03.888000+00:00"
        },
        {
            "EventType": "BAKE_TIME_STARTED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Deployment bake time started",
            "OccurredAt": "2021-09-17T21:58:57.722000+00:00"
        },
        {
            "EventType": "PERCENTAGE_UPDATED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Configuration available to 100.00% of clients",
            "OccurredAt": "2021-09-17T21:55:56.816000+00:00"
        },
        {
            "EventType": "PERCENTAGE_UPDATED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Configuration available to 75.00% of clients",
            "OccurredAt": "2021-09-17T21:52:56.567000+00:00"
        },
        {
            "EventType": "PERCENTAGE_UPDATED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Configuration available to 50.00% of clients",
            "OccurredAt": "2021-09-17T21:49:55.737000+00:00"
        },
        {
            "EventType": "PERCENTAGE_UPDATED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Configuration available to 25.00% of clients",
            "OccurredAt": "2021-09-17T21:46:55.187000+00:00"
        },
        {
            "EventType": "DEPLOYMENT_STARTED",
            "TriggeredBy": "USER",
            "Description": "Deployment started",
            "OccurredAt": "2021-09-17T21:43:54.205000+00:00"
        }
    ],
    "PercentageComplete": 100.0,
    "StartedAt": "2021-09-17T21:43:54.205000+00:00",
    "CompletedAt": "2021-09-17T21:59:03.888000+00:00"
}
```

## See Also
<a name="API_GetDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/GetDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/GetDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/GetDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/GetDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/GetDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/GetDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/GetDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/GetDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/GetDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/GetDeployment) 

# GetDeploymentStrategy
<a name="API_GetDeploymentStrategy"></a>

Retrieves information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

## Request Syntax
<a name="API_GetDeploymentStrategy_RequestSyntax"></a>

```
GET /deploymentstrategies/DeploymentStrategyId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDeploymentStrategy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DeploymentStrategyId](#API_GetDeploymentStrategy_RequestSyntax) **   <a name="appconfig-GetDeploymentStrategy-request-uri-DeploymentStrategyId"></a>
The ID of the deployment strategy to get.  
Pattern: `(^[a-z0-9]{4,7}$|^AppConfig\.[A-Za-z0-9]{9,40}$)`   
Required: Yes

## Request Body
<a name="API_GetDeploymentStrategy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDeploymentStrategy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DeploymentDurationInMinutes": number,
   "Description": "string",
   "FinalBakeTimeInMinutes": number,
   "GrowthFactor": number,
   "GrowthType": "string",
   "Id": "string",
   "Name": "string",
   "ReplicateTo": "string"
}
```

## Response Elements
<a name="API_GetDeploymentStrategy_ResponseElements"></a>

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

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

 ** [DeploymentDurationInMinutes](#API_GetDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-GetDeploymentStrategy-response-DeploymentDurationInMinutes"></a>
Total amount of time the deployment lasted.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [Description](#API_GetDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-GetDeploymentStrategy-response-Description"></a>
The description of the deployment strategy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [FinalBakeTimeInMinutes](#API_GetDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-GetDeploymentStrategy-response-FinalBakeTimeInMinutes"></a>
The amount of time that AWS AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [GrowthFactor](#API_GetDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-GetDeploymentStrategy-response-GrowthFactor"></a>
The percentage of targets that received a deployed configuration during each interval.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.

 ** [GrowthType](#API_GetDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-GetDeploymentStrategy-response-GrowthType"></a>
The algorithm used to define how percentage grew over time.  
Type: String  
Valid Values: `LINEAR | EXPONENTIAL` 

 ** [Id](#API_GetDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-GetDeploymentStrategy-response-Id"></a>
The deployment strategy ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Name](#API_GetDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-GetDeploymentStrategy-response-Name"></a>
The name of the deployment strategy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [ReplicateTo](#API_GetDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-GetDeploymentStrategy-response-ReplicateTo"></a>
Save the deployment strategy to a Systems Manager (SSM) document.  
Type: String  
Valid Values: `NONE | SSM_DOCUMENT` 

## Errors
<a name="API_GetDeploymentStrategy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetDeploymentStrategy_Examples"></a>

### Example
<a name="API_GetDeploymentStrategy_Example_1"></a>

This example illustrates one usage of GetDeploymentStrategy.

#### Sample Request
<a name="API_GetDeploymentStrategy_Example_1_Request"></a>

```
GET /deploymentstrategies/1225qzk 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.get-deployment-strategy
X-Amz-Date: 20210917T224000Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetDeploymentStrategy_Example_1_Response"></a>

```
{
    "Id": "1225qzk",
    "Name": "Example-Deployment",
    "DeploymentDurationInMinutes": 15,
    "GrowthType": "LINEAR",
    "GrowthFactor": 25.0,
    "FinalBakeTimeInMinutes": 0,
    "ReplicateTo": "SSM_DOCUMENT"
}
```

## See Also
<a name="API_GetDeploymentStrategy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/GetDeploymentStrategy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/GetDeploymentStrategy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/GetDeploymentStrategy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/GetDeploymentStrategy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/GetDeploymentStrategy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/GetDeploymentStrategy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/GetDeploymentStrategy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/GetDeploymentStrategy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/GetDeploymentStrategy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/GetDeploymentStrategy) 

# GetEnvironment
<a name="API_GetEnvironment"></a>

Retrieves information about an environment. An environment is a deployment group of AWS AppConfig applications, such as applications in a `Production` environment or in an `EU_Region` environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AWS AppConfig roles back the configuration.

## Request Syntax
<a name="API_GetEnvironment_RequestSyntax"></a>

```
GET /applications/ApplicationId/environments/EnvironmentId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetEnvironment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_GetEnvironment_RequestSyntax) **   <a name="appconfig-GetEnvironment-request-uri-ApplicationId"></a>
The ID of the application that includes the environment you want to get.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [EnvironmentId](#API_GetEnvironment_RequestSyntax) **   <a name="appconfig-GetEnvironment-request-uri-EnvironmentId"></a>
The ID of the environment that you want to get.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_GetEnvironment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetEnvironment_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Description": "string",
   "Id": "string",
   "Monitors": [ 
      { 
         "AlarmArn": "string",
         "AlarmRoleArn": "string"
      }
   ],
   "Name": "string",
   "State": "string"
}
```

## Response Elements
<a name="API_GetEnvironment_ResponseElements"></a>

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](#API_GetEnvironment_ResponseSyntax) **   <a name="appconfig-GetEnvironment-response-ApplicationId"></a>
The application ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Description](#API_GetEnvironment_ResponseSyntax) **   <a name="appconfig-GetEnvironment-response-Description"></a>
The description of the environment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_GetEnvironment_ResponseSyntax) **   <a name="appconfig-GetEnvironment-response-Id"></a>
The environment ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Monitors](#API_GetEnvironment_ResponseSyntax) **   <a name="appconfig-GetEnvironment-response-Monitors"></a>
Amazon CloudWatch alarms monitored during the deployment.  
Type: Array of [Monitor](API_Monitor.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

 ** [Name](#API_GetEnvironment_ResponseSyntax) **   <a name="appconfig-GetEnvironment-response-Name"></a>
The name of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [State](#API_GetEnvironment_ResponseSyntax) **   <a name="appconfig-GetEnvironment-response-State"></a>
The state of the environment. An environment can be in one of the following states: `READY_FOR_DEPLOYMENT`, `DEPLOYING`, `ROLLING_BACK`, or `ROLLED_BACK`   
Type: String  
Valid Values: `READY_FOR_DEPLOYMENT | DEPLOYING | ROLLING_BACK | ROLLED_BACK | REVERTED` 

## Errors
<a name="API_GetEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetEnvironment_Examples"></a>

### Example
<a name="API_GetEnvironment_Example_1"></a>

This example illustrates one usage of GetEnvironment.

#### Sample Request
<a name="API_GetEnvironment_Example_1_Request"></a>

```
GET /applications/abc1234/environments/54j1r29 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.get-environment
X-Amz-Date: 20210917T224423Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetEnvironment_Example_1_Response"></a>

```
{
    "ApplicationId": "abc1234",
    "Id": "54j1r29",
    "Name": "Example-Environment",
    "State": "ReadyForDeployment"
}
```

## See Also
<a name="API_GetEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/GetEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/GetEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/GetEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/GetEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/GetEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/GetEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/GetEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/GetEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/GetEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/GetEnvironment) 

# GetExtension
<a name="API_GetExtension"></a>

Returns information about an AWS AppConfig extension.

## Request Syntax
<a name="API_GetExtension_RequestSyntax"></a>

```
GET /extensions/ExtensionIdentifier?version_number=VersionNumber HTTP/1.1
```

## URI Request Parameters
<a name="API_GetExtension_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ExtensionIdentifier](#API_GetExtension_RequestSyntax) **   <a name="appconfig-GetExtension-request-uri-ExtensionIdentifier"></a>
The name, the ID, or the Amazon Resource Name (ARN) of the extension.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [VersionNumber](#API_GetExtension_RequestSyntax) **   <a name="appconfig-GetExtension-request-uri-VersionNumber"></a>
The extension version number. If no version number was defined, AWS AppConfig uses the highest version.

## Request Body
<a name="API_GetExtension_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetExtension_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Actions": { 
      "string" : [ 
         { 
            "Description": "string",
            "Name": "string",
            "RoleArn": "string",
            "Uri": "string"
         }
      ]
   },
   "Arn": "string",
   "Description": "string",
   "Id": "string",
   "Name": "string",
   "Parameters": { 
      "string" : { 
         "Description": "string",
         "Dynamic": boolean,
         "Required": boolean
      }
   },
   "VersionNumber": number
}
```

## Response Elements
<a name="API_GetExtension_ResponseElements"></a>

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

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

 ** [Actions](#API_GetExtension_ResponseSyntax) **   <a name="appconfig-GetExtension-response-Actions"></a>
The actions defined in the extension.  
Type: String to array of [Action](API_Action.md) objects map  
Map Entries: Maximum number of 5 items.  
Valid Keys: `PRE_CREATE_HOSTED_CONFIGURATION_VERSION | PRE_START_DEPLOYMENT | AT_DEPLOYMENT_TICK | ON_DEPLOYMENT_START | ON_DEPLOYMENT_STEP | ON_DEPLOYMENT_BAKING | ON_DEPLOYMENT_COMPLETE | ON_DEPLOYMENT_ROLLED_BACK`   
Array Members: Fixed number of 1 item.

 ** [Arn](#API_GetExtension_ResponseSyntax) **   <a name="appconfig-GetExtension-response-Arn"></a>
The system-generated Amazon Resource Name (ARN) for the extension.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [Description](#API_GetExtension_ResponseSyntax) **   <a name="appconfig-GetExtension-response-Description"></a>
Information about the extension.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_GetExtension_ResponseSyntax) **   <a name="appconfig-GetExtension-response-Id"></a>
The system-generated ID of the extension.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Name](#API_GetExtension_ResponseSyntax) **   <a name="appconfig-GetExtension-response-Name"></a>
The extension name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [Parameters](#API_GetExtension_ResponseSyntax) **   <a name="appconfig-GetExtension-response-Parameters"></a>
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AWS AppConfig resource by using the `CreateExtensionAssociation` API action. For AWS Lambda extension actions, these parameters are included in the Lambda request object.  
Type: String to [Parameter](API_Parameter.md) object map  
Map Entries: Maximum number of 10 items.  
Key Pattern: `^[^\/#:\n]{1,64}$` 

 ** [VersionNumber](#API_GetExtension_ResponseSyntax) **   <a name="appconfig-GetExtension-response-VersionNumber"></a>
The extension version number.  
Type: Integer

## Errors
<a name="API_GetExtension_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetExtension_Examples"></a>

### Example
<a name="API_GetExtension_Example_1"></a>

This example illustrates one usage of GetExtension.

#### Sample Request
<a name="API_GetExtension_Example_1_Request"></a>

```
GET /extensions/my-test-extension HTTP/1.1
Host: appconfig.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/appconfig.get-extension
X-Amz-Date: 20220803T220925Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetExtension_Example_1_Response"></a>

```
{
	"Actions": {
		"PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [{
			"Description": null,
			"Name": "S3backup",
			"RoleArn": "arn:aws:iam::111122223333:role/mytestextensionrole",
			"Uri": "arn:aws:lambda:us-west-2:111122223333:function:mytestfunction"
		}]
	}
```

## See Also
<a name="API_GetExtension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/GetExtension) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/GetExtension) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/GetExtension) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/GetExtension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/GetExtension) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/GetExtension) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/GetExtension) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/GetExtension) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/GetExtension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/GetExtension) 

# GetExtensionAssociation
<a name="API_GetExtensionAssociation"></a>

Returns information about an AWS AppConfig extension association. For more information about extensions and associations, see [Extending workflows](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the * AWS AppConfig User Guide*.

## Request Syntax
<a name="API_GetExtensionAssociation_RequestSyntax"></a>

```
GET /extensionassociations/ExtensionAssociationId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetExtensionAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ExtensionAssociationId](#API_GetExtensionAssociation_RequestSyntax) **   <a name="appconfig-GetExtensionAssociation-request-uri-ExtensionAssociationId"></a>
The extension association ID to get.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_GetExtensionAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetExtensionAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "ExtensionArn": "string",
   "ExtensionVersionNumber": number,
   "Id": "string",
   "Parameters": { 
      "string" : "string" 
   },
   "ResourceArn": "string"
}
```

## Response Elements
<a name="API_GetExtensionAssociation_ResponseElements"></a>

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

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

 ** [Arn](#API_GetExtensionAssociation_ResponseSyntax) **   <a name="appconfig-GetExtensionAssociation-response-Arn"></a>
The system-generated Amazon Resource Name (ARN) for the extension.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [ExtensionArn](#API_GetExtensionAssociation_ResponseSyntax) **   <a name="appconfig-GetExtensionAssociation-response-ExtensionArn"></a>
The ARN of the extension defined in the association.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [ExtensionVersionNumber](#API_GetExtensionAssociation_ResponseSyntax) **   <a name="appconfig-GetExtensionAssociation-response-ExtensionVersionNumber"></a>
The version number for the extension defined in the association.  
Type: Integer

 ** [Id](#API_GetExtensionAssociation_ResponseSyntax) **   <a name="appconfig-GetExtensionAssociation-response-Id"></a>
The system-generated ID for the association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Parameters](#API_GetExtensionAssociation_ResponseSyntax) **   <a name="appconfig-GetExtensionAssociation-response-Parameters"></a>
The parameter names and values defined in the association.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Pattern: `^[^\/#:\n]{1,64}$`   
Value Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [ResourceArn](#API_GetExtensionAssociation_ResponseSyntax) **   <a name="appconfig-GetExtensionAssociation-response-ResourceArn"></a>
The ARNs of applications, configuration profiles, or environments defined in the association.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

## Errors
<a name="API_GetExtensionAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetExtensionAssociation_Examples"></a>

### Example
<a name="API_GetExtensionAssociation_Example_1"></a>

This example illustrates one usage of GetExtensionAssociation.

#### Sample Request
<a name="API_GetExtensionAssociation_Example_1_Request"></a>

```
GET /extensionassociations/rnekru4 HTTP/1.1
Host: appconfig.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/appconfig.get-extension-association
X-Amz-Date: 20220803T221553Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetExtensionAssociation_Example_1_Response"></a>

```
{
	"Arn": null,
	"ExtensionArn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1",
	"ExtensionVersionNumber": 1,
	"Id": "rnekru4",
	"Parameters": {
		"MyParamKey": "MyParamValue"
	},
	"ResourceArn": "arn:aws:appconfig:us-west-2:111122223333:application/xlmExample"
}
```

## See Also
<a name="API_GetExtensionAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/GetExtensionAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/GetExtensionAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/GetExtensionAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/GetExtensionAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/GetExtensionAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/GetExtensionAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/GetExtensionAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/GetExtensionAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/GetExtensionAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/GetExtensionAssociation) 

# GetHostedConfigurationVersion
<a name="API_GetHostedConfigurationVersion"></a>

Retrieves information about a specific configuration version.

## Request Syntax
<a name="API_GetHostedConfigurationVersion_RequestSyntax"></a>

```
GET /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/hostedconfigurationversions/VersionNumber HTTP/1.1
```

## URI Request Parameters
<a name="API_GetHostedConfigurationVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_GetHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ConfigurationProfileId](#API_GetHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-request-uri-ConfigurationProfileId"></a>
The configuration profile ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [VersionNumber](#API_GetHostedConfigurationVersion_RequestSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-request-uri-VersionNumber"></a>
The version.  
Required: Yes

## Request Body
<a name="API_GetHostedConfigurationVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetHostedConfigurationVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Application-Id: ApplicationId
Configuration-Profile-Id: ConfigurationProfileId
Version-Number: VersionNumber
Description: Description
Content-Type: ContentType
VersionLabel: VersionLabel
KmsKeyArn: KmsKeyArn

Content
```

## Response Elements
<a name="API_GetHostedConfigurationVersion_ResponseElements"></a>

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

The response returns the following HTTP headers.

 ** [ApplicationId](#API_GetHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-response-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}` 

 ** [ConfigurationProfileId](#API_GetHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-response-ConfigurationProfileId"></a>
The configuration profile ID.  
Pattern: `[a-z0-9]{4,7}` 

 ** [ContentType](#API_GetHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-response-ContentType"></a>
A standard MIME type describing the format of the configuration content. For more information, see [Content-Type](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17).  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Description](#API_GetHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-response-Description"></a>
A description of the configuration.  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [KmsKeyArn](#API_GetHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-response-KmsKeyArn"></a>
The Amazon Resource Name of the AWS Key Management Service key that was used to encrypt this specific version of the configuration data in the AWS AppConfig hosted configuration store.  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [VersionLabel](#API_GetHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-response-VersionLabel"></a>
A user-defined label for an AWS AppConfig hosted configuration version.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*[^0-9].*` 

 ** [VersionNumber](#API_GetHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-response-VersionNumber"></a>
The configuration version.

The response returns the following as the HTTP body.

 ** [Content](#API_GetHostedConfigurationVersion_ResponseSyntax) **   <a name="appconfig-GetHostedConfigurationVersion-response-Content"></a>
The content of the configuration or the configuration data.

## Errors
<a name="API_GetHostedConfigurationVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetHostedConfigurationVersion_Examples"></a>

### Example
<a name="API_GetHostedConfigurationVersion_Example_1"></a>

This example illustrates one usage of GetHostedConfigurationVersion.

#### Sample Request
<a name="API_GetHostedConfigurationVersion_Example_1_Request"></a>

```
GET /applications/abc1234/configurationprofiles/ur8hx2f/hostedconfigurationversions/1 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.get-hosted-configuration-version
X-Amz-Date: 20210917T224843Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetHostedConfigurationVersion_Example_1_Response"></a>

```
{
    "ApplicationId": "abc1234",
    "ConfigurationProfileId": "ur8hx2f",
    "VersionNumber": "1",
    "ContentType": "application/json"
}
```

## See Also
<a name="API_GetHostedConfigurationVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/GetHostedConfigurationVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/GetHostedConfigurationVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/GetHostedConfigurationVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/GetHostedConfigurationVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/GetHostedConfigurationVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/GetHostedConfigurationVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/GetHostedConfigurationVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/GetHostedConfigurationVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/GetHostedConfigurationVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/GetHostedConfigurationVersion) 

# ListApplications
<a name="API_ListApplications"></a>

Lists all applications in your AWS account.

## Request Syntax
<a name="API_ListApplications_RequestSyntax"></a>

```
GET /applications?max_results=MaxResults&next_token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListApplications_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListApplications_RequestSyntax) **   <a name="appconfig-ListApplications-request-uri-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_ListApplications_RequestSyntax) **   <a name="appconfig-ListApplications-request-uri-NextToken"></a>
A token to start the list. Next token is a pagination token generated by AWS AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results.   
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_ListApplications_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListApplications_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "Description": "string",
         "Id": "string",
         "Name": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListApplications_ResponseElements"></a>

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

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

 ** [Items](#API_ListApplications_ResponseSyntax) **   <a name="appconfig-ListApplications-response-Items"></a>
The elements from this collection.  
Type: Array of [Application](API_Application.md) objects

 ** [NextToken](#API_ListApplications_ResponseSyntax) **   <a name="appconfig-ListApplications-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListApplications_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## Examples
<a name="API_ListApplications_Examples"></a>

### Example
<a name="API_ListApplications_Example_1"></a>

This example illustrates one usage of ListApplications.

#### Sample Request
<a name="API_ListApplications_Example_1_Request"></a>

```
GET /applications 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.list-applications
X-Amz-Date: 20210917T231257Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_ListApplications_Example_1_Response"></a>

```
{
    "Items": [
        {
            "Id": "abc1234",
            "Name": "example-application",
            "Description": "An application used for creating an example."
        },
        {
            "Id": "rwalwu7",
            "Name": "Example-Application"
        }
    ]
}
```

## See Also
<a name="API_ListApplications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/ListApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/ListApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/ListApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/ListApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/ListApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/ListApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/ListApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/ListApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/ListApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/ListApplications) 

# ListConfigurationProfiles
<a name="API_ListConfigurationProfiles"></a>

Lists the configuration profiles for an application.

## Request Syntax
<a name="API_ListConfigurationProfiles_RequestSyntax"></a>

```
GET /applications/ApplicationId/configurationprofiles?max_results=MaxResults&next_token=NextToken&type=Type HTTP/1.1
```

## URI Request Parameters
<a name="API_ListConfigurationProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_ListConfigurationProfiles_RequestSyntax) **   <a name="appconfig-ListConfigurationProfiles-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [MaxResults](#API_ListConfigurationProfiles_RequestSyntax) **   <a name="appconfig-ListConfigurationProfiles-request-uri-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_ListConfigurationProfiles_RequestSyntax) **   <a name="appconfig-ListConfigurationProfiles-request-uri-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Type](#API_ListConfigurationProfiles_RequestSyntax) **   <a name="appconfig-ListConfigurationProfiles-request-uri-Type"></a>
A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration.  
Pattern: `^[a-zA-Z\.]+` 

## Request Body
<a name="API_ListConfigurationProfiles_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListConfigurationProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "ApplicationId": "string",
         "Id": "string",
         "LocationUri": "string",
         "Name": "string",
         "Type": "string",
         "ValidatorTypes": [ "string" ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListConfigurationProfiles_ResponseElements"></a>

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

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

 ** [Items](#API_ListConfigurationProfiles_ResponseSyntax) **   <a name="appconfig-ListConfigurationProfiles-response-Items"></a>
The elements from this collection.  
Type: Array of [ConfigurationProfileSummary](API_ConfigurationProfileSummary.md) objects

 ** [NextToken](#API_ListConfigurationProfiles_ResponseSyntax) **   <a name="appconfig-ListConfigurationProfiles-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListConfigurationProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_ListConfigurationProfiles_Examples"></a>

### Example
<a name="API_ListConfigurationProfiles_Example_1"></a>

This example illustrates one usage of ListConfigurationProfiles.

#### Sample Request
<a name="API_ListConfigurationProfiles_Example_1_Request"></a>

```
GET /applications/abc1234/configurationprofiles 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.list-configuration-profiles
X-Amz-Date: 20210920T174422Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_ListConfigurationProfiles_Example_1_Response"></a>

```
{
    "Items": [
        {
            "ApplicationId": "abc1234",
            "Id": "ur8hx2f",
            "Name": "Example-Configuration-Profile",
            "LocationUri": "ssm-parameter://Example-Parameter"
        }
    ]
}
```

## See Also
<a name="API_ListConfigurationProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/ListConfigurationProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/ListConfigurationProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/ListConfigurationProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/ListConfigurationProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/ListConfigurationProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/ListConfigurationProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/ListConfigurationProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/ListConfigurationProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/ListConfigurationProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/ListConfigurationProfiles) 

# ListDeployments
<a name="API_ListDeployments"></a>

Lists the deployments for an environment in descending deployment number order.

## Request Syntax
<a name="API_ListDeployments_RequestSyntax"></a>

```
GET /applications/ApplicationId/environments/EnvironmentId/deployments?max_results=MaxResults&next_token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDeployments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_ListDeployments_RequestSyntax) **   <a name="appconfig-ListDeployments-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [EnvironmentId](#API_ListDeployments_RequestSyntax) **   <a name="appconfig-ListDeployments-request-uri-EnvironmentId"></a>
The environment ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [MaxResults](#API_ListDeployments_RequestSyntax) **   <a name="appconfig-ListDeployments-request-uri-MaxResults"></a>
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.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_ListDeployments_RequestSyntax) **   <a name="appconfig-ListDeployments-request-uri-NextToken"></a>
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.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_ListDeployments_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDeployments_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CompletedAt": "string",
         "ConfigurationName": "string",
         "ConfigurationVersion": "string",
         "DeploymentDurationInMinutes": number,
         "DeploymentNumber": number,
         "FinalBakeTimeInMinutes": number,
         "GrowthFactor": number,
         "GrowthType": "string",
         "PercentageComplete": number,
         "StartedAt": "string",
         "State": "string",
         "VersionLabel": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDeployments_ResponseElements"></a>

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

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

 ** [Items](#API_ListDeployments_ResponseSyntax) **   <a name="appconfig-ListDeployments-response-Items"></a>
The elements from this collection.  
Type: Array of [DeploymentSummary](API_DeploymentSummary.md) objects

 ** [NextToken](#API_ListDeployments_ResponseSyntax) **   <a name="appconfig-ListDeployments-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListDeployments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_ListDeployments_Examples"></a>

### Example
<a name="API_ListDeployments_Example_1"></a>

This example illustrates one usage of ListDeployments.

#### Sample Request
<a name="API_ListDeployments_Example_1_Request"></a>

```
GET /applications/abc1234/environments/54j1r29/deployments 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.list-deployments
X-Amz-Date: 20210920T182141Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_ListDeployments_Example_1_Response"></a>

```
{
    "Items": [
        {
            "DeploymentNumber": 1,
            "ConfigurationName": "Example-Configuration-Profile",
            "ConfigurationVersion": "1",
            "DeploymentDurationInMinutes": 15,
            "GrowthType": "LINEAR",
            "GrowthFactor": 25.0,
            "FinalBakeTimeInMinutes": 0,
            "State": "COMPLETE",
            "PercentageComplete": 100.0,
            "StartedAt": "2021-09-17T21:43:54.205000+00:00",
            "CompletedAt": "2021-09-17T21:59:03.888000+00:00"
        }
    ]
}
```

## See Also
<a name="API_ListDeployments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/ListDeployments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/ListDeployments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/ListDeployments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/ListDeployments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/ListDeployments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/ListDeployments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/ListDeployments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/ListDeployments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/ListDeployments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/ListDeployments) 

# ListDeploymentStrategies
<a name="API_ListDeploymentStrategies"></a>

Lists deployment strategies.

## Request Syntax
<a name="API_ListDeploymentStrategies_RequestSyntax"></a>

```
GET /deploymentstrategies?max_results=MaxResults&next_token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDeploymentStrategies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListDeploymentStrategies_RequestSyntax) **   <a name="appconfig-ListDeploymentStrategies-request-uri-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_ListDeploymentStrategies_RequestSyntax) **   <a name="appconfig-ListDeploymentStrategies-request-uri-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_ListDeploymentStrategies_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDeploymentStrategies_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "DeploymentDurationInMinutes": number,
         "Description": "string",
         "FinalBakeTimeInMinutes": number,
         "GrowthFactor": number,
         "GrowthType": "string",
         "Id": "string",
         "Name": "string",
         "ReplicateTo": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDeploymentStrategies_ResponseElements"></a>

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

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

 ** [Items](#API_ListDeploymentStrategies_ResponseSyntax) **   <a name="appconfig-ListDeploymentStrategies-response-Items"></a>
The elements from this collection.  
Type: Array of [DeploymentStrategy](API_DeploymentStrategy.md) objects

 ** [NextToken](#API_ListDeploymentStrategies_ResponseSyntax) **   <a name="appconfig-ListDeploymentStrategies-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListDeploymentStrategies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## Examples
<a name="API_ListDeploymentStrategies_Examples"></a>

### Example
<a name="API_ListDeploymentStrategies_Example_1"></a>

This example illustrates one usage of ListDeploymentStrategies.

#### Sample Request
<a name="API_ListDeploymentStrategies_Example_1_Request"></a>

```
GET /deploymentstrategies 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.list-deployment-strategies
X-Amz-Date: 20210920T174939Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_ListDeploymentStrategies_Example_1_Response"></a>

```
{
    "Items": [
        {
            "Id": "1225qzk",
            "Name": "Example-Deployment",
            "DeploymentDurationInMinutes": 15,
            "GrowthType": "LINEAR",
            "GrowthFactor": 25.0,
            "FinalBakeTimeInMinutes": 0,
            "ReplicateTo": "SSM_DOCUMENT"
        },
        {
            "Id": "AppConfig.AllAtOnce",
            "Name": "AppConfig.AllAtOnce",
            "Description": "Quick",
            "DeploymentDurationInMinutes": 0,
            "GrowthType": "LINEAR",
            "GrowthFactor": 100.0,
            "FinalBakeTimeInMinutes": 10,
            "ReplicateTo": "NONE"
        },
        {
            "Id": "AppConfig.Linear50PercentEvery30Seconds",
            "Name": "AppConfig.Linear50PercentEvery30Seconds",
            "Description": "Test/Demo",
            "DeploymentDurationInMinutes": 1,
            "GrowthType": "LINEAR",
            "GrowthFactor": 50.0,
            "FinalBakeTimeInMinutes": 1,
            "ReplicateTo": "NONE"
        },
        {
            "Id": "AppConfig.Canary10Percent20Minutes",
            "Name": "AppConfig.Canary10Percent20Minutes",
            "Description": "AWS Recommended",
            "DeploymentDurationInMinutes": 20,
            "GrowthType": "EXPONENTIAL",
            "GrowthFactor": 10.0,
            "FinalBakeTimeInMinutes": 10,
            "ReplicateTo": "NONE"
        }
    ]
}
```

## See Also
<a name="API_ListDeploymentStrategies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/ListDeploymentStrategies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/ListDeploymentStrategies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/ListDeploymentStrategies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/ListDeploymentStrategies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/ListDeploymentStrategies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/ListDeploymentStrategies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/ListDeploymentStrategies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/ListDeploymentStrategies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/ListDeploymentStrategies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/ListDeploymentStrategies) 

# ListEnvironments
<a name="API_ListEnvironments"></a>

Lists the environments for an application.

## Request Syntax
<a name="API_ListEnvironments_RequestSyntax"></a>

```
GET /applications/ApplicationId/environments?max_results=MaxResults&next_token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListEnvironments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_ListEnvironments_RequestSyntax) **   <a name="appconfig-ListEnvironments-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [MaxResults](#API_ListEnvironments_RequestSyntax) **   <a name="appconfig-ListEnvironments-request-uri-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_ListEnvironments_RequestSyntax) **   <a name="appconfig-ListEnvironments-request-uri-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_ListEnvironments_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEnvironments_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "ApplicationId": "string",
         "Description": "string",
         "Id": "string",
         "Monitors": [ 
            { 
               "AlarmArn": "string",
               "AlarmRoleArn": "string"
            }
         ],
         "Name": "string",
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListEnvironments_ResponseElements"></a>

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

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

 ** [Items](#API_ListEnvironments_ResponseSyntax) **   <a name="appconfig-ListEnvironments-response-Items"></a>
The elements from this collection.  
Type: Array of [Environment](API_Environment.md) objects

 ** [NextToken](#API_ListEnvironments_ResponseSyntax) **   <a name="appconfig-ListEnvironments-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListEnvironments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_ListEnvironments_Examples"></a>

### Example
<a name="API_ListEnvironments_Example_1"></a>

This example illustrates one usage of ListEnvironments.

#### Sample Request
<a name="API_ListEnvironments_Example_1_Request"></a>

```
GET /applications/abc1234/environments 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.list-environments
X-Amz-Date: 20210920T182621Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_ListEnvironments_Example_1_Response"></a>

```
{
    "Items": [
        {
            "ApplicationId": "abc1234",
            "Id": "54j1r29",
            "Name": "Example-Environment",
            "State": "ReadyForDeployment"
        }
    ]
}
```

## See Also
<a name="API_ListEnvironments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/ListEnvironments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/ListEnvironments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/ListEnvironments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/ListEnvironments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/ListEnvironments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/ListEnvironments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/ListEnvironments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/ListEnvironments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/ListEnvironments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/ListEnvironments) 

# ListExtensionAssociations
<a name="API_ListExtensionAssociations"></a>

Lists all AWS AppConfig extension associations in the account. For more information about extensions and associations, see [Extending workflows](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the * AWS AppConfig User Guide*.

## Request Syntax
<a name="API_ListExtensionAssociations_RequestSyntax"></a>

```
GET /extensionassociations?extension_identifier=ExtensionIdentifier&extension_version_number=ExtensionVersionNumber&max_results=MaxResults&next_token=NextToken&resource_identifier=ResourceIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_ListExtensionAssociations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ExtensionIdentifier](#API_ListExtensionAssociations_RequestSyntax) **   <a name="appconfig-ListExtensionAssociations-request-uri-ExtensionIdentifier"></a>
The name, the ID, or the Amazon Resource Name (ARN) of the extension.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [ExtensionVersionNumber](#API_ListExtensionAssociations_RequestSyntax) **   <a name="appconfig-ListExtensionAssociations-request-uri-ExtensionVersionNumber"></a>
The version number for the extension defined in the association.

 ** [MaxResults](#API_ListExtensionAssociations_RequestSyntax) **   <a name="appconfig-ListExtensionAssociations-request-uri-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_ListExtensionAssociations_RequestSyntax) **   <a name="appconfig-ListExtensionAssociations-request-uri-NextToken"></a>
A token to start the list. Use this token to get the next set of results or pass null to get the first set of results.   
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [ResourceIdentifier](#API_ListExtensionAssociations_RequestSyntax) **   <a name="appconfig-ListExtensionAssociations-request-uri-ResourceIdentifier"></a>
The ARN of an application, configuration profile, or environment.  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

## Request Body
<a name="API_ListExtensionAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListExtensionAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "ExtensionArn": "string",
         "Id": "string",
         "ResourceArn": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListExtensionAssociations_ResponseElements"></a>

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

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

 ** [Items](#API_ListExtensionAssociations_ResponseSyntax) **   <a name="appconfig-ListExtensionAssociations-response-Items"></a>
The list of extension associations. Each item represents an extension association to an application, environment, or configuration profile.   
Type: Array of [ExtensionAssociationSummary](API_ExtensionAssociationSummary.md) objects

 ** [NextToken](#API_ListExtensionAssociations_ResponseSyntax) **   <a name="appconfig-ListExtensionAssociations-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListExtensionAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## Examples
<a name="API_ListExtensionAssociations_Examples"></a>

### Example
<a name="API_ListExtensionAssociations_Example_1"></a>

This example illustrates one usage of ListExtensionAssociations.

#### Sample Request
<a name="API_ListExtensionAssociations_Example_1_Request"></a>

```
GET /extensionassociations HTTP/1.1
Host: appconfig.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/appconfig.list-extension-associations
X-Amz-Date: 20220803T215900Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_ListExtensionAssociations_Example_1_Response"></a>

```
{
	"Items": [{
		"ExtensionArn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1",
		"Id": "rnekru4",
		"ResourceArn": "arn:aws:appconfig:us-west-2:111122223333:application/xlmtnms"
	}],
	"NextToken": null
}
```

## See Also
<a name="API_ListExtensionAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/ListExtensionAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/ListExtensionAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/ListExtensionAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/ListExtensionAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/ListExtensionAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/ListExtensionAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/ListExtensionAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/ListExtensionAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/ListExtensionAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/ListExtensionAssociations) 

# ListExtensions
<a name="API_ListExtensions"></a>

Lists all custom and AWS authored AWS AppConfig extensions in the account. For more information about extensions, see [Extending workflows](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the * AWS AppConfig User Guide*.

## Request Syntax
<a name="API_ListExtensions_RequestSyntax"></a>

```
GET /extensions?max_results=MaxResults&name=Name&next_token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListExtensions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListExtensions_RequestSyntax) **   <a name="appconfig-ListExtensions-request-uri-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [Name](#API_ListExtensions_RequestSyntax) **   <a name="appconfig-ListExtensions-request-uri-Name"></a>
The extension name.  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [NextToken](#API_ListExtensions_RequestSyntax) **   <a name="appconfig-ListExtensions-request-uri-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_ListExtensions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListExtensions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "Arn": "string",
         "Description": "string",
         "Id": "string",
         "Name": "string",
         "VersionNumber": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListExtensions_ResponseElements"></a>

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

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

 ** [Items](#API_ListExtensions_ResponseSyntax) **   <a name="appconfig-ListExtensions-response-Items"></a>
The list of available extensions. The list includes AWS authored and user-created extensions.  
Type: Array of [ExtensionSummary](API_ExtensionSummary.md) objects

 ** [NextToken](#API_ListExtensions_ResponseSyntax) **   <a name="appconfig-ListExtensions-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListExtensions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## Examples
<a name="API_ListExtensions_Examples"></a>

### Example
<a name="API_ListExtensions_Example_1"></a>

This example illustrates one usage of ListExtensions.

#### Sample Request
<a name="API_ListExtensions_Example_1_Request"></a>

```
GET /extensions HTTP/1.1
Host: appconfig.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/appconfig.list-extensions
X-Amz-Date: 20220803T215314Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_ListExtensions_Example_1_Response"></a>

```
{
	"Items": [{
		"Arn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1",
		"Description": null,
		"Id": "6czExampmle",
		"Name": "my-test-extension",
		"VersionNumber": 1
	}, {
		"Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.FeatureFlags/1",
		"Description": "Validates AppConfig feature flag data automatically against a JSON schema that includes structure and constraints. Also transforms feature flag data prior to sending to the client. This extension is automatically associated to configuration profiles with type \"AWS.AppConfig.FeatureFlags\".",
		"Id": "AWS.AppConfig.FeatureFlags",
		"Name": "AppConfig Feature Flags Helper",
		"VersionNumber": 1
	}, {
		"Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.JiraIntegration/1",
		"Description": "Exports feature flag data from AWS AppConfig into Jira. The lifecycle of each feature flag in AppConfig is tracked in Jira as an individual issue. Customers can see in Jira when flags are updated, turned on or off. Works in conjunction with the AppConfig app in the Atlassian Marketplace and is automatically associated to configuration profiles configured within that app.",
		"Id": "AWS.AppConfig.JiraIntegration",
		"Name": "AppConfig integration with Atlassian Jira",
		"VersionNumber": 1
	}, {
		"Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.DeploymentNotificationsToEventBridge/1",
		"Description": "Sends events to Amazon EventBridge when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile.",
		"Id": "AWS.AppConfig.DeploymentNotificationsToEventBridge",
		"Name": "AppConfig deployment events to Amazon EventBridge",
		"VersionNumber": 1
	}, {
		"Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.DeploymentNotificationsToSqs/1",
		"Description": "Sends messages to the configured Amazon SQS queue when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile.",
		"Id": "AWS.AppConfig.DeploymentNotificationsToSqs",
		"Name": "AppConfig deployment events to Amazon SQS",
		"VersionNumber": 1
	}, {
		"Arn": null,
		"Description": "Sends events to the configured Amazon SNS topic when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile.",
		"Id": "AWS.AppConfig.DeploymentNotificationsToSns",
		"Name": "AppConfig deployment events to Amazon SNS",
		"VersionNumber": 1
	}],
	"NextToken": null
}
```

## See Also
<a name="API_ListExtensions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/ListExtensions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/ListExtensions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/ListExtensions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/ListExtensions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/ListExtensions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/ListExtensions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/ListExtensions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/ListExtensions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/ListExtensions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/ListExtensions) 

# ListHostedConfigurationVersions
<a name="API_ListHostedConfigurationVersions"></a>

Lists configurations stored in the AWS AppConfig hosted configuration store by version. 

## Request Syntax
<a name="API_ListHostedConfigurationVersions_RequestSyntax"></a>

```
GET /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/hostedconfigurationversions?max_results=MaxResults&next_token=NextToken&version_label=VersionLabel HTTP/1.1
```

## URI Request Parameters
<a name="API_ListHostedConfigurationVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_ListHostedConfigurationVersions_RequestSyntax) **   <a name="appconfig-ListHostedConfigurationVersions-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ConfigurationProfileId](#API_ListHostedConfigurationVersions_RequestSyntax) **   <a name="appconfig-ListHostedConfigurationVersions-request-uri-ConfigurationProfileId"></a>
The configuration profile ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [MaxResults](#API_ListHostedConfigurationVersions_RequestSyntax) **   <a name="appconfig-ListHostedConfigurationVersions-request-uri-MaxResults"></a>
The maximum number of items to return for this call. If `MaxResults` is not provided in the call, AWS AppConfig returns the maximum of 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_ListHostedConfigurationVersions_RequestSyntax) **   <a name="appconfig-ListHostedConfigurationVersions-request-uri-NextToken"></a>
A token to start the list. Use this token to get the next set of results.   
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [VersionLabel](#API_ListHostedConfigurationVersions_RequestSyntax) **   <a name="appconfig-ListHostedConfigurationVersions-request-uri-VersionLabel"></a>
An optional filter that can be used to specify the version label of an AWS AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2\$1". If you don't specify an asterisk at the end of the value, only an exact match is returned.  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Request Body
<a name="API_ListHostedConfigurationVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListHostedConfigurationVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "ApplicationId": "string",
         "ConfigurationProfileId": "string",
         "ContentType": "string",
         "Description": "string",
         "KmsKeyArn": "string",
         "VersionLabel": "string",
         "VersionNumber": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListHostedConfigurationVersions_ResponseElements"></a>

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

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

 ** [Items](#API_ListHostedConfigurationVersions_ResponseSyntax) **   <a name="appconfig-ListHostedConfigurationVersions-response-Items"></a>
The elements from this collection.  
Type: Array of [HostedConfigurationVersionSummary](API_HostedConfigurationVersionSummary.md) objects

 ** [NextToken](#API_ListHostedConfigurationVersions_ResponseSyntax) **   <a name="appconfig-ListHostedConfigurationVersions-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListHostedConfigurationVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_ListHostedConfigurationVersions_Examples"></a>

### Example
<a name="API_ListHostedConfigurationVersions_Example_1"></a>

This example illustrates one usage of ListHostedConfigurationVersions.

#### Sample Request
<a name="API_ListHostedConfigurationVersions_Example_1_Request"></a>

```
GET /applications/abc1234/configurationprofiles/ur8hx2f/hostedconfigurationversions 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.list-hosted-configuration-versions
X-Amz-Date: 20210920T183555Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_ListHostedConfigurationVersions_Example_1_Response"></a>

```
{
    "Items": [
        {
            "ApplicationId": "abc1234",
            "ConfigurationProfileId": "ur8hx2f",
            "VersionNumber": 1,
            "ContentType": "application/json"
        }
    ]
}
```

## See Also
<a name="API_ListHostedConfigurationVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/ListHostedConfigurationVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/ListHostedConfigurationVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/ListHostedConfigurationVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/ListHostedConfigurationVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/ListHostedConfigurationVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/ListHostedConfigurationVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/ListHostedConfigurationVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/ListHostedConfigurationVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/ListHostedConfigurationVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/ListHostedConfigurationVersions) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Retrieves the list of key-value tags assigned to the resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/ResourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="appconfig-ListTagsForResource-request-uri-ResourceArn"></a>
The resource ARN.  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+`   
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

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

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

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="appconfig-ListTagsForResource-response-Tags"></a>
Metadata to assign to AWS AppConfig resources. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_ListTagsForResource_Examples"></a>

### Example
<a name="API_ListTagsForResource_Example_1"></a>

This example illustrates one usage of ListTagsForResource.

#### Sample Request
<a name="API_ListTagsForResource_Example_1_Request"></a>

```
GET /tags/arn%3Aaws%3Aappconfig%3Aus-east-1%3A682428703967%3Aapplication%abc1234 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.list-tags-for-resource
X-Amz-Date: 20210920T205611Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_ListTagsForResource_Example_1_Response"></a>

```
{
    "Tags": {
        "group1": "1"
    }
}
```

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/ListTagsForResource) 

# StartDeployment
<a name="API_StartDeployment"></a>

Starts a deployment.

**Note**  
 AWS AppConfig Agent supports deploying feature flag or free-form configuration data to specific segments or individual users during a gradual rollout. Entity-based gradual deployments ensure that once a user or segment receives a configuration version, they continue to receive that same version throughout the deployment period, regardless of which compute resource serves their requests. For more information, see [Using AWS AppConfig Agent for user-based or entity-based gradual deployments](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-agent-how-to-use.html#appconfig-entity-based-gradual-deployments) 

## Request Syntax
<a name="API_StartDeployment_RequestSyntax"></a>

```
POST /applications/ApplicationId/environments/EnvironmentId/deployments HTTP/1.1
Content-type: application/json

{
   "ConfigurationProfileId": "string",
   "ConfigurationVersion": "string",
   "DeploymentStrategyId": "string",
   "Description": "string",
   "DynamicExtensionParameters": { 
      "string" : "string" 
   },
   "KmsKeyIdentifier": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_StartDeployment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_StartDeployment_RequestSyntax) **   <a name="appconfig-StartDeployment-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [EnvironmentId](#API_StartDeployment_RequestSyntax) **   <a name="appconfig-StartDeployment-request-uri-EnvironmentId"></a>
The environment ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_StartDeployment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ConfigurationProfileId](#API_StartDeployment_RequestSyntax) **   <a name="appconfig-StartDeployment-request-ConfigurationProfileId"></a>
The configuration profile ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ConfigurationVersion](#API_StartDeployment_RequestSyntax) **   <a name="appconfig-StartDeployment-request-ConfigurationVersion"></a>
The configuration version to deploy. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** [DeploymentStrategyId](#API_StartDeployment_RequestSyntax) **   <a name="appconfig-StartDeployment-request-DeploymentStrategyId"></a>
The deployment strategy ID.  
Type: String  
Pattern: `(^[a-z0-9]{4,7}$|^AppConfig\.[A-Za-z0-9]{9,40}$)`   
Required: Yes

 ** [Description](#API_StartDeployment_RequestSyntax) **   <a name="appconfig-StartDeployment-request-Description"></a>
A description of the deployment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [DynamicExtensionParameters](#API_StartDeployment_RequestSyntax) **   <a name="appconfig-StartDeployment-request-DynamicExtensionParameters"></a>
A map of dynamic extension parameter names to values to pass to associated extensions with `PRE_START_DEPLOYMENT` actions.  
Type: String to string map  
Map Entries: Maximum number of 10 items.  
Key Pattern: `^([^#\n]{1,96})#([^\/#\n]{1,64})$`   
Value Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [KmsKeyIdentifier](#API_StartDeployment_RequestSyntax) **   <a name="appconfig-StartDeployment-request-KmsKeyIdentifier"></a>
The AWS KMS key identifier (key ID, key alias, or key ARN). AWS AppConfig uses this ID to encrypt the configuration data using a customer managed key.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [Tags](#API_StartDeployment_RequestSyntax) **   <a name="appconfig-StartDeployment-request-Tags"></a>
Metadata to assign to the deployment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_StartDeployment_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "ApplicationId": "string",
   "AppliedExtensions": [ 
      { 
         "ExtensionAssociationId": "string",
         "ExtensionId": "string",
         "Parameters": { 
            "string" : "string" 
         },
         "VersionNumber": number
      }
   ],
   "CompletedAt": "string",
   "ConfigurationLocationUri": "string",
   "ConfigurationName": "string",
   "ConfigurationProfileId": "string",
   "ConfigurationVersion": "string",
   "DeploymentDurationInMinutes": number,
   "DeploymentNumber": number,
   "DeploymentStrategyId": "string",
   "Description": "string",
   "EnvironmentId": "string",
   "EventLog": [ 
      { 
         "ActionInvocations": [ 
            { 
               "ActionName": "string",
               "ErrorCode": "string",
               "ErrorMessage": "string",
               "ExtensionIdentifier": "string",
               "InvocationId": "string",
               "RoleArn": "string",
               "Uri": "string"
            }
         ],
         "Description": "string",
         "EventType": "string",
         "OccurredAt": "string",
         "TriggeredBy": "string"
      }
   ],
   "FinalBakeTimeInMinutes": number,
   "GrowthFactor": number,
   "GrowthType": "string",
   "KmsKeyArn": "string",
   "KmsKeyIdentifier": "string",
   "PercentageComplete": number,
   "StartedAt": "string",
   "State": "string",
   "VersionLabel": "string"
}
```

## Response Elements
<a name="API_StartDeployment_ResponseElements"></a>

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

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

 ** [ApplicationId](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-ApplicationId"></a>
The ID of the application that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [AppliedExtensions](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-AppliedExtensions"></a>
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.  
Type: Array of [AppliedExtension](API_AppliedExtension.md) objects

 ** [CompletedAt](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-CompletedAt"></a>
The time the deployment completed.   
Type: Timestamp

 ** [ConfigurationLocationUri](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-ConfigurationLocationUri"></a>
Information about the source location of the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [ConfigurationName](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-ConfigurationName"></a>
The name of the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [ConfigurationProfileId](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-ConfigurationProfileId"></a>
The ID of the configuration profile that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [ConfigurationVersion](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-ConfigurationVersion"></a>
The configuration version that was deployed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [DeploymentDurationInMinutes](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-DeploymentDurationInMinutes"></a>
Total amount of time the deployment lasted.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [DeploymentNumber](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-DeploymentNumber"></a>
The sequence number of the deployment.  
Type: Integer

 ** [DeploymentStrategyId](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-DeploymentStrategyId"></a>
The ID of the deployment strategy that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Description](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-Description"></a>
The description of the deployment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [EnvironmentId](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-EnvironmentId"></a>
The ID of the environment that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [EventLog](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-EventLog"></a>
A list containing all events related to a deployment. The most recent events are displayed first.  
Type: Array of [DeploymentEvent](API_DeploymentEvent.md) objects

 ** [FinalBakeTimeInMinutes](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-FinalBakeTimeInMinutes"></a>
The amount of time that AWS AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [GrowthFactor](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-GrowthFactor"></a>
The percentage of targets to receive a deployed configuration during each interval.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.

 ** [GrowthType](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-GrowthType"></a>
The algorithm used to define how percentage grew over time.  
Type: String  
Valid Values: `LINEAR | EXPONENTIAL` 

 ** [KmsKeyArn](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-KmsKeyArn"></a>
The Amazon Resource Name of the AWS Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in AWS Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in AWS Systems Manager Parameter Store.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [KmsKeyIdentifier](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-KmsKeyIdentifier"></a>
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.

 ** [PercentageComplete](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-PercentageComplete"></a>
The percentage of targets for which the deployment is available.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.

 ** [StartedAt](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-StartedAt"></a>
The time the deployment started.  
Type: Timestamp

 ** [State](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-State"></a>
The state of the deployment.  
Type: String  
Valid Values: `BAKING | VALIDATING | DEPLOYING | COMPLETE | ROLLING_BACK | ROLLED_BACK | REVERTED` 

 ** [VersionLabel](#API_StartDeployment_ResponseSyntax) **   <a name="appconfig-StartDeployment-response-VersionLabel"></a>
A user-defined label for an AWS AppConfig hosted configuration version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*[^0-9].*` 

## Errors
<a name="API_StartDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** 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
<a name="API_StartDeployment_Examples"></a>

### Example
<a name="API_StartDeployment_Example_1"></a>

This example illustrates one usage of StartDeployment.

#### Sample Request
<a name="API_StartDeployment_Example_1_Request"></a>

```
POST /applications/abc1234/environments/54j1r29/deployments 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.start-deployment
X-Amz-Date: 20210917T214353Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 101

{
    "DeploymentStrategyId": "1225qzk", 
    "ConfigurationProfileId": "ur8hx2f", 
    "ConfigurationVersion": "1"
}
```

#### Sample Response
<a name="API_StartDeployment_Example_1_Response"></a>

```
{
    "ApplicationId": "abc1234",
    "EnvironmentId": "54j1r29",
    "DeploymentStrategyId": "1225qzk",
    "ConfigurationProfileId": "ur8hx2f",
    "DeploymentNumber": 1,
    "ConfigurationName": "Example-Configuration-Profile",
    "ConfigurationLocationUri": "ssm-parameter://Example-Parameter",
    "ConfigurationVersion": "1",
    "DeploymentDurationInMinutes": 15,
    "GrowthType": "LINEAR",
    "GrowthFactor": 25.0,
    "FinalBakeTimeInMinutes": 0,
    "State": "DEPLOYING",
    "EventLog": [
        {
            "EventType": "DEPLOYMENT_STARTED",
            "TriggeredBy": "USER",
            "Description": "Deployment started",
            "OccurredAt": "2021-09-17T21:43:54.205000+00:00"
        }
    ],
    "PercentageComplete": 0.0,
    "StartedAt": "2021-09-17T21:43:54.205000+00:00"
}
```

## See Also
<a name="API_StartDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/StartDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/StartDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/StartDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/StartDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/StartDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/StartDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/StartDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/StartDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/StartDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/StartDeployment) 

# StopDeployment
<a name="API_StopDeployment"></a>

Stops a deployment. This API action works only on deployments that have a status of `DEPLOYING`, unless an `AllowRevert` parameter is supplied. If the `AllowRevert` parameter is supplied, the status of an in-progress deployment will be `ROLLED_BACK`. The status of a completed deployment will be `REVERTED`. AWS AppConfig only allows a revert within 72 hours of deployment completion.

## Request Syntax
<a name="API_StopDeployment_RequestSyntax"></a>

```
DELETE /applications/ApplicationId/environments/EnvironmentId/deployments/DeploymentNumber HTTP/1.1
Allow-Revert: AllowRevert
```

## URI Request Parameters
<a name="API_StopDeployment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AllowRevert](#API_StopDeployment_RequestSyntax) **   <a name="appconfig-StopDeployment-request-AllowRevert"></a>
A Boolean that enables AWS AppConfig to rollback a `COMPLETED` deployment to the previous configuration version. This action moves the deployment to a status of `REVERTED`.

 ** [ApplicationId](#API_StopDeployment_RequestSyntax) **   <a name="appconfig-StopDeployment-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [DeploymentNumber](#API_StopDeployment_RequestSyntax) **   <a name="appconfig-StopDeployment-request-uri-DeploymentNumber"></a>
The sequence number of the deployment.  
Required: Yes

 ** [EnvironmentId](#API_StopDeployment_RequestSyntax) **   <a name="appconfig-StopDeployment-request-uri-EnvironmentId"></a>
The environment ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_StopDeployment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_StopDeployment_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "ApplicationId": "string",
   "AppliedExtensions": [ 
      { 
         "ExtensionAssociationId": "string",
         "ExtensionId": "string",
         "Parameters": { 
            "string" : "string" 
         },
         "VersionNumber": number
      }
   ],
   "CompletedAt": "string",
   "ConfigurationLocationUri": "string",
   "ConfigurationName": "string",
   "ConfigurationProfileId": "string",
   "ConfigurationVersion": "string",
   "DeploymentDurationInMinutes": number,
   "DeploymentNumber": number,
   "DeploymentStrategyId": "string",
   "Description": "string",
   "EnvironmentId": "string",
   "EventLog": [ 
      { 
         "ActionInvocations": [ 
            { 
               "ActionName": "string",
               "ErrorCode": "string",
               "ErrorMessage": "string",
               "ExtensionIdentifier": "string",
               "InvocationId": "string",
               "RoleArn": "string",
               "Uri": "string"
            }
         ],
         "Description": "string",
         "EventType": "string",
         "OccurredAt": "string",
         "TriggeredBy": "string"
      }
   ],
   "FinalBakeTimeInMinutes": number,
   "GrowthFactor": number,
   "GrowthType": "string",
   "KmsKeyArn": "string",
   "KmsKeyIdentifier": "string",
   "PercentageComplete": number,
   "StartedAt": "string",
   "State": "string",
   "VersionLabel": "string"
}
```

## Response Elements
<a name="API_StopDeployment_ResponseElements"></a>

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

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

 ** [ApplicationId](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-ApplicationId"></a>
The ID of the application that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [AppliedExtensions](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-AppliedExtensions"></a>
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.  
Type: Array of [AppliedExtension](API_AppliedExtension.md) objects

 ** [CompletedAt](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-CompletedAt"></a>
The time the deployment completed.   
Type: Timestamp

 ** [ConfigurationLocationUri](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-ConfigurationLocationUri"></a>
Information about the source location of the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [ConfigurationName](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-ConfigurationName"></a>
The name of the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [ConfigurationProfileId](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-ConfigurationProfileId"></a>
The ID of the configuration profile that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [ConfigurationVersion](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-ConfigurationVersion"></a>
The configuration version that was deployed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [DeploymentDurationInMinutes](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-DeploymentDurationInMinutes"></a>
Total amount of time the deployment lasted.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [DeploymentNumber](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-DeploymentNumber"></a>
The sequence number of the deployment.  
Type: Integer

 ** [DeploymentStrategyId](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-DeploymentStrategyId"></a>
The ID of the deployment strategy that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Description](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-Description"></a>
The description of the deployment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [EnvironmentId](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-EnvironmentId"></a>
The ID of the environment that was deployed.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [EventLog](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-EventLog"></a>
A list containing all events related to a deployment. The most recent events are displayed first.  
Type: Array of [DeploymentEvent](API_DeploymentEvent.md) objects

 ** [FinalBakeTimeInMinutes](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-FinalBakeTimeInMinutes"></a>
The amount of time that AWS AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [GrowthFactor](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-GrowthFactor"></a>
The percentage of targets to receive a deployed configuration during each interval.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.

 ** [GrowthType](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-GrowthType"></a>
The algorithm used to define how percentage grew over time.  
Type: String  
Valid Values: `LINEAR | EXPONENTIAL` 

 ** [KmsKeyArn](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-KmsKeyArn"></a>
The Amazon Resource Name of the AWS Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in AWS Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in AWS Systems Manager Parameter Store.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [KmsKeyIdentifier](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-KmsKeyIdentifier"></a>
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.

 ** [PercentageComplete](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-PercentageComplete"></a>
The percentage of targets for which the deployment is available.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.

 ** [StartedAt](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-StartedAt"></a>
The time the deployment started.  
Type: Timestamp

 ** [State](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-State"></a>
The state of the deployment.  
Type: String  
Valid Values: `BAKING | VALIDATING | DEPLOYING | COMPLETE | ROLLING_BACK | ROLLED_BACK | REVERTED` 

 ** [VersionLabel](#API_StopDeployment_ResponseSyntax) **   <a name="appconfig-StopDeployment-response-VersionLabel"></a>
A user-defined label for an AWS AppConfig hosted configuration version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*[^0-9].*` 

## Errors
<a name="API_StopDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_StopDeployment_Examples"></a>

### Example
<a name="API_StopDeployment_Example_1"></a>

This example illustrates one usage of StopDeployment.

#### Sample Request
<a name="API_StopDeployment_Example_1_Request"></a>

```
DELETE /applications/abc1234/environments/54j1r29/deployments/2 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.stop-deployment
X-Amz-Date: 20210920T210612Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_StopDeployment_Example_1_Response"></a>

```
{
    "DeploymentNumber": 0,
    "DeploymentDurationInMinutes": 0,
    "GrowthFactor": 0.0,
    "FinalBakeTimeInMinutes": 0,
    "PercentageComplete": 0.0
}
```

## See Also
<a name="API_StopDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/StopDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/StopDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/StopDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/StopDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/StopDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/StopDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/StopDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/StopDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/StopDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/StopDeployment) 

# TagResource
<a name="API_TagResource"></a>

Assigns metadata to an AWS AppConfig resource. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/ResourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="appconfig-TagResource-request-uri-ResourceArn"></a>
The ARN of the resource for which to retrieve tags.  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+`   
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="appconfig-TagResource-request-Tags"></a>
The key-value string map. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_TagResource_Examples"></a>

### Example
<a name="API_TagResource_Example_1"></a>

This example illustrates one usage of TagResource.

#### Sample Request
<a name="API_TagResource_Example_1_Request"></a>

```
POST /tags/arn%3Aaws%3Aappconfig%3Aus-east-1%3A111122223333%3Aapplication%abc1234 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.tag-resource
X-Amz-Date: 20210920T185502Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 25

{
	"Tags": {"group1": "1"}
}
```

#### Sample Response
<a name="API_TagResource_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Deletes a tag key and value from an AWS AppConfig resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="appconfig-UntagResource-request-uri-ResourceArn"></a>
The ARN of the resource for which to remove tags.  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+`   
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="appconfig-UntagResource-request-uri-TagKeys"></a>
The tag keys to delete.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UntagResource_Examples"></a>

### Example
<a name="API_UntagResource_Example_1"></a>

This example illustrates one usage of UntagResource.

#### Sample Request
<a name="API_UntagResource_Example_1_Request"></a>

```
DELETE /tags/arn%3Aaws%3Aappconfig%3Aus-east-1%3A111122223333%3Aapplication%abc1234?tagKeys=group1 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.untag-resource
X-Amz-Date: 20210920T211702Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_UntagResource_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/UntagResource) 

# UpdateAccountSettings
<a name="API_UpdateAccountSettings"></a>

Updates the value of the `DeletionProtection` parameter.

## Request Syntax
<a name="API_UpdateAccountSettings_RequestSyntax"></a>

```
PATCH /settings HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": { 
      "Enabled": boolean,
      "ProtectionPeriodInMinutes": number
   }
}
```

## URI Request Parameters
<a name="API_UpdateAccountSettings_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateAccountSettings_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DeletionProtection](#API_UpdateAccountSettings_RequestSyntax) **   <a name="appconfig-UpdateAccountSettings-request-DeletionProtection"></a>
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AWS AppConfig has called either [GetLatestConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) or [GetConfiguration](API_GetConfiguration.md) for the configuration profile or from the environment during the specified interval. The default interval for `ProtectionPeriodInMinutes` is 60.  
Type: [DeletionProtectionSettings](API_DeletionProtectionSettings.md) object  
Required: No

## Response Syntax
<a name="API_UpdateAccountSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DeletionProtection": { 
      "Enabled": boolean,
      "ProtectionPeriodInMinutes": number
   }
}
```

## Response Elements
<a name="API_UpdateAccountSettings_ResponseElements"></a>

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

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

 ** [DeletionProtection](#API_UpdateAccountSettings_ResponseSyntax) **   <a name="appconfig-UpdateAccountSettings-response-DeletionProtection"></a>
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AWS AppConfig has called either [GetLatestConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) or [GetConfiguration](API_GetConfiguration.md) for the configuration profile or from the environment during the specified interval. The default interval for `ProtectionPeriodInMinutes` is 60.  
Type: [DeletionProtectionSettings](API_DeletionProtectionSettings.md) object

## Errors
<a name="API_UpdateAccountSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## Examples
<a name="API_UpdateAccountSettings_Examples"></a>

### Example
<a name="API_UpdateAccountSettings_Example_1"></a>

This example illustrates one usage of UpdateAccountSettings.

#### Sample Request
<a name="API_UpdateAccountSettings_Example_1_Request"></a>

```
PATCH /settings HTTP/1.1
Host: appconfig.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Type: application/json
User-Agent: aws-cli/2.17.58 md/awscrt#0.21.2 ua/2.0 os/windows#10 md/arch#amd64 lang/python#3.12.6 md/pyimpl#CPython cfg/retry-mode#standard md/installer#exe md/prompt#off md/command#appconfig.update-account-settings
X-Amz-Date: 20241001T190010Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20241001/us-east-1/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 41

{"DeletionProtection": {"Enabled": true}}
```

#### Sample Response
<a name="API_UpdateAccountSettings_Example_1_Response"></a>

```
{
	"DeletionProtection": {
		"Enabled": true,
		"ProtectionPeriodInMinutes": 60
	}
}
```

## See Also
<a name="API_UpdateAccountSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/UpdateAccountSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/UpdateAccountSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/UpdateAccountSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/UpdateAccountSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/UpdateAccountSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/UpdateAccountSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/UpdateAccountSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/UpdateAccountSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/UpdateAccountSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/UpdateAccountSettings) 

# UpdateApplication
<a name="API_UpdateApplication"></a>

Updates an application.

## Request Syntax
<a name="API_UpdateApplication_RequestSyntax"></a>

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

{
   "Description": "string",
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_UpdateApplication_RequestSyntax) **   <a name="appconfig-UpdateApplication-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_UpdateApplication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateApplication_RequestSyntax) **   <a name="appconfig-UpdateApplication-request-Description"></a>
A description of the application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [Name](#API_UpdateApplication_RequestSyntax) **   <a name="appconfig-UpdateApplication-request-Name"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Syntax
<a name="API_UpdateApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Description": "string",
   "Id": "string",
   "Name": "string"
}
```

## Response Elements
<a name="API_UpdateApplication_ResponseElements"></a>

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

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

 ** [Description](#API_UpdateApplication_ResponseSyntax) **   <a name="appconfig-UpdateApplication-response-Description"></a>
The description of the application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_UpdateApplication_ResponseSyntax) **   <a name="appconfig-UpdateApplication-response-Id"></a>
The application ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Name](#API_UpdateApplication_ResponseSyntax) **   <a name="appconfig-UpdateApplication-response-Name"></a>
The application name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Errors
<a name="API_UpdateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateApplication_Examples"></a>

### Example
<a name="API_UpdateApplication_Example_1"></a>

This example illustrates one usage of UpdateApplication.

#### Sample Request
<a name="API_UpdateApplication_Example_1_Request"></a>

```
PATCH /applications/abc1234 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-application
X-Amz-Date: 20210920T212018Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 31

{
	"Name": "Example-Application"
}
```

#### Sample Response
<a name="API_UpdateApplication_Example_1_Response"></a>

```
{
    "Id": "abc1234",
    "Name": "Example-Application",
    "Description": "An application used for creating an example."
}
```

## See Also
<a name="API_UpdateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/UpdateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/UpdateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/UpdateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/UpdateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/UpdateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/UpdateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/UpdateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/UpdateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/UpdateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/UpdateApplication) 

# UpdateConfigurationProfile
<a name="API_UpdateConfigurationProfile"></a>

Updates a configuration profile.

## Request Syntax
<a name="API_UpdateConfigurationProfile_RequestSyntax"></a>

```
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
<a name="API_UpdateConfigurationProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_UpdateConfigurationProfile_RequestSyntax) **   <a name="appconfig-UpdateConfigurationProfile-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ConfigurationProfileId](#API_UpdateConfigurationProfile_RequestSyntax) **   <a name="appconfig-UpdateConfigurationProfile-request-uri-ConfigurationProfileId"></a>
The ID of the configuration profile.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_UpdateConfigurationProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateConfigurationProfile_RequestSyntax) **   <a name="appconfig-UpdateConfigurationProfile-request-Description"></a>
A description of the configuration profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [KmsKeyIdentifier](#API_UpdateConfigurationProfile_RequestSyntax) **   <a name="appconfig-UpdateConfigurationProfile-request-KmsKeyIdentifier"></a>
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](#API_UpdateConfigurationProfile_RequestSyntax) **   <a name="appconfig-UpdateConfigurationProfile-request-Name"></a>
The name of the configuration profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [RetrievalRoleArn](#API_UpdateConfigurationProfile_RequestSyntax) **   <a name="appconfig-UpdateConfigurationProfile-request-RetrievalRoleArn"></a>
The ARN of an IAM role with permission to access the configuration at the specified `LocationUri`.  
A retrieval role ARN is not required for configurations stored in AWS CodePipeline or the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration. 
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|aws-eusc):(iam)::\d{12}:role[/].*)$`   
Required: No

 ** [Validators](#API_UpdateConfigurationProfile_RequestSyntax) **   <a name="appconfig-UpdateConfigurationProfile-request-Validators"></a>
A list of methods for validating the configuration.  
Type: Array of [Validator](API_Validator.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

## Response Syntax
<a name="API_UpdateConfigurationProfile_ResponseSyntax"></a>

```
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
<a name="API_UpdateConfigurationProfile_ResponseElements"></a>

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](#API_UpdateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-UpdateConfigurationProfile-response-ApplicationId"></a>
The application ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Description](#API_UpdateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-UpdateConfigurationProfile-response-Description"></a>
The configuration profile description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_UpdateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-UpdateConfigurationProfile-response-Id"></a>
The configuration profile ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [KmsKeyArn](#API_UpdateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-UpdateConfigurationProfile-response-KmsKeyArn"></a>
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]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [KmsKeyIdentifier](#API_UpdateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-UpdateConfigurationProfile-response-KmsKeyIdentifier"></a>
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](#API_UpdateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-UpdateConfigurationProfile-response-LocationUri"></a>
The URI location of the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Name](#API_UpdateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-UpdateConfigurationProfile-response-Name"></a>
The name of the configuration profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [RetrievalRoleArn](#API_UpdateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-UpdateConfigurationProfile-response-RetrievalRoleArn"></a>
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|aws-eusc):(iam)::\d{12}:role[/].*)$` 

 ** [Type](#API_UpdateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-UpdateConfigurationProfile-response-Type"></a>
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](#API_UpdateConfigurationProfile_ResponseSyntax) **   <a name="appconfig-UpdateConfigurationProfile-response-Validators"></a>
A list of methods for validating the configuration.  
Type: Array of [Validator](API_Validator.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.

## Errors
<a name="API_UpdateConfigurationProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateConfigurationProfile_Examples"></a>

### Example
<a name="API_UpdateConfigurationProfile_Example_1"></a>

This example illustrates one usage of UpdateConfigurationProfile.

#### Sample Request
<a name="API_UpdateConfigurationProfile_Example_1_Request"></a>

```
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
<a name="API_UpdateConfigurationProfile_Example_1_Response"></a>

```
{
    "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"
}
```

## See Also
<a name="API_UpdateConfigurationProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/UpdateConfigurationProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/UpdateConfigurationProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/UpdateConfigurationProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/UpdateConfigurationProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/UpdateConfigurationProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/UpdateConfigurationProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/UpdateConfigurationProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/UpdateConfigurationProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/UpdateConfigurationProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/UpdateConfigurationProfile) 

# UpdateDeploymentStrategy
<a name="API_UpdateDeploymentStrategy"></a>

Updates a deployment strategy.

## Request Syntax
<a name="API_UpdateDeploymentStrategy_RequestSyntax"></a>

```
PATCH /deploymentstrategies/DeploymentStrategyId HTTP/1.1
Content-type: application/json

{
   "DeploymentDurationInMinutes": number,
   "Description": "string",
   "FinalBakeTimeInMinutes": number,
   "GrowthFactor": number,
   "GrowthType": "string"
}
```

## URI Request Parameters
<a name="API_UpdateDeploymentStrategy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DeploymentStrategyId](#API_UpdateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-request-uri-DeploymentStrategyId"></a>
The deployment strategy ID.  
Pattern: `(^[a-z0-9]{4,7}$|^AppConfig\.[A-Za-z0-9]{9,40}$)`   
Required: Yes

## Request Body
<a name="API_UpdateDeploymentStrategy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DeploymentDurationInMinutes](#API_UpdateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-request-DeploymentDurationInMinutes"></a>
Total amount of time for a deployment to last.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.  
Required: No

 ** [Description](#API_UpdateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-request-Description"></a>
A description of the deployment strategy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [FinalBakeTimeInMinutes](#API_UpdateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-request-FinalBakeTimeInMinutes"></a>
The amount of time that AWS AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.  
Required: No

 ** [GrowthFactor](#API_UpdateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-request-GrowthFactor"></a>
The percentage of targets to receive a deployed configuration during each interval.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.  
Required: No

 ** [GrowthType](#API_UpdateDeploymentStrategy_RequestSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-request-GrowthType"></a>
The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:  
 **Linear**: For this type, AWS AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.  
 **Exponential**: For this type, AWS AppConfig processes the deployment exponentially using the following formula: `G*(2^N)`. In this formula, `G` is the growth factor specified by the user and `N` is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:  
 `2*(2^0)`   
 `2*(2^1)`   
 `2*(2^2)`   
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.  
Type: String  
Valid Values: `LINEAR | EXPONENTIAL`   
Required: No

## Response Syntax
<a name="API_UpdateDeploymentStrategy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DeploymentDurationInMinutes": number,
   "Description": "string",
   "FinalBakeTimeInMinutes": number,
   "GrowthFactor": number,
   "GrowthType": "string",
   "Id": "string",
   "Name": "string",
   "ReplicateTo": "string"
}
```

## Response Elements
<a name="API_UpdateDeploymentStrategy_ResponseElements"></a>

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

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

 ** [DeploymentDurationInMinutes](#API_UpdateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-response-DeploymentDurationInMinutes"></a>
Total amount of time the deployment lasted.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [Description](#API_UpdateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-response-Description"></a>
The description of the deployment strategy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [FinalBakeTimeInMinutes](#API_UpdateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-response-FinalBakeTimeInMinutes"></a>
The amount of time that AWS AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1440.

 ** [GrowthFactor](#API_UpdateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-response-GrowthFactor"></a>
The percentage of targets that received a deployed configuration during each interval.  
Type: Float  
Valid Range: Minimum value of 1.0. Maximum value of 100.0.

 ** [GrowthType](#API_UpdateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-response-GrowthType"></a>
The algorithm used to define how percentage grew over time.  
Type: String  
Valid Values: `LINEAR | EXPONENTIAL` 

 ** [Id](#API_UpdateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-response-Id"></a>
The deployment strategy ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Name](#API_UpdateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-response-Name"></a>
The name of the deployment strategy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [ReplicateTo](#API_UpdateDeploymentStrategy_ResponseSyntax) **   <a name="appconfig-UpdateDeploymentStrategy-response-ReplicateTo"></a>
Save the deployment strategy to a Systems Manager (SSM) document.  
Type: String  
Valid Values: `NONE | SSM_DOCUMENT` 

## Errors
<a name="API_UpdateDeploymentStrategy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateDeploymentStrategy_Examples"></a>

### Example
<a name="API_UpdateDeploymentStrategy_Example_1"></a>

This example illustrates one usage of UpdateDeploymentStrategy.

#### Sample Request
<a name="API_UpdateDeploymentStrategy_Example_1_Request"></a>

```
PATCH /deploymentstrategies/1225qzk 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-deployment-strategy
X-Amz-Date: 20210920T213749Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 30

{
    "FinalBakeTimeInMinutes": 20
}
```

#### Sample Response
<a name="API_UpdateDeploymentStrategy_Example_1_Response"></a>

```
{
    "Id": "1225qzk",
    "Name": "Example-Deployment",
    "DeploymentDurationInMinutes": 15,
    "GrowthType": "LINEAR",
    "GrowthFactor": 25.0,
    "FinalBakeTimeInMinutes": 20,
    "ReplicateTo": "SSM_DOCUMENT"
}
```

## See Also
<a name="API_UpdateDeploymentStrategy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/UpdateDeploymentStrategy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/UpdateDeploymentStrategy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/UpdateDeploymentStrategy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/UpdateDeploymentStrategy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/UpdateDeploymentStrategy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/UpdateDeploymentStrategy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/UpdateDeploymentStrategy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/UpdateDeploymentStrategy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/UpdateDeploymentStrategy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/UpdateDeploymentStrategy) 

# UpdateEnvironment
<a name="API_UpdateEnvironment"></a>

Updates an environment.

## Request Syntax
<a name="API_UpdateEnvironment_RequestSyntax"></a>

```
PATCH /applications/ApplicationId/environments/EnvironmentId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Monitors": [ 
      { 
         "AlarmArn": "string",
         "AlarmRoleArn": "string"
      }
   ],
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateEnvironment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_UpdateEnvironment_RequestSyntax) **   <a name="appconfig-UpdateEnvironment-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [EnvironmentId](#API_UpdateEnvironment_RequestSyntax) **   <a name="appconfig-UpdateEnvironment-request-uri-EnvironmentId"></a>
The environment ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_UpdateEnvironment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateEnvironment_RequestSyntax) **   <a name="appconfig-UpdateEnvironment-request-Description"></a>
A description of the environment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [Monitors](#API_UpdateEnvironment_RequestSyntax) **   <a name="appconfig-UpdateEnvironment-request-Monitors"></a>
Amazon CloudWatch alarms to monitor during the deployment process.  
Type: Array of [Monitor](API_Monitor.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [Name](#API_UpdateEnvironment_RequestSyntax) **   <a name="appconfig-UpdateEnvironment-request-Name"></a>
The name of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Syntax
<a name="API_UpdateEnvironment_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Description": "string",
   "Id": "string",
   "Monitors": [ 
      { 
         "AlarmArn": "string",
         "AlarmRoleArn": "string"
      }
   ],
   "Name": "string",
   "State": "string"
}
```

## Response Elements
<a name="API_UpdateEnvironment_ResponseElements"></a>

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](#API_UpdateEnvironment_ResponseSyntax) **   <a name="appconfig-UpdateEnvironment-response-ApplicationId"></a>
The application ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Description](#API_UpdateEnvironment_ResponseSyntax) **   <a name="appconfig-UpdateEnvironment-response-Description"></a>
The description of the environment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_UpdateEnvironment_ResponseSyntax) **   <a name="appconfig-UpdateEnvironment-response-Id"></a>
The environment ID.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Monitors](#API_UpdateEnvironment_ResponseSyntax) **   <a name="appconfig-UpdateEnvironment-response-Monitors"></a>
Amazon CloudWatch alarms monitored during the deployment.  
Type: Array of [Monitor](API_Monitor.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

 ** [Name](#API_UpdateEnvironment_ResponseSyntax) **   <a name="appconfig-UpdateEnvironment-response-Name"></a>
The name of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [State](#API_UpdateEnvironment_ResponseSyntax) **   <a name="appconfig-UpdateEnvironment-response-State"></a>
The state of the environment. An environment can be in one of the following states: `READY_FOR_DEPLOYMENT`, `DEPLOYING`, `ROLLING_BACK`, or `ROLLED_BACK`   
Type: String  
Valid Values: `READY_FOR_DEPLOYMENT | DEPLOYING | ROLLING_BACK | ROLLED_BACK | REVERTED` 

## Errors
<a name="API_UpdateEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateEnvironment_Examples"></a>

### Example
<a name="API_UpdateEnvironment_Example_1"></a>

This example illustrates one usage of UpdateEnvironment.

#### Sample Request
<a name="API_UpdateEnvironment_Example_1_Request"></a>

```
PATCH /applications/abc1234/environments/54j1r29 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-environment
X-Amz-Date: 20210920T214253Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 47

{
	"Description": "An environment for examples."
}
```

#### Sample Response
<a name="API_UpdateEnvironment_Example_1_Response"></a>

```
{
    "ApplicationId": "abc1234",
    "Id": "54j1r29",
    "Name": "Example-Environment",
    "Description": "An environment for examples.",
    "State": "RolledBack"
}
```

## See Also
<a name="API_UpdateEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/UpdateEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/UpdateEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/UpdateEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/UpdateEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/UpdateEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/UpdateEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/UpdateEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/UpdateEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/UpdateEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/UpdateEnvironment) 

# UpdateExtension
<a name="API_UpdateExtension"></a>

Updates an AWS AppConfig extension. For more information about extensions, see [Extending workflows](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the * AWS AppConfig User Guide*.

## Request Syntax
<a name="API_UpdateExtension_RequestSyntax"></a>

```
PATCH /extensions/ExtensionIdentifier HTTP/1.1
Content-type: application/json

{
   "Actions": { 
      "string" : [ 
         { 
            "Description": "string",
            "Name": "string",
            "RoleArn": "string",
            "Uri": "string"
         }
      ]
   },
   "Description": "string",
   "Parameters": { 
      "string" : { 
         "Description": "string",
         "Dynamic": boolean,
         "Required": boolean
      }
   },
   "VersionNumber": number
}
```

## URI Request Parameters
<a name="API_UpdateExtension_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ExtensionIdentifier](#API_UpdateExtension_RequestSyntax) **   <a name="appconfig-UpdateExtension-request-uri-ExtensionIdentifier"></a>
The name, the ID, or the Amazon Resource Name (ARN) of the extension.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Request Body
<a name="API_UpdateExtension_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Actions](#API_UpdateExtension_RequestSyntax) **   <a name="appconfig-UpdateExtension-request-Actions"></a>
The actions defined in the extension.  
Type: String to array of [Action](API_Action.md) objects map  
Map Entries: Maximum number of 5 items.  
Valid Keys: `PRE_CREATE_HOSTED_CONFIGURATION_VERSION | PRE_START_DEPLOYMENT | AT_DEPLOYMENT_TICK | ON_DEPLOYMENT_START | ON_DEPLOYMENT_STEP | ON_DEPLOYMENT_BAKING | ON_DEPLOYMENT_COMPLETE | ON_DEPLOYMENT_ROLLED_BACK`   
Array Members: Fixed number of 1 item.  
Required: No

 ** [Description](#API_UpdateExtension_RequestSyntax) **   <a name="appconfig-UpdateExtension-request-Description"></a>
Information about the extension.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [Parameters](#API_UpdateExtension_RequestSyntax) **   <a name="appconfig-UpdateExtension-request-Parameters"></a>
One or more parameters for the actions called by the extension.  
Type: String to [Parameter](API_Parameter.md) object map  
Map Entries: Maximum number of 10 items.  
Key Pattern: `^[^\/#:\n]{1,64}$`   
Required: No

 ** [VersionNumber](#API_UpdateExtension_RequestSyntax) **   <a name="appconfig-UpdateExtension-request-VersionNumber"></a>
The extension version number.  
Type: Integer  
Required: No

## Response Syntax
<a name="API_UpdateExtension_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Actions": { 
      "string" : [ 
         { 
            "Description": "string",
            "Name": "string",
            "RoleArn": "string",
            "Uri": "string"
         }
      ]
   },
   "Arn": "string",
   "Description": "string",
   "Id": "string",
   "Name": "string",
   "Parameters": { 
      "string" : { 
         "Description": "string",
         "Dynamic": boolean,
         "Required": boolean
      }
   },
   "VersionNumber": number
}
```

## Response Elements
<a name="API_UpdateExtension_ResponseElements"></a>

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

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

 ** [Actions](#API_UpdateExtension_ResponseSyntax) **   <a name="appconfig-UpdateExtension-response-Actions"></a>
The actions defined in the extension.  
Type: String to array of [Action](API_Action.md) objects map  
Map Entries: Maximum number of 5 items.  
Valid Keys: `PRE_CREATE_HOSTED_CONFIGURATION_VERSION | PRE_START_DEPLOYMENT | AT_DEPLOYMENT_TICK | ON_DEPLOYMENT_START | ON_DEPLOYMENT_STEP | ON_DEPLOYMENT_BAKING | ON_DEPLOYMENT_COMPLETE | ON_DEPLOYMENT_ROLLED_BACK`   
Array Members: Fixed number of 1 item.

 ** [Arn](#API_UpdateExtension_ResponseSyntax) **   <a name="appconfig-UpdateExtension-response-Arn"></a>
The system-generated Amazon Resource Name (ARN) for the extension.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [Description](#API_UpdateExtension_ResponseSyntax) **   <a name="appconfig-UpdateExtension-response-Description"></a>
Information about the extension.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [Id](#API_UpdateExtension_ResponseSyntax) **   <a name="appconfig-UpdateExtension-response-Id"></a>
The system-generated ID of the extension.  
Type: String  
Pattern: `[a-z0-9]{4,7}` 

 ** [Name](#API_UpdateExtension_ResponseSyntax) **   <a name="appconfig-UpdateExtension-response-Name"></a>
The extension name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [Parameters](#API_UpdateExtension_ResponseSyntax) **   <a name="appconfig-UpdateExtension-response-Parameters"></a>
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AWS AppConfig resource by using the `CreateExtensionAssociation` API action. For AWS Lambda extension actions, these parameters are included in the Lambda request object.  
Type: String to [Parameter](API_Parameter.md) object map  
Map Entries: Maximum number of 10 items.  
Key Pattern: `^[^\/#:\n]{1,64}$` 

 ** [VersionNumber](#API_UpdateExtension_ResponseSyntax) **   <a name="appconfig-UpdateExtension-response-VersionNumber"></a>
The extension version number.  
Type: Integer

## Errors
<a name="API_UpdateExtension_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** 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
<a name="API_UpdateExtension_Examples"></a>

### Example
<a name="API_UpdateExtension_Example_1"></a>

This example illustrates one usage of UpdateExtension.

#### Sample Request
<a name="API_UpdateExtension_Example_1_Request"></a>

```
PATCH /extensions/my-test-extension HTTP/1.1
Host: appconfig.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Type: application/json
User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/appconfig.update-extension
X-Amz-Date: 20220803T222153Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 90

{"Parameters": {"MyParamKey": {"Required": true}, "MyOtherParamKey": {"Required": false}}}
```

#### Sample Response
<a name="API_UpdateExtension_Example_1_Response"></a>

```
{
	"Actions": {
		"PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [{
			"Description": null,
			"Name": "S3backup",
			"RoleArn": "arn:aws:iam::111122223333:role/mytestextensionrole",
			"Uri": "arn:aws:lambda:us-west-2:111122223333:function:mytestfunction"
		}]
	},
	"Arn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1",
	"Description": null,
	"Id": "6czExample",
	"Name": "my-test-extension",
	"Parameters": {
		"MyOtherParamKey": {
			"Description": null,
			"Required": false
		},
		"MyParamKey": {
			"Description": null,
			"Required": true
		}
	},
	"VersionNumber": 1
}
```

## See Also
<a name="API_UpdateExtension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/UpdateExtension) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/UpdateExtension) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/UpdateExtension) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/UpdateExtension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/UpdateExtension) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/UpdateExtension) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/UpdateExtension) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/UpdateExtension) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/UpdateExtension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/UpdateExtension) 

# UpdateExtensionAssociation
<a name="API_UpdateExtensionAssociation"></a>

Updates an association. For more information about extensions and associations, see [Extending workflows](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the * AWS AppConfig User Guide*.

## Request Syntax
<a name="API_UpdateExtensionAssociation_RequestSyntax"></a>

```
PATCH /extensionassociations/ExtensionAssociationId HTTP/1.1
Content-type: application/json

{
   "Parameters": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_UpdateExtensionAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ExtensionAssociationId](#API_UpdateExtensionAssociation_RequestSyntax) **   <a name="appconfig-UpdateExtensionAssociation-request-uri-ExtensionAssociationId"></a>
The system-generated ID for the association.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

## Request Body
<a name="API_UpdateExtensionAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Parameters](#API_UpdateExtensionAssociation_RequestSyntax) **   <a name="appconfig-UpdateExtensionAssociation-request-Parameters"></a>
The parameter names and values defined in the extension.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Pattern: `^[^\/#:\n]{1,64}$`   
Value Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_UpdateExtensionAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "ExtensionArn": "string",
   "ExtensionVersionNumber": number,
   "Id": "string",
   "Parameters": { 
      "string" : "string" 
   },
   "ResourceArn": "string"
}
```

## Response Elements
<a name="API_UpdateExtensionAssociation_ResponseElements"></a>

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

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

 ** [Arn](#API_UpdateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-UpdateExtensionAssociation-response-Arn"></a>
The system-generated Amazon Resource Name (ARN) for the extension.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [ExtensionArn](#API_UpdateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-UpdateExtensionAssociation-response-ExtensionArn"></a>
The ARN of the extension defined in the association.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

 ** [ExtensionVersionNumber](#API_UpdateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-UpdateExtensionAssociation-response-ExtensionVersionNumber"></a>
The version number for the extension defined in the association.  
Type: Integer

 ** [Id](#API_UpdateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-UpdateExtensionAssociation-response-Id"></a>
The system-generated ID for the association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Parameters](#API_UpdateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-UpdateExtensionAssociation-response-Parameters"></a>
The parameter names and values defined in the association.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Pattern: `^[^\/#:\n]{1,64}$`   
Value Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [ResourceArn](#API_UpdateExtensionAssociation_ResponseSyntax) **   <a name="appconfig-UpdateExtensionAssociation-response-ResourceArn"></a>
The ARNs of applications, configuration profiles, or environments defined in the association.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+` 

## Errors
<a name="API_UpdateExtensionAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateExtensionAssociation_Examples"></a>

### Example
<a name="API_UpdateExtensionAssociation_Example_1"></a>

This example illustrates one usage of UpdateExtensionAssociation.

#### Sample Request
<a name="API_UpdateExtensionAssociation_Example_1_Request"></a>

```
PATCH /extensionassociations/rnekru4 HTTP/1.1
Host: appconfig.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Type: application/json
User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/appconfig.update-extension-association
X-Amz-Date: 20220803T222640Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 53

{"Parameters": {"MyParamKey": "DifferentParamValue"}}
```

#### Sample Response
<a name="API_UpdateExtensionAssociation_Example_1_Response"></a>

```
{
	"Arn": null,
	"ExtensionArn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1",
	"ExtensionVersionNumber": 1,
	"Id": "rnekru4",
	"Parameters": {
		"MyParamKey": "DifferentParamValue"
	},
	"ResourceArn": "arn:aws:appconfig:us-west-2:111122223333:application/xlmExample"
}
```

## See Also
<a name="API_UpdateExtensionAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/UpdateExtensionAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/UpdateExtensionAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/UpdateExtensionAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/UpdateExtensionAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/UpdateExtensionAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/UpdateExtensionAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/UpdateExtensionAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/UpdateExtensionAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/UpdateExtensionAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/UpdateExtensionAssociation) 

# ValidateConfiguration
<a name="API_ValidateConfiguration"></a>

Uses the validators in a configuration profile to validate a configuration.

## Request Syntax
<a name="API_ValidateConfiguration_RequestSyntax"></a>

```
POST /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/validators?configuration_version=ConfigurationVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_ValidateConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationId](#API_ValidateConfiguration_RequestSyntax) **   <a name="appconfig-ValidateConfiguration-request-uri-ApplicationId"></a>
The application ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ConfigurationProfileId](#API_ValidateConfiguration_RequestSyntax) **   <a name="appconfig-ValidateConfiguration-request-uri-ConfigurationProfileId"></a>
The configuration profile ID.  
Pattern: `[a-z0-9]{4,7}`   
Required: Yes

 ** [ConfigurationVersion](#API_ValidateConfiguration_RequestSyntax) **   <a name="appconfig-ValidateConfiguration-request-uri-ConfigurationVersion"></a>
The version of the configuration to validate.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

## Request Body
<a name="API_ValidateConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ValidateConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_ValidateConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_ValidateConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_ValidateConfiguration_Examples"></a>

### Example
<a name="API_ValidateConfiguration_Example_1"></a>

This example illustrates one usage of ValidateConfiguration.

#### Sample Request
<a name="API_ValidateConfiguration_Example_1_Request"></a>

```
POST /applications/abc1234/configurationprofiles/ur8hx2f/validators?configuration_version=1 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.validate-configuration
X-Amz-Date: 20210920T214947Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_ValidateConfiguration_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_ValidateConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfig-2019-10-09/ValidateConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfig-2019-10-09/ValidateConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfig-2019-10-09/ValidateConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfig-2019-10-09/ValidateConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfig-2019-10-09/ValidateConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfig-2019-10-09/ValidateConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfig-2019-10-09/ValidateConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfig-2019-10-09/ValidateConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfig-2019-10-09/ValidateConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfig-2019-10-09/ValidateConfiguration) 

# AWS AppConfig Data
<a name="API_Operations_AWS_AppConfig_Data"></a>

The following actions are supported by AWS AppConfig Data:
+  [GetLatestConfiguration](API_appconfigdata_GetLatestConfiguration.md) 
+  [StartConfigurationSession](API_appconfigdata_StartConfigurationSession.md) 

# GetLatestConfiguration
<a name="API_appconfigdata_GetLatestConfiguration"></a>

Retrieves the latest deployed configuration. This API may return empty configuration data if the client already has the latest version. For more information about this API action and to view example AWS CLI commands that show how to use it with the [StartConfigurationSession](API_appconfigdata_StartConfigurationSession.md) API action, see [Retrieving feature flags and configuration data in AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/retrieving-feature-flags.html) in the * AWS AppConfig User Guide*. 

**Important**  
Note the following important information.  
Each configuration token is only valid for one call to `GetLatestConfiguration`. The `GetLatestConfiguration` response includes a `NextPollConfigurationToken` that should always replace the token used for the just-completed call in preparation for the next one.
 `GetLatestConfiguration` is a priced call. For more information, see [Pricing](https://aws.amazon.com/systems-manager/pricing/).
You can configure applications to retrieve configuration data from a local cache rather than directly calling AWS AppConfig. Caching can improve performance and reduce costs. You can use the AWS AppConfig AWS Lambda extension to cache data on your behalf. For more information, see [AWS AppConfig integration with Lambda extensions](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-integration-lambda-extensions.html) in the AWS AppConfig User Guide.  
For containerized environments, you can use the AWS AppConfig agent for Amazon Elastic Container Service or Amazon Elastic Kubernetes Service. For more information, see [AWS AppConfig integration with Amazon ECS and Amazon EKS](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-integration-containers-agent.html).

## Request Syntax
<a name="API_appconfigdata_GetLatestConfiguration_RequestSyntax"></a>

```
GET /configuration?configuration_token=ConfigurationToken HTTP/1.1
```

## URI Request Parameters
<a name="API_appconfigdata_GetLatestConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConfigurationToken](#API_appconfigdata_GetLatestConfiguration_RequestSyntax) **   <a name="appconfig-appconfigdata_GetLatestConfiguration-request-uri-ConfigurationToken"></a>
Token describing the current state of the configuration session. To obtain a token, first call the [StartConfigurationSession](API_appconfigdata_StartConfigurationSession.md) API. Note that every call to `GetLatestConfiguration` will return a new `ConfigurationToken` (`NextPollConfigurationToken` in the response) and *must* be provided to subsequent `GetLatestConfiguration` API calls.  
This token should only be used once. To support long poll use cases, the token is valid for up to 24 hours. If a `GetLatestConfiguration` call uses an expired token, the system returns `BadRequestException`.
Pattern: `\S{1,8192}`   
Required: Yes

## Request Body
<a name="API_appconfigdata_GetLatestConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_appconfigdata_GetLatestConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Next-Poll-Configuration-Token: NextPollConfigurationToken
Next-Poll-Interval-In-Seconds: NextPollIntervalInSeconds
Content-Type: ContentType
Version-Label: VersionLabel

Configuration
```

## Response Elements
<a name="API_appconfigdata_GetLatestConfiguration_ResponseElements"></a>

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

The response returns the following HTTP headers.

 ** [ContentType](#API_appconfigdata_GetLatestConfiguration_ResponseSyntax) **   <a name="appconfig-appconfigdata_GetLatestConfiguration-response-ContentType"></a>
A standard MIME type describing the format of the configuration content.

 ** [NextPollConfigurationToken](#API_appconfigdata_GetLatestConfiguration_ResponseSyntax) **   <a name="appconfig-appconfigdata_GetLatestConfiguration-response-NextPollConfigurationToken"></a>
The latest token describing the current state of the configuration session. This *must* be provided to the next call to `GetLatestConfiguration.`   
This token should only be used once. To support long poll use cases, the token is valid for up to 24 hours. If a `GetLatestConfiguration` call uses an expired token, the system returns `BadRequestException`.
Pattern: `\S{1,8192}` 

 ** [NextPollIntervalInSeconds](#API_appconfigdata_GetLatestConfiguration_ResponseSyntax) **   <a name="appconfig-appconfigdata_GetLatestConfiguration-response-NextPollIntervalInSeconds"></a>
The amount of time the client should wait before polling for configuration updates again. The default value is 60 seconds. If you specify a value for `RequiredMinimumPollIntervalInSeconds`, the service uses the specified value for the desired poll interval instead.

 ** [VersionLabel](#API_appconfigdata_GetLatestConfiguration_ResponseSyntax) **   <a name="appconfig-appconfigdata_GetLatestConfiguration-response-VersionLabel"></a>
The user-defined label for the AWS AppConfig hosted configuration version. This attribute doesn't apply if the configuration is not from an AWS AppConfig hosted configuration version. If the client already has the latest version of the configuration data, this value is empty.

The response returns the following as the HTTP body.

 ** [Configuration](#API_appconfigdata_GetLatestConfiguration_ResponseSyntax) **   <a name="appconfig-appconfigdata_GetLatestConfiguration-response-Configuration"></a>
The data of the configuration. This may be empty if the client already has the latest version of configuration.

## Errors
<a name="API_appconfigdata_GetLatestConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The input fails to satisfy the constraints specified by the service.    
 ** Details **   
Details describing why the request was invalid.  
 ** Reason **   
Code indicating the reason the request was invalid.
HTTP Status Code: 400

 ** InternalServerException **   
There was an internal failure in the service.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource could not be found.    
 ** ReferencedBy **   
A map indicating which parameters in the request reference the resource that was not found.  
 ** ResourceType **   
The type of resource that was not found.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

## Examples
<a name="API_appconfigdata_GetLatestConfiguration_Examples"></a>

### Example
<a name="API_appconfigdata_GetLatestConfiguration_Example_1"></a>

This example illustrates one usage of GetLatestConfiguration.

#### Sample Request
<a name="API_appconfigdata_GetLatestConfiguration_Example_1_Request"></a>

```
GET /configuration?configuration_token=AYADeNgfsRxdKiJ37A12OZ9vN2cAXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREF1RzlLMTg1Tkx2Wjk4OGV2UXkyQ1UxV2ZxaGJTdkt2MkprKzJ4TlY2VkM0ZDVoRzBvbXFBTnFHcXpXcjU0dUM3Zz09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLXdlc3QtMTo4MzIyNzQ3ODA3Mzc6a2V5LzA4MGYxYWI3LTNjNmYtNGE1Yi04ZTg2LWE2MjdmNWJiMmRlMQC4AQIBAHiWVBJIpqEFGgjvLHxtJImRmyljpZnxt7FfxeEOE5H8xQF1SfOlWZFnHujbzJmIvNeSAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM0iTa25yw3uwnO6%2BrAgEQgDvLYYILWH%2Fx3SKKgyW1nOeBtS6go21vVPA6b8%2FwoFpxhzwjxy80jOfkVC2lM2l626BnJCvSPFfuZvcz%2FQIAAAAADAAAEAAAAAAAAAAAAAAAAADpQpWKSwnomgzEkYmidGKJ%2F%2F%2F%2F%2FwAAAAEAAAAAAAAAAAAAAAEAAAD8yfxkWB0geYfyI%2BDNJGiryebhmEoi8S8UHZSNN5JjJzTN2iORkjrA3DVvnhBTfoPh7o5bl4jwSYa%2F6as%2BmuQ9ntjYwymTZu7inYhsICYUKEDFxonBFJaEC32jEfg%2FMbPaGLOhNHdISiPAlMlOYmsw7phgl6ldbs9qrKVLlk1WNO3XTJiXyaWY4ANMfAX2JgMbGvNNY3HbfUneDGOENg6IfwKDykELIrJ6feE0JyKOV7mXfp%2F0r2pNiW9d6q%2BWDD1w4T87gCxgUGEPB%2FJ7JG3RhpGvECUmgKA0T06MjA7kWdt2IofDaLzRppFGpgLoPmxpM4qHz%2Fw6dMDmeXybKNZP84UP12zsJtUMhuspEQBnMGUCMQD8ssc6G8e6u8nov1ZdgF4m1ad3qyjiFd9DNRZHgLRFpw7%2BQIO%2FRB1l%2FIExP2ftUlkCMBT9oNlClJg4l9uGW5%2FqAiJ5n9ivK0ElRMwpvx96damGxt125XtMkmYf6a0OWSqnBw%3D%3D HTTP/1.1
Host: appconfigdata.us-west-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.4.15 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/appconfigdata.get-latest-configuration
X-Amz-Date: 20220218T190734Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220218/us-west-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_appconfigdata_GetLatestConfiguration_Example_1_Response"></a>

```
{
	"betaGroup": {
		"enabled": true
	}
}
```

## See Also
<a name="API_appconfigdata_GetLatestConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfigdata-2021-11-11/GetLatestConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfigdata-2021-11-11/GetLatestConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfigdata-2021-11-11/GetLatestConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfigdata-2021-11-11/GetLatestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfigdata-2021-11-11/GetLatestConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfigdata-2021-11-11/GetLatestConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfigdata-2021-11-11/GetLatestConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfigdata-2021-11-11/GetLatestConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfigdata-2021-11-11/GetLatestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfigdata-2021-11-11/GetLatestConfiguration) 

# StartConfigurationSession
<a name="API_appconfigdata_StartConfigurationSession"></a>

Starts a configuration session used to retrieve a deployed configuration. For more information about this API action and to view example AWS CLI commands that show how to use it with the [GetLatestConfiguration](API_appconfigdata_GetLatestConfiguration.md) API action, see [Retrieving feature flags and configuration data in AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/retrieving-feature-flags.html) in the * AWS AppConfig User Guide*. 

## Request Syntax
<a name="API_appconfigdata_StartConfigurationSession_RequestSyntax"></a>

```
POST /configurationsessions HTTP/1.1
Content-type: application/json

{
   "ApplicationIdentifier": "string",
   "ConfigurationProfileIdentifier": "string",
   "EnvironmentIdentifier": "string",
   "RequiredMinimumPollIntervalInSeconds": number
}
```

## URI Request Parameters
<a name="API_appconfigdata_StartConfigurationSession_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_appconfigdata_StartConfigurationSession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ApplicationIdentifier](#API_appconfigdata_StartConfigurationSession_RequestSyntax) **   <a name="appconfig-appconfigdata_StartConfigurationSession-request-ApplicationIdentifier"></a>
The application ID or the application name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** [ConfigurationProfileIdentifier](#API_appconfigdata_StartConfigurationSession_RequestSyntax) **   <a name="appconfig-appconfigdata_StartConfigurationSession-request-ConfigurationProfileIdentifier"></a>
The configuration profile ID or the configuration profile name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** [EnvironmentIdentifier](#API_appconfigdata_StartConfigurationSession_RequestSyntax) **   <a name="appconfig-appconfigdata_StartConfigurationSession-request-EnvironmentIdentifier"></a>
The environment ID or the environment name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** [RequiredMinimumPollIntervalInSeconds](#API_appconfigdata_StartConfigurationSession_RequestSyntax) **   <a name="appconfig-appconfigdata_StartConfigurationSession-request-RequiredMinimumPollIntervalInSeconds"></a>
(Optional) Sets a constraint on a session. If you specify a value of, for example, 60 seconds, then the client that established the session can't call [GetLatestConfiguration](API_appconfigdata_GetLatestConfiguration.md) more frequently than every 60 seconds.  
Type: Integer  
Valid Range: Minimum value of 15. Maximum value of 86400.  
Required: No

## Response Syntax
<a name="API_appconfigdata_StartConfigurationSession_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "InitialConfigurationToken": "string"
}
```

## Response Elements
<a name="API_appconfigdata_StartConfigurationSession_ResponseElements"></a>

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

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

 ** [InitialConfigurationToken](#API_appconfigdata_StartConfigurationSession_ResponseSyntax) **   <a name="appconfig-appconfigdata_StartConfigurationSession-response-InitialConfigurationToken"></a>
Token encapsulating state about the configuration session. Provide this token to the `GetLatestConfiguration` API to retrieve configuration data.  
This token should only be used once in your first call to `GetLatestConfiguration`. You *must* use the new token in the `GetLatestConfiguration` response (`NextPollConfigurationToken`) in each subsequent call to `GetLatestConfiguration`. If there is no change to a configuration, the token doesn't return the AWS AppConfig configuration profile.  
The `InitialConfigurationToken` and `NextPollConfigurationToken` should only be used once. To support long poll use cases, the tokens are valid for up to 24 hours. If a `GetLatestConfiguration` call uses an expired token, the system returns `BadRequestException`.
Type: String  
Pattern: `\S{1,8192}` 

## Errors
<a name="API_appconfigdata_StartConfigurationSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The input fails to satisfy the constraints specified by the service.    
 ** Details **   
Details describing why the request was invalid.  
 ** Reason **   
Code indicating the reason the request was invalid.
HTTP Status Code: 400

 ** InternalServerException **   
There was an internal failure in the service.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource could not be found.    
 ** ReferencedBy **   
A map indicating which parameters in the request reference the resource that was not found.  
 ** ResourceType **   
The type of resource that was not found.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

## Examples
<a name="API_appconfigdata_StartConfigurationSession_Examples"></a>

### Example
<a name="API_appconfigdata_StartConfigurationSession_Example_1"></a>

This example illustrates one usage of StartConfigurationSession.

#### Sample Request
<a name="API_appconfigdata_StartConfigurationSession_Example_1_Request"></a>

```
POST /configurationsessions HTTP/1.1
Host: appconfigdata.us-west-1.amazonaws.com
Accept-Encoding: identity
Content-Type: application/json
User-Agent: aws-cli/2.4.15 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/appconfigdata.start-configuration-session
X-Amz-Date: 20220218T190442Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220218/us-west-1/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 141

{"ApplicationIdentifier": "MyMobileApp", "ConfigurationProfileIdentifier": "MyAccessListFlag", "EnvironmentIdentifier": "MyMobileAppProdEnv"}
```

#### Sample Response
<a name="API_appconfigdata_StartConfigurationSession_Example_1_Response"></a>

```
{
	"InitialConfigurationToken": "AYADeNgfsRxdKiJ37A12OZ9vN2cAXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREF1RzlLMTg1Tkx2Wjk4OGV2UXkyQ1UxV2ZxaGJTdkt2MkprKzJ4TlY2VkM0ZDVoRzBvbXFBTnFHcXpXcjU0dUM3Zz09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLXdlc3QtMTo4MzIyNzQ3ODA3Mzc6a2V5LzA4MGYxYWI3LTNjNmYtNGE1Yi04ZTg2LWE2MjdmNWJiMmRlMQC4AQIBAHiWVBJIpqEFGgjvLHxtJImRmyljpZnxt7FfxeEOE5H8xQF1SfOlWZFnHujbzJmIvNeSAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM0iTa25yw3uwnO6+rAgEQgDvLYYILWH/x3SKKgyW1nOeBtS6go21vVPA6b8/woFpxhzwjxy80jOfkVC2lM2l626BnJCvSPFfuZvcz/QIAAAAADAAAEAAAAAAAAAAAAAAAAADpQpWKSwnomgzEkYmidGKJ/////wAAAAEAAAAAAAAAAAAAAAEAAAD8yfxkWB0geYfyI+DNJGiryebhmEoi8S8UHZSNN5JjJzTN2iORkjrA3DVvnhBTfoPh7o5bl4jwSYa/6as+muQ9ntjYwymTZu7inYhsICYUKEDFxonBFJaEC32jEfg/MbPaGLOhNHdISiPAlMlOYmsw7phgl6ldbs9qrKVLlk1WNO3XTJiXyaWY4ANMfAX2JgMbGvNNY3HbfUneDGOENg6IfwKDykELIrJ6feE0JyKOV7mXfp/0r2pNiW9d6q+WDD1w4T87gCxgUGEPB/J7JG3RhpGvECUmgKA0T06MjA7kWdt2IofDaLzRppFGpgLoPmxpM4qHz/w6dMDmeXybKNZP84UP12zsJtUMhuspEQBnMGUCMQD8ssc6G8e6u8nov1ZdgF4m1ad3qyjiFd9DNRZHgLRFpw7+QIO/RB1l/IExP2ftUlkCMBT9oNlClJg4l9uGW5/qAiJ5n9ivK0ElRMwpvx96damGxt125XtMkmYf6a0OWSqnBw=="
}
```

## See Also
<a name="API_appconfigdata_StartConfigurationSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appconfigdata-2021-11-11/StartConfigurationSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appconfigdata-2021-11-11/StartConfigurationSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appconfigdata-2021-11-11/StartConfigurationSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appconfigdata-2021-11-11/StartConfigurationSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appconfigdata-2021-11-11/StartConfigurationSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appconfigdata-2021-11-11/StartConfigurationSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appconfigdata-2021-11-11/StartConfigurationSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appconfigdata-2021-11-11/StartConfigurationSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appconfigdata-2021-11-11/StartConfigurationSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appconfigdata-2021-11-11/StartConfigurationSession) 