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

ListProfileShares

List profile shares.

Request Syntax


GET /profiles/ProfileArn/shares?MaxResults=MaxResults&NextToken=NextToken&SharedWithPrefix=SharedWithPrefix&Status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return for this request.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken

The token to use to retrieve the next set of results.

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

SharedWithPrefix

The AWS account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.

Length Constraints: Maximum length of 100.

Status

The status of the share request.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ProfileShareSummaries": [ 
      { 
         "SharedWith": "string",
         "ShareId": "string",
         "Status": "string",
         "StatusMessage": "string"
      }
   ]
}

Response Elements

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

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

NextToken

The token to use to retrieve the next set of results.

Type: String

ProfileShareSummaries

Profile share summaries.

Type: Array of ProfileShareSummary objects

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

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