policy_principals

Creates, updates, deletes, gets or lists a policy_principals resource.

Overview

Name	policy_principals
Type	Resource
Id	aws.iot.policy_principals

Fields

The following fields are returned by SELECT queries:

list_policy_principals

Name	Datatype	Description
principal	string	The descriptions of the principals.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_policy_principals	select	x-amzn-iot-policy, region	marker, pageSize, isAscendingOrder	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
x-amzn-iot-policy	string	The policy name.
isAscendingOrder	boolean	Specifies the order for results. If true, the results are returned in ascending creation order.
marker	string	The marker for the next set of results.
pageSize	integer	The result page size.

SELECT examples

list_policy_principals

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.

SELECT
principal
FROM aws.iot.policy_principals
WHERE `x-amzn-iot-policy` = '{{ x-amzn-iot-policy }}' -- required
AND region = '{{ region }}' -- required
AND marker = '{{ marker }}'
AND pageSize = '{{ pageSize }}'
AND isAscendingOrder = '{{ isAscendingOrder }}'
;