Network.AWS.IAM.SimulateCustomPolicy

Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as strings.

The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions.

If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy .

If the output is long, you can use MaxItems and Marker parameters to paginate the results.

This operation returns paginated results.

Creating a Request

simulateCustomPolicy :: SimulateCustomPolicy

Creates a value of SimulateCustomPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• scpResourcePolicy - A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation. The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).
• scpCallerARN - The ARN of the IAM user that you want to use as the simulated caller of the APIs. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy. You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.
• scpResourceHandlingOption - Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation. Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide . * EC2-Classic-InstanceStore instance, image, security-group * EC2-Classic-EBS instance, image, security-group, volume * EC2-VPC-InstanceStore instance, image, security-group, network-interface * EC2-VPC-InstanceStore-Subnet instance, image, security-group, network-interface, subnet * EC2-VPC-EBS instance, image, security-group, network-interface, volume * EC2-VPC-EBS-Subnet instance, image, security-group, network-interface, subnet, volume
• scpResourceARNs - A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter. If you include a ResourcePolicy , then it must be applicable to all of the resources included in the simulation or you receive an invalid input error. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
• scpMarker - Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
• scpMaxItems - (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true . If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
• scpContextEntries - A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.
• scpResourceOwner - An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn . This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn .
• scpPolicyInputList - A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials. The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).
• scpActionNames - A list of names of API actions to evaluate in the simulation. Each action is evaluated against each resource. Each action must include the service identifier, such as iam:CreateUser .

data SimulateCustomPolicy

See: simulateCustomPolicy smart constructor.

Instances

Eq SimulateCustomPolicy

Methods

(==) :: SimulateCustomPolicy -> SimulateCustomPolicy -> Bool

(/=) :: SimulateCustomPolicy -> SimulateCustomPolicy -> Bool

Data SimulateCustomPolicy

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SimulateCustomPolicy -> c SimulateCustomPolicy

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SimulateCustomPolicy

toConstr :: SimulateCustomPolicy -> Constr

dataTypeOf :: SimulateCustomPolicy -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SimulateCustomPolicy)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SimulateCustomPolicy)

gmapT :: (forall b. Data b => b -> b) -> SimulateCustomPolicy -> SimulateCustomPolicy

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SimulateCustomPolicy -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SimulateCustomPolicy -> r

gmapQ :: (forall d. Data d => d -> u) -> SimulateCustomPolicy -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SimulateCustomPolicy -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SimulateCustomPolicy -> m SimulateCustomPolicy

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SimulateCustomPolicy -> m SimulateCustomPolicy

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SimulateCustomPolicy -> m SimulateCustomPolicy

Read SimulateCustomPolicy

Methods

readsPrec :: Int -> ReadS SimulateCustomPolicy

readList :: ReadS [SimulateCustomPolicy]

readPrec :: ReadPrec SimulateCustomPolicy

readListPrec :: ReadPrec [SimulateCustomPolicy]

Show SimulateCustomPolicy

Methods

showsPrec :: Int -> SimulateCustomPolicy -> ShowS

show :: SimulateCustomPolicy -> String

showList :: [SimulateCustomPolicy] -> ShowS

Generic SimulateCustomPolicy

Associated Types

type Rep SimulateCustomPolicy :: * -> *

Methods

from :: SimulateCustomPolicy -> Rep SimulateCustomPolicy x

to :: Rep SimulateCustomPolicy x -> SimulateCustomPolicy

Hashable SimulateCustomPolicy

Methods

hashWithSalt :: Int -> SimulateCustomPolicy -> Int

hash :: SimulateCustomPolicy -> Int

NFData SimulateCustomPolicy

Methods

rnf :: SimulateCustomPolicy -> ()

AWSPager SimulateCustomPolicy

Methods

page :: SimulateCustomPolicy -> Rs SimulateCustomPolicy -> Maybe SimulateCustomPolicy

AWSRequest SimulateCustomPolicy

Associated Types

type Rs SimulateCustomPolicy :: *

Methods

request :: SimulateCustomPolicy -> Request SimulateCustomPolicy

response :: MonadResource m => Logger -> Service -> Proxy * SimulateCustomPolicy -> ClientResponse -> m (Response SimulateCustomPolicy)

ToQuery SimulateCustomPolicy

Methods

toQuery :: SimulateCustomPolicy -> QueryString

ToPath SimulateCustomPolicy

Methods

toPath :: SimulateCustomPolicy -> ByteString

ToHeaders SimulateCustomPolicy

Methods

toHeaders :: SimulateCustomPolicy -> [Header]

type Rep SimulateCustomPolicy

type Rep SimulateCustomPolicy = D1 (MetaData "SimulateCustomPolicy" "Network.AWS.IAM.SimulateCustomPolicy" "amazonka-iam-1.5.0-2w4nVHAOrDgI2P1QVLKd9e" False) (C1 (MetaCons "SimulateCustomPolicy'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_scpResourcePolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_scpCallerARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_scpResourceHandlingOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_scpResourceARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_scpMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_scpMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_scpContextEntries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ContextEntry])))) ((:*:) (S1 (MetaSel (Just Symbol "_scpResourceOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_scpPolicyInputList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])) (S1 (MetaSel (Just Symbol "_scpActionNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])))))))

type Rs SimulateCustomPolicy

type Rs SimulateCustomPolicy = SimulatePolicyResponse

Request Lenses

scpResourcePolicy :: Lens' SimulateCustomPolicy (Maybe Text)

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation. The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).

scpCallerARN :: Lens' SimulateCustomPolicy (Maybe Text)

The ARN of the IAM user that you want to use as the simulated caller of the APIs. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy. You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

scpResourceHandlingOption :: Lens' SimulateCustomPolicy (Maybe Text)

Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation. Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide . * EC2-Classic-InstanceStore instance, image, security-group * EC2-Classic-EBS instance, image, security-group, volume * EC2-VPC-InstanceStore instance, image, security-group, network-interface * EC2-VPC-InstanceStore-Subnet instance, image, security-group, network-interface, subnet * EC2-VPC-EBS instance, image, security-group, network-interface, volume * EC2-VPC-EBS-Subnet instance, image, security-group, network-interface, subnet, volume

scpResourceARNs :: Lens' SimulateCustomPolicy [Text]

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter. If you include a ResourcePolicy , then it must be applicable to all of the resources included in the simulation or you receive an invalid input error. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

scpMarker :: Lens' SimulateCustomPolicy (Maybe Text)

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

scpMaxItems :: Lens' SimulateCustomPolicy (Maybe Natural)

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true . If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

scpContextEntries :: Lens' SimulateCustomPolicy [ContextEntry]

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

scpResourceOwner :: Lens' SimulateCustomPolicy (Maybe Text)

An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn . This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn .

scpPolicyInputList :: Lens' SimulateCustomPolicy [Text]

A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials. The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).

scpActionNames :: Lens' SimulateCustomPolicy [Text]

A list of names of API actions to evaluate in the simulation. Each action is evaluated against each resource. Each action must include the service identifier, such as iam:CreateUser .

Destructuring the Response

simulatePolicyResponse :: SimulatePolicyResponse

Creates a value of SimulatePolicyResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• spEvaluationResults - The results of the simulation.
• spMarker - When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
• spIsTruncated - A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

data SimulatePolicyResponse

Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.

See: simulatePolicyResponse smart constructor.

Instances

Eq SimulatePolicyResponse

Methods

(==) :: SimulatePolicyResponse -> SimulatePolicyResponse -> Bool

(/=) :: SimulatePolicyResponse -> SimulatePolicyResponse -> Bool

Data SimulatePolicyResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SimulatePolicyResponse -> c SimulatePolicyResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SimulatePolicyResponse

toConstr :: SimulatePolicyResponse -> Constr

dataTypeOf :: SimulatePolicyResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SimulatePolicyResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SimulatePolicyResponse)

gmapT :: (forall b. Data b => b -> b) -> SimulatePolicyResponse -> SimulatePolicyResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SimulatePolicyResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SimulatePolicyResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SimulatePolicyResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SimulatePolicyResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SimulatePolicyResponse -> m SimulatePolicyResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SimulatePolicyResponse -> m SimulatePolicyResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SimulatePolicyResponse -> m SimulatePolicyResponse

Read SimulatePolicyResponse

Methods

readsPrec :: Int -> ReadS SimulatePolicyResponse

readList :: ReadS [SimulatePolicyResponse]

readPrec :: ReadPrec SimulatePolicyResponse

readListPrec :: ReadPrec [SimulatePolicyResponse]

Show SimulatePolicyResponse

Methods

showsPrec :: Int -> SimulatePolicyResponse -> ShowS

show :: SimulatePolicyResponse -> String

showList :: [SimulatePolicyResponse] -> ShowS

Generic SimulatePolicyResponse

Associated Types

type Rep SimulatePolicyResponse :: * -> *

Methods

from :: SimulatePolicyResponse -> Rep SimulatePolicyResponse x

to :: Rep SimulatePolicyResponse x -> SimulatePolicyResponse

Hashable SimulatePolicyResponse

Methods

hashWithSalt :: Int -> SimulatePolicyResponse -> Int

hash :: SimulatePolicyResponse -> Int

NFData SimulatePolicyResponse

Methods

rnf :: SimulatePolicyResponse -> ()

FromXML SimulatePolicyResponse

Methods

parseXML :: [Node] -> Either String SimulatePolicyResponse

type Rep SimulatePolicyResponse

type Rep SimulatePolicyResponse = D1 (MetaData "SimulatePolicyResponse" "Network.AWS.IAM.Types.Product" "amazonka-iam-1.5.0-2w4nVHAOrDgI2P1QVLKd9e" False) (C1 (MetaCons "SimulatePolicyResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_spEvaluationResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EvaluationResult]))) ((:*:) (S1 (MetaSel (Just Symbol "_spMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_spIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))

Response Lenses

spEvaluationResults :: Lens' SimulatePolicyResponse [EvaluationResult]

The results of the simulation.

spMarker :: Lens' SimulatePolicyResponse (Maybe Text)

When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

spIsTruncated :: Lens' SimulatePolicyResponse (Maybe Bool)

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.