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

UpdateProfile

Update a profile.

Request Syntax


PATCH /profiles/ProfileArn HTTP/1.1
Content-type: application/json

{
   "ProfileDescription": "string",
   "ProfileQuestions": [ 
      { 
         "QuestionId": "string",
         "SelectedChoiceIds": [ "string" ]
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

ProfileArn

The profile ARN.

Length Constraints: Maximum length of 2084.

Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:profile/[a-z0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

ProfileDescription

The profile description.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 100.

Required: No

ProfileQuestions

Profile questions.

Type: Array of ProfileQuestionUpdate objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Profile": { 
      "CreatedAt": number,
      "Owner": "string",
      "ProfileArn": "string",
      "ProfileDescription": "string",
      "ProfileName": "string",
      "ProfileQuestions": [ 
         { 
            "MaxSelectedChoices": number,
            "MinSelectedChoices": number,
            "QuestionChoices": [ 
               { 
                  "ChoiceDescription": "string",
                  "ChoiceId": "string",
                  "ChoiceTitle": "string"
               }
            ],
            "QuestionDescription": "string",
            "QuestionId": "string",
            "QuestionTitle": "string",
            "SelectedChoiceIds": [ "string" ]
         }
      ],
      "ProfileVersion": "string",
      "ShareInvitationId": "string",
      "Tags": { 
         "string" : "string" 
      },
      "UpdatedAt": number
   }
}

Response Elements

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

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

Profile

The profile.

Type: Profile object

Errors

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

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The resource has already been processed, was deleted, or is too large.

HTTP Status Code: 409

InternalServerException

There is a problem with the AWS Well-Architected Tool API service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The user input is not valid.

HTTP Status Code: 400