attach_user_policy

attach_user_policy(**kwargs)

Attaches the specified managed policy to the specified user.

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

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 .

See also: AWS API Documentation

Request Syntax

response = client.attach_user_policy(
    UserName='string',
    PolicyArn='string'
)
Parameters
  • UserName (string) --

    [REQUIRED]

    The name (friendly name, not ARN) of the IAM user 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: _+=,.@-

  • PolicyArn (string) --

    [REQUIRED]

    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 .

Returns

None

Exceptions

  • IAM.Client.exceptions.NoSuchEntityException
  • IAM.Client.exceptions.LimitExceededException
  • IAM.Client.exceptions.InvalidInputException
  • IAM.Client.exceptions.PolicyNotAttachableException
  • IAM.Client.exceptions.ServiceFailureException

Examples

The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.

response = client.attach_user_policy(
    PolicyArn='arn:aws:iam::aws:policy/AdministratorAccess',
    UserName='Alice',
)

print(response)

Expected Output:

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