ListPrincipalPolicies
Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.
Requires permission to access the ListPrincipalPolicies action.
Request Syntax
GET /principal-policies?isAscendingOrder=ascendingOrder&marker=marker&pageSize=pageSize HTTP/1.1
x-amzn-iot-principal: principal
URI Request Parameters
The request uses the following URI parameters.
- ascendingOrder
-
Specifies the order for results. If true, 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.
- principal
-
The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextMarker": "string",
"policies": [
{
"policyArn": "string",
"policyName": "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} - policies
-
The policies.
Type: Array of Policy objects
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:
