ListPolicyPrincipals
Lists the principals associated with the specified policy.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.
Requires permission to access the ListPolicyPrincipals action.
Request Syntax
GET /policy-principals?isAscendingOrder=ascendingOrder&marker=marker&pageSize=pageSize HTTP/1.1
x-amzn-iot-policy: policyName
URI Request Parameters
The request uses the following URI parameters.
- ascendingOrder
-
Specifies the order for results. If true, the results are returned in ascending creation order.
- marker
-
The marker for the next set of results.
Length Constraints: Maximum length of 1024.
Pattern:
[A-Za-z0-9+/]+={0,2} - pageSize
-
The result page size.
Valid Range: Minimum value of 1. Maximum value of 250.
- policyName
-
The policy name.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextMarker": "string",
"principals": [ "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.
- nextMarker
-
The marker for the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
[A-Za-z0-9+/]+={0,2} - principals
-
The descriptions of the principals.
Type: Array of strings
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- UnauthorizedException
-
You are not authorized to perform this operation.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
