# UpdateAgentProfile
<a name="API_UpdateAgentProfile"></a>

**Note**  
 AWS Well-Architected Agent is in preview release and is subject to change.

Updates an existing optimization profile's configuration, including its pillars, execution role, and aggregation settings. This operation uses full replacement semantics (PUT). You must include all fields in the request body, not only the fields you want to change. Any field omitted from the request is reset to its default value or cleared. To avoid unintentional data loss, retrieve the current profile with `GetAgentProfile`, modify the desired values, and pass the complete object to this operation.

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

```
PUT /api/v1/agent-profiles/{{profileArn}} HTTP/1.1
Content-type: application/json

{
   "aggregationConfiguration": [ 
      { 
         "accessRoleArn": "{{string}}",
         "accountId": "{{string}}",
         "regions": [ "{{string}}" ]
      }
   ],
   "businessOverview": "{{string}}",
   "clientToken": "{{string}}",
   "deletionProtection": {{boolean}},
   "description": "{{string}}",
   "displayName": "{{string}}",
   "executionRoleArn": "{{string}}",
   "pillars": [ "{{string}}" ]
}
```

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

The request uses the following URI parameters.

 ** [profileArn](#API_UpdateAgentProfile_RequestSyntax) **   <a name="wellarchitected-UpdateAgentProfile-request-uri-profileArn"></a>
The Amazon Resource Name (ARN) of the profile to update.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [aggregationConfiguration](#API_UpdateAgentProfile_RequestSyntax) **   <a name="wellarchitected-UpdateAgentProfile-request-aggregationConfiguration"></a>
The updated aggregation configuration.  
Type: Array of [AggregationConfiguration](API_AggregationConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** [businessOverview](#API_UpdateAgentProfile_RequestSyntax) **   <a name="wellarchitected-UpdateAgentProfile-request-businessOverview"></a>
The updated business overview for the profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Pattern: `(?:(?!\$\{[a-zA-Z]+:)[\P{C}])*`   
Required: No

 ** [clientToken](#API_UpdateAgentProfile_RequestSyntax) **   <a name="wellarchitected-UpdateAgentProfile-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [deletionProtection](#API_UpdateAgentProfile_RequestSyntax) **   <a name="wellarchitected-UpdateAgentProfile-request-deletionProtection"></a>
Indicates whether deletion protection is enabled for the profile.  
Type: Boolean  
Required: No

 ** [description](#API_UpdateAgentProfile_RequestSyntax) **   <a name="wellarchitected-UpdateAgentProfile-request-description"></a>
The updated description of the profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Pattern: `(?:(?!\$\{[a-zA-Z]+:)[\P{C}])*`   
Required: No

 ** [displayName](#API_UpdateAgentProfile_RequestSyntax) **   <a name="wellarchitected-UpdateAgentProfile-request-displayName"></a>
The updated display name of the profile.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `(?:(?!\$\{[a-zA-Z]+:)[\P{C}])+`   
Required: No

 ** [executionRoleArn](#API_UpdateAgentProfile_RequestSyntax) **   <a name="wellarchitected-UpdateAgentProfile-request-executionRoleArn"></a>
The updated ARN of the IAM execution role.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `arn:([a-z\-]+):iam::\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@\-_]+`   
Required: No

 ** [pillars](#API_UpdateAgentProfile_RequestSyntax) **   <a name="wellarchitected-UpdateAgentProfile-request-pillars"></a>
The updated AWS Well-Architected Framework pillars for the profile.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Valid Values: `COST_OPTIMIZATION | SECURITY | RESILIENCE | PERFORMANCE | OPERATIONAL_EXCELLENCE`   
Required: No

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

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

{
   "aggregationConfiguration": [ 
      { 
         "accessRoleArn": "string",
         "accountId": "string",
         "regions": [ "string" ]
      }
   ],
   "arn": "string",
   "businessOverview": "string",
   "createdAt": "string",
   "createdBy": "string",
   "deletionProtection": boolean,
   "description": "string",
   "displayName": "string",
   "eligibleForArchitectureGeneration": boolean,
   "eligibleForScheduledGeneration": boolean,
   "executionRoleArn": "string",
   "fieldErrors": { 
      "string" : "string" 
   },
   "lastModifiedAt": "string",
   "lastModifiedBy": "string",
   "name": "string",
   "pillars": [ "string" ],
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_UpdateAgentProfile_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.

 ** [aggregationConfiguration](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-aggregationConfiguration"></a>
The aggregation configuration.  
Type: Array of [AggregationConfiguration](API_AggregationConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [arn](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-arn"></a>
The Amazon Resource Name (ARN) of the updated profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)` 

 ** [businessOverview](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-businessOverview"></a>
The business overview of the updated profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Pattern: `(?:(?!\$\{[a-zA-Z]+:)[\P{C}])*` 

 ** [createdAt](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-createdAt"></a>
The timestamp when the profile was created.  
Type: Timestamp

 ** [createdBy](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-createdBy"></a>
The identifier of the user or system that created this profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [deletionProtection](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-deletionProtection"></a>
Indicates whether deletion protection is enabled.  
Type: Boolean

 ** [description](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-description"></a>
A description of the updated profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Pattern: `(?:(?!\$\{[a-zA-Z]+:)[\P{C}])*` 

 ** [displayName](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-displayName"></a>
The display name of the updated profile.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `(?:(?!\$\{[a-zA-Z]+:)[\P{C}])+` 

 ** [eligibleForArchitectureGeneration](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-eligibleForArchitectureGeneration"></a>
Indicates whether the profile is valid for manual architecture generation.  
Type: Boolean

 ** [eligibleForScheduledGeneration](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-eligibleForScheduledGeneration"></a>
Indicates whether the profile is valid for scheduled recommendation generation.  
Type: Boolean

 ** [executionRoleArn](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-executionRoleArn"></a>
The ARN of the IAM execution role.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `arn:([a-z\-]+):iam::\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@\-_]+` 

 ** [fieldErrors](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-fieldErrors"></a>
A map of field paths to error messages for invalid or missing input fields.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 100 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Value Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [lastModifiedAt](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-lastModifiedAt"></a>
The timestamp when the profile was last modified.  
Type: Timestamp

 ** [lastModifiedBy](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-lastModifiedBy"></a>
The identifier of the user or system that last modified this profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [name](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-name"></a>
The system name of the updated profile.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_-]+` 

 ** [pillars](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-pillars"></a>
The AWS Well-Architected Framework pillars associated with the updated profile.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Valid Values: `COST_OPTIMIZATION | SECURITY | RESILIENCE | PERFORMANCE | OPERATIONAL_EXCELLENCE` 

 ** [tags](#API_UpdateAgentProfile_ResponseSyntax) **   <a name="wellarchitected-UpdateAgentProfile-response-tags"></a>
The tags associated with the updated profile.  
Type: Array of [Tag](API_Tag.md) objects

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

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

 ** AccessDeniedException **   
User does not have sufficient access to perform this action.    
 ** Message **   
Description of the error.
HTTP Status Code: 403

 ** InternalServerException **   
There is a problem with the AWS Well-Architected Tool API service.    
 ** Message **   
Description of the error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource was not found.    
 ** Message **   
Description of the error.  
 ** ResourceId **   
Identifier of the resource affected.  
 ** ResourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied due to request throttling.    
 ** Message **   
Description of the error.  
 ** QuotaCode **   
Service Quotas requirement to identify originating quota.  
 ** ServiceCode **   
Service Quotas requirement to identify originating service.
HTTP Status Code: 429

 ** ValidationException **   
The user input is not valid.    
 ** Fields **   
The fields that caused the error, if applicable.  
 ** Message **   
Description of the error.  
 ** Reason **   
The reason why the request failed validation.
HTTP Status Code: 400

## See Also
<a name="API_UpdateAgentProfile_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/wellarchitected-2020-03-31/UpdateAgentProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/wellarchitected-2020-03-31/UpdateAgentProfile) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/wellarchitected-2020-03-31/UpdateAgentProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/wellarchitected-2020-03-31/UpdateAgentProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wellarchitected-2020-03-31/UpdateAgentProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/wellarchitected-2020-03-31/UpdateAgentProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/wellarchitected-2020-03-31/UpdateAgentProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/wellarchitected-2020-03-31/UpdateAgentProfile) 
+  [AWS SDK for Python (Boto3)](https://docs.aws.amazon.com/goto/boto3/wellarchitected-2020-03-31/UpdateAgentProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wellarchitected-2020-03-31/UpdateAgentProfile)