Skip to content

get_context_keys_for_principal_policy

Operation

get_context_keys_for_principal_policy

get_context_keys_for_principal_policy(request: GetContextKeysForPrincipalPolicyInput | GetContextKeysForPrincipalPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetContextKeysForPrincipalPolicyInputDict]) -> GetContextKeysForPrincipalPolicyOutput

Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy. This operation doesn't return context keys referenced by service control policies (SCPs). Only context keys referenced by the identity-based policies attached to the specified entity, and any additional policies that you provide, are included.

Parameters:

Name Type Description Default
request GetContextKeysForPrincipalPolicyInput | GetContextKeysForPrincipalPolicyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetContextKeysForPrincipalPolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetContextKeysForPrincipalPolicyOutput

An instance of GetContextKeysForPrincipalPolicyOutput.

get_context_keys_for_principal_policy async

get_context_keys_for_principal_policy(request: GetContextKeysForPrincipalPolicyInput | GetContextKeysForPrincipalPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetContextKeysForPrincipalPolicyInputDict]) -> GetContextKeysForPrincipalPolicyOutput

Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy. This operation doesn't return context keys referenced by service control policies (SCPs). Only context keys referenced by the identity-based policies attached to the specified entity, and any additional policies that you provide, are included.

Parameters:

Name Type Description Default
request GetContextKeysForPrincipalPolicyInput | GetContextKeysForPrincipalPolicyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetContextKeysForPrincipalPolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetContextKeysForPrincipalPolicyOutput

An instance of GetContextKeysForPrincipalPolicyOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetContextKeysForPrincipalPolicyInputDict

Bases: TypedDict

Dictionary form of GetContextKeysForPrincipalPolicyInput.

Attributes

policy_input_list instance-attribute
policy_input_list: Sequence[str] | None

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)

policy_source_arn instance-attribute
policy_source_arn: Required[str]

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) in the Amazon Web Services General Reference.

GetContextKeysForPrincipalPolicyInput dataclass

Bases: _SerdeShape

Dataclass for GetContextKeysForPrincipalPolicyInput structure.

Attributes

policy_input_list class-attribute instance-attribute
policy_input_list: list[str] | None = ...

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)

policy_source_arn class-attribute instance-attribute
policy_source_arn: str | None = ...

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) in the Amazon Web Services General Reference.

Output

GetContextKeysForPrincipalPolicyOutput dataclass

Bases: _SerdeShape

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

Attributes

context_key_names class-attribute instance-attribute
context_key_names: list[str] | None = ...

The list of context keys that are referenced in the input policies.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.