Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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
- data TagSAMLProvider = TagSAMLProvider' {
- sAMLProviderArn :: Text
- tags :: [Tag]
- newTagSAMLProvider :: Text -> TagSAMLProvider
- tagSAMLProvider_sAMLProviderArn :: Lens' TagSAMLProvider Text
- tagSAMLProvider_tags :: Lens' TagSAMLProvider [Tag]
- data TagSAMLProviderResponse = TagSAMLProviderResponse' {
- newTagSAMLProviderResponse :: TagSAMLProviderResponse
Creating a Request
data TagSAMLProvider Source #
See: newTagSAMLProvider
smart constructor.
TagSAMLProvider' | |
|
Instances
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
Eq TagSAMLProviderResponse Source # | |
Defined in Amazonka.IAM.TagSAMLProvider | |
Read TagSAMLProviderResponse Source # | |
Show TagSAMLProviderResponse Source # | |
Defined in Amazonka.IAM.TagSAMLProvider showsPrec :: Int -> TagSAMLProviderResponse -> ShowS # show :: TagSAMLProviderResponse -> String # showList :: [TagSAMLProviderResponse] -> ShowS # | |
Generic TagSAMLProviderResponse Source # | |
Defined in Amazonka.IAM.TagSAMLProvider type Rep TagSAMLProviderResponse :: Type -> Type # | |
NFData TagSAMLProviderResponse Source # | |
Defined in Amazonka.IAM.TagSAMLProvider rnf :: TagSAMLProviderResponse -> () # | |
type Rep TagSAMLProviderResponse Source # | |
newTagSAMLProviderResponse :: TagSAMLProviderResponse Source #
Create a value of TagSAMLProviderResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.