IAM / Client / put_group_policy

put_group_policy

IAM.Client.put_group_policy(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.put_group_policy(
    GroupName='string',
    PolicyName='string',
    PolicyDocument='string'
)

Parameters:

• GroupName (string) –

  [REQUIRED]

  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: _+=,.@-.

• PolicyName (string) –

  [REQUIRED]

  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: _+=,.@-

• PolicyDocument (string) –

  [REQUIRED]

  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)

Returns:

None

Exceptions

• IAM.Client.exceptions.LimitExceededException

• IAM.Client.exceptions.MalformedPolicyDocumentException

• IAM.Client.exceptions.NoSuchEntityException

• IAM.Client.exceptions.ServiceFailureException

Examples

The following command adds a policy named AllPerms to the IAM group named Admins.

response = client.put_group_policy(
    GroupName='Admins',
    PolicyDocument='{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"*","Resource":"*"}}',
    PolicyName='AllPerms',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}