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.TagUser

Description

Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
  • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

For more information about tagging, see Tagging IAM identities in the IAM User Guide.

Synopsis

Creating a Request

data TagUser Source #

See: newTagUser smart constructor.

Constructors

TagUser' 

Fields

  • userName :: Text

    The name of the IAM user to which you want to add tags.

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

  • tags :: [Tag]

    The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value.

Instances

Instances details
Eq TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Methods

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

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

Read TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Show TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Generic TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Associated Types

type Rep TagUser :: Type -> Type #

Methods

from :: TagUser -> Rep TagUser x #

to :: Rep TagUser x -> TagUser #

NFData TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Methods

rnf :: TagUser -> () #

Hashable TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Methods

hashWithSalt :: Int -> TagUser -> Int #

hash :: TagUser -> Int #

AWSRequest TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Associated Types

type AWSResponse TagUser #

ToHeaders TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Methods

toHeaders :: TagUser -> [Header] #

ToPath TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Methods

toPath :: TagUser -> ByteString #

ToQuery TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

type Rep TagUser Source # 
Instance details

Defined in Amazonka.IAM.TagUser

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

Defined in Amazonka.IAM.TagUser

newTagUser Source #

Create a value of TagUser 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:TagUser', tagUser_userName - The name of the IAM user to which you want to add tags.

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:tags:TagUser', tagUser_tags - The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value.

Request Lenses

tagUser_userName :: Lens' TagUser Text Source #

The name of the IAM user to which you want to add tags.

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

tagUser_tags :: Lens' TagUser [Tag] Source #

The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value.

Destructuring the Response

data TagUserResponse Source #

See: newTagUserResponse smart constructor.

Constructors

TagUserResponse' 

Instances

Instances details
Eq TagUserResponse Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Read TagUserResponse Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Show TagUserResponse Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Generic TagUserResponse Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Associated Types

type Rep TagUserResponse :: Type -> Type #

NFData TagUserResponse Source # 
Instance details

Defined in Amazonka.IAM.TagUser

Methods

rnf :: TagUserResponse -> () #

type Rep TagUserResponse Source # 
Instance details

Defined in Amazonka.IAM.TagUser

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

newTagUserResponse :: TagUserResponse Source #

Create a value of TagUserResponse with all optional fields omitted.

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