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

Description

Adds one or more tags to an IAM customer managed policy. 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 customer managed policy that has a specified 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.
  • 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.
Synopsis

Creating a Request

data TagPolicy Source #

See: newTagPolicy smart constructor.

Constructors

TagPolicy' 

Fields

  • policyArn :: Text

    The ARN of the IAM customer managed policy 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 customer managed policy. Each tag consists of a key name and an associated value.

Instances

Instances details
Eq TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Read TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Show TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Generic TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Associated Types

type Rep TagPolicy :: Type -> Type #

NFData TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Methods

rnf :: TagPolicy -> () #

Hashable TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

AWSRequest TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Associated Types

type AWSResponse TagPolicy #

ToHeaders TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Methods

toHeaders :: TagPolicy -> [Header] #

ToPath TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

ToQuery TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

type Rep TagPolicy Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

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

Defined in Amazonka.IAM.TagPolicy

newTagPolicy Source #

Create a value of TagPolicy 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:policyArn:TagPolicy', tagPolicy_policyArn - The ARN of the IAM customer managed policy 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:TagPolicy', tagPolicy_tags - The list of tags that you want to attach to the IAM customer managed policy. Each tag consists of a key name and an associated value.

Request Lenses

tagPolicy_policyArn :: Lens' TagPolicy Text Source #

The ARN of the IAM customer managed policy 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: _+=,.@-

tagPolicy_tags :: Lens' TagPolicy [Tag] Source #

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

Destructuring the Response

data TagPolicyResponse Source #

See: newTagPolicyResponse smart constructor.

Constructors

TagPolicyResponse' 

Instances

Instances details
Eq TagPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Read TagPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Show TagPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Generic TagPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Associated Types

type Rep TagPolicyResponse :: Type -> Type #

NFData TagPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

Methods

rnf :: TagPolicyResponse -> () #

type Rep TagPolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.TagPolicy

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

newTagPolicyResponse :: TagPolicyResponse Source #

Create a value of TagPolicyResponse with all optional fields omitted.

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