get_context_keys_for_custom_policy¶
Operation¶
get_context_keys_for_custom_policy
¶
get_context_keys_for_custom_policy(request: GetContextKeysForCustomPolicyInput | GetContextKeysForCustomPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetContextKeysForCustomPolicyInputDict]) -> GetContextKeysForCustomPolicyOutput
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 GetContextKeysForPrincipalPolicy.
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 specified in an
IAM policy. Use GetContextKeysForCustomPolicy to understand what key
names and values you must supply when you call
SimulateCustomPolicy.
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetContextKeysForCustomPolicyInput | GetContextKeysForCustomPolicyInputDict | 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[GetContextKeysForCustomPolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetContextKeysForCustomPolicyOutput
|
An instance of |
get_context_keys_for_custom_policy
async
¶
get_context_keys_for_custom_policy(request: GetContextKeysForCustomPolicyInput | GetContextKeysForCustomPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetContextKeysForCustomPolicyInputDict]) -> GetContextKeysForCustomPolicyOutput
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 GetContextKeysForPrincipalPolicy.
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 specified in an
IAM policy. Use GetContextKeysForCustomPolicy to understand what key
names and values you must supply when you call
SimulateCustomPolicy.
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetContextKeysForCustomPolicyInput | GetContextKeysForCustomPolicyInputDict | 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[GetContextKeysForCustomPolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetContextKeysForCustomPolicyOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetContextKeysForCustomPolicyInputDict
¶
Bases: TypedDict
Dictionary form of GetContextKeysForCustomPolicyInput.
Attributes¶
policy_input_list
instance-attribute
¶
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)
GetContextKeysForCustomPolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetContextKeysForCustomPolicyInput structure.
Attributes¶
policy_input_list
class-attribute
instance-attribute
¶
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)
Output¶
GetContextKeysForCustomPolicyOutput
dataclass
¶
Bases: _SerdeShape
Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.
Attributes¶
context_key_names
class-attribute
instance-attribute
¶
The list of context keys that are referenced in the input policies.
response_metadata
class-attribute
instance-attribute
¶
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.