iam_get_context_keys_for_custom_policy: Gets a list of all of the context keys referenced in the...

Description Usage Arguments Value Request syntax

View source: R/iam_operations.R

Description

Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use get_context_keys_for_principal_policy.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use get_context_keys_for_custom_policy to understand what key names and values you must supply when you call simulate_custom_policy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request.

Usage

1

Arguments

PolicyInputList

[required] A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

Value

A list with the following syntax:

1
2
3
4
5
list(
  ContextKeyNames = list(
    "string"
  )
)

Request syntax

1
2
3
4
5
svc$get_context_keys_for_custom_policy(
  PolicyInputList = list(
    "string"
  )
)

paws.security.identity documentation built on Aug. 23, 2021, 9:16 a.m.