Skip to content

IAM  >  Operations  >  attach_group_policy

attach_group_policy

Operation

attach_group_policy async

attach_group_policy(request: AttachGroupPolicyInput | AttachGroupPolicyInputDict, /, *, plugins: list[Plugin] | None = None) -> AttachGroupPolicyOutput
attach_group_policy(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AttachGroupPolicyInputDict]) -> AttachGroupPolicyOutput

Attaches the specified managed policy to the specified IAM group.

You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy .

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies 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
AttachGroupPolicyOutput

An instance of AttachGroupPolicyOutput.

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

AttachGroupPolicyInput dataclass

Bases: _SerdeShape

Dataclass for AttachGroupPolicyInput structure.

Attributes
group_name class-attribute instance-attribute
group_name: str | None = ...

The name (friendly name, not ARN) of the group to attach the policy to.

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_arn class-attribute instance-attribute
policy_arn: str | None = ...

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Dictionaries

AttachGroupPolicyInputDict

Bases: TypedDict

Dictionary form of AttachGroupPolicyInput.

Attributes
group_name instance-attribute
group_name: Required[str]

The name (friendly name, not ARN) of the group to attach the policy to.

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_arn instance-attribute
policy_arn: Required[str]

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Output

AttachGroupPolicyOutput dataclass

Bases: _SerdeShape

Dataclass for AttachGroupPolicyOutput structure.

Attributes

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.