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

Description

Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation . 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 a SAML identity provider 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 TagSAMLProvider Source #

See: newTagSAMLProvider smart constructor.

Constructors

TagSAMLProvider' 

Fields

  • sAMLProviderArn :: Text

    The ARN of the SAML identity provider in IAM 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 SAML identity provider in IAM. Each tag consists of a key name and an associated value.

Instances

Instances details
Eq TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Read TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Show TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Generic TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Associated Types

type Rep TagSAMLProvider :: Type -> Type #

NFData TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Methods

rnf :: TagSAMLProvider -> () #

Hashable TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

AWSRequest TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Associated Types

type AWSResponse TagSAMLProvider #

ToHeaders TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

ToPath TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

ToQuery TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

type Rep TagSAMLProvider Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

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

Defined in Amazonka.IAM.TagSAMLProvider

newTagSAMLProvider Source #

Create a value of TagSAMLProvider 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:sAMLProviderArn:TagSAMLProvider', tagSAMLProvider_sAMLProviderArn - The ARN of the SAML identity provider in IAM 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:TagSAMLProvider', tagSAMLProvider_tags - The list of tags that you want to attach to the SAML identity provider in IAM. Each tag consists of a key name and an associated value.

Request Lenses

tagSAMLProvider_sAMLProviderArn :: Lens' TagSAMLProvider Text Source #

The ARN of the SAML identity provider in IAM 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: _+=,.@-

tagSAMLProvider_tags :: Lens' TagSAMLProvider [Tag] Source #

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

Destructuring the Response

data TagSAMLProviderResponse Source #

See: newTagSAMLProviderResponse smart constructor.

Instances

Instances details
Eq TagSAMLProviderResponse Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Read TagSAMLProviderResponse Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Show TagSAMLProviderResponse Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Generic TagSAMLProviderResponse Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Associated Types

type Rep TagSAMLProviderResponse :: Type -> Type #

NFData TagSAMLProviderResponse Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

Methods

rnf :: TagSAMLProviderResponse -> () #

type Rep TagSAMLProviderResponse Source # 
Instance details

Defined in Amazonka.IAM.TagSAMLProvider

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

newTagSAMLProviderResponse :: TagSAMLProviderResponse Source #

Create a value of TagSAMLProviderResponse with all optional fields omitted.

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