Class: Aws::IAM::Types::GetContextKeysForPrincipalPolicyRequest

Inherits:

Struct

Object
Struct
Aws::IAM::Types::GetContextKeysForPrincipalPolicyRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass GetContextKeysForPrincipalPolicyRequest data as a hash:

{
  policy_source_arn: "arnType", # required
  policy_input_list: ["policyDocumentType"],
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#policy_input_list ⇒ Array<String>

An optional list of additional policies for which you want the list of context keys that are referenced.
#policy_source_arn ⇒ String

The ARN of a user, group, or role whose policies contain the context keys that you want listed.

Instance Attribute Details

#policy_input_list ⇒ `Array<String>`

An optional list of additional policies for which you want the list of context keys that are referenced.

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`)

[1]: wikipedia.org/wiki/regex

Returns:

(Array<String>)

# File 'lib/aws-sdk-iam/types.rb', line 3418

class GetContextKeysForPrincipalPolicyRequest < Struct.new(
  :policy_source_arn,
  :policy_input_list)
  SENSITIVE = []
  include Aws::Structure
end

#policy_source_arn ⇒ `String`

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. 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.

For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces] in the *AWS General Reference*.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html