libZSservicesZSamazonka-iamZSamazonka-iam
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IAM.PutUserPolicy

Description

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

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 the maximum number of inline policies that you can embed in a user, see IAM and STS quotas 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, see Making query requests in the IAM User Guide.

Synopsis

Creating a Request

data PutUserPolicy Source #

See: newPutUserPolicy smart constructor.

Constructors

PutUserPolicy' 

Fields

  • userName :: Text

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

  • policyName :: Text

    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 :: Text

    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)

Instances

Instances details
Eq PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

(==) :: PutUserPolicy -> PutUserPolicy -> Bool #

(/=) :: PutUserPolicy -> PutUserPolicy -> Bool #

Read PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

readsPrec :: Int -> ReadS PutUserPolicy #

readList :: ReadS [PutUserPolicy] #

readPrec :: ReadPrec PutUserPolicy #

readListPrec :: ReadPrec [PutUserPolicy] #

Show PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

showsPrec :: Int -> PutUserPolicy -> ShowS #

show :: PutUserPolicy -> String #

showList :: [PutUserPolicy] -> ShowS #

Generic PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Associated Types

type Rep PutUserPolicy :: Type -> Type #

Methods

from :: PutUserPolicy -> Rep PutUserPolicy x #

to :: Rep PutUserPolicy x -> PutUserPolicy #

NFData PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

rnf :: PutUserPolicy -> () #

Hashable PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

hashWithSalt :: Int -> PutUserPolicy -> Int #

hash :: PutUserPolicy -> Int #

AWSRequest PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Associated Types

type AWSResponse PutUserPolicy #

Methods

request :: PutUserPolicy -> Request PutUserPolicy #

response :: MonadResource m => Logger -> Service -> Proxy PutUserPolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutUserPolicy))) #

ToHeaders PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

toHeaders :: PutUserPolicy -> [Header] #

ToPath PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

toPath :: PutUserPolicy -> ByteString #

ToQuery PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

toQuery :: PutUserPolicy -> QueryString #

type Rep PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

type Rep PutUserPolicy = D1 ('MetaData "PutUserPolicy" "Amazonka.IAM.PutUserPolicy" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "PutUserPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "policyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policyDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse PutUserPolicy Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

type AWSResponse PutUserPolicy = PutUserPolicyResponse

newPutUserPolicy Source #

Arguments

:: Text

$sel:userName:PutUserPolicy'

-> Text

$sel:policyName:PutUserPolicy'

-> Text

$sel:policyDocument:PutUserPolicy'

-> PutUserPolicy 

Create a value of PutUserPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userName:PutUserPolicy', putUserPolicy_userName - 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: _+=,.@-

$sel:policyName:PutUserPolicy', putUserPolicy_policyName - 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: _+=,.@-

$sel:policyDocument:PutUserPolicy', putUserPolicy_policyDocument - 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)

Request Lenses

putUserPolicy_userName :: Lens' PutUserPolicy Text Source #

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

putUserPolicy_policyName :: Lens' PutUserPolicy Text Source #

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

putUserPolicy_policyDocument :: Lens' PutUserPolicy Text Source #

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)

Destructuring the Response

data PutUserPolicyResponse Source #

See: newPutUserPolicyResponse smart constructor.

Constructors

PutUserPolicyResponse' 

Instances

Instances details
Eq PutUserPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

(==) :: PutUserPolicyResponse -> PutUserPolicyResponse -> Bool #

(/=) :: PutUserPolicyResponse -> PutUserPolicyResponse -> Bool #

Read PutUserPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

readsPrec :: Int -> ReadS PutUserPolicyResponse #

readList :: ReadS [PutUserPolicyResponse] #

readPrec :: ReadPrec PutUserPolicyResponse #

readListPrec :: ReadPrec [PutUserPolicyResponse] #

Show PutUserPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

showsPrec :: Int -> PutUserPolicyResponse -> ShowS #

show :: PutUserPolicyResponse -> String #

showList :: [PutUserPolicyResponse] -> ShowS #

Generic PutUserPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Associated Types

type Rep PutUserPolicyResponse :: Type -> Type #

Methods

from :: PutUserPolicyResponse -> Rep PutUserPolicyResponse x #

to :: Rep PutUserPolicyResponse x -> PutUserPolicyResponse #

NFData PutUserPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

Methods

rnf :: PutUserPolicyResponse -> () #

type Rep PutUserPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.PutUserPolicy

type Rep PutUserPolicyResponse = D1 ('MetaData "PutUserPolicyResponse" "Amazonka.IAM.PutUserPolicy" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "PutUserPolicyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutUserPolicyResponse :: PutUserPolicyResponse Source #

Create a value of PutUserPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.