ListProfiles
List profiles.
Request Syntax
GET /profileSummaries?MaxResults=MaxResults&NextToken=NextToken&ProfileNamePrefix=ProfileNamePrefix&ProfileOwnerType=ProfileOwnerType 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.
- ProfileNamePrefix
-
An optional string added to the beginning of each profile name returned in the results.
Length Constraints: Maximum length of 100.
- ProfileOwnerType
-
Profile owner type.
Valid Values:
SELF | SHARED
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"ProfileSummaries": [
{
"CreatedAt": number,
"Owner": "string",
"ProfileArn": "string",
"ProfileDescription": "string",
"ProfileName": "string",
"ProfileVersion": "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.
- NextToken
-
The token to use to retrieve the next set of results.
Type: String
- ProfileSummaries
-
Profile summaries.
Type: Array of ProfileSummary 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
- 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:
