iam_put_user_policy: Adds or updates an inline policy document that is embedded in...

Description Usage Arguments Details Request syntax Examples

View source: R/iam_operations.R

Description

Adds or updates an inline policy document that is embedded in the specified IAM user.

Usage

1
iam_put_user_policy(UserName, PolicyName, PolicyDocument)

Arguments

UserName

[required] The name of the user 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: \_+=,[email protected]

PolicyName

[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: \_+=,[email protected]

PolicyDocument

[required] The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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 (U+0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through U+00FF)

  • The special characters tab (U+0009), line feed (U+000A), and carriage return (U+000D)

Details

An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. 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 limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

Request syntax

1
2
3
4
5
svc$put_user_policy(
  UserName = "string",
  PolicyName = "string",
  PolicyDocument = "string"
)

Examples

1
2
3
4
5
6
# The following command attaches a policy to the IAM user named Bob.
svc$put_user_policy(
  PolicyDocument = "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",...",
  PolicyName = "AllAccessPolicy",
  UserName = "Bob"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.