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.
-
The maximum number of results to return for this request.
Valid Range: Minimum value of 1. Maximum value of 50.
-
The token to use to retrieve the next set of results.
-
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
-
The AWS account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.
Length Constraints: Maximum length of 100.
-
The status of the share request.
Valid Values:
ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED
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.
-
The token to use to retrieve the next set of results.
Type: String
-
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
