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

GetProfile

Get profile information.

Request Syntax


GET /profiles/ProfileArn?ProfileVersion=ProfileVersion HTTP/1.1

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

ProfileVersion

The profile version.

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

Pattern: ^[A-Za-z0-9-]+$

Request Body

The request does not have a request body.

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.

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