put_group_policy¶
Operation¶
put_group_policy
async
¶
put_group_policy(request: PutGroupPolicyInput | PutGroupPolicyInputDict, /, *, plugins: list[Plugin] | None = None) -> PutGroupPolicyOutput
put_group_policy(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutGroupPolicyInputDict]) -> PutGroupPolicyOutput
Adds or updates an inline policy document that is embedded in the specified IAM group.
A user can also have managed policies attached to it. To attach a
managed policy to a group, use
AttachGroupPolicy
. To create a new managed policy, use
CreatePolicy
. For information about policies, see Managed policies and inline
policies
in the IAM User Guide.
For information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide.
Note
Because policy documents can be large, you should use POST rather than
GET when calling PutGroupPolicy. For general information about using
the Query API with IAM, see Making query
requests
in the IAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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
|
Returns:
| Type | Description |
|---|---|
PutGroupPolicyOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
PutGroupPolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutGroupPolicyInput structure.
Attributes¶
group_name
class-attribute
instance-attribute
¶
group_name: str | None = ...
The name of the group to associate the policy with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.
policy_document
class-attribute
instance-attribute
¶
policy_document: str | None = ...
The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
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_name
class-attribute
instance-attribute
¶
policy_name: str | None = ...
The name of the policy document.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Dictionaries¶
PutGroupPolicyInputDict
¶
Bases: TypedDict
Dictionary form of PutGroupPolicyInput.
Attributes¶
group_name
instance-attribute
¶
The name of the group to associate the policy with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.
policy_document
instance-attribute
¶
The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
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_name
instance-attribute
¶
The name of the policy document.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Output¶
PutGroupPolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutGroupPolicyOutput structure.