You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/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"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#policy_input_listArray<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 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).

Returns:

  • (Array<String>)


2631
2632
2633
2634
2635
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2631

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

#policy_source_arnString

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 attached to the user as well as to 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.

Returns:

  • (String)


2631
2632
2633
2634
2635
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2631

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