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 |
Amazonka.CognitoIdentityProvider.TagResource
Description
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is
a general category for more specific values. For example, if you have
two versions of a user pool, one for testing and another for production,
you might assign an Environment
tag key to both user pools. The value
of this key might be Test
for one user pool and Production
for the
other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
Synopsis
- data TagResource = TagResource' {}
- newTagResource :: Text -> TagResource
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- data TagResourceResponse = TagResourceResponse' {
- httpStatus :: Int
- newTagResourceResponse :: Int -> TagResourceResponse
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
Creating a Request
data TagResource Source #
See: newTagResource
smart constructor.
Constructors
TagResource' | |
Instances
Arguments
:: Text | |
-> TagResource |
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) of the user pool to assign the tags to.
$sel:tags:TagResource'
, tagResource_tags
- The tags to assign to the user pool.
Request Lenses
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the user pool to assign the tags to.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
The tags to assign to the user pool.
Destructuring the Response
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Constructors
TagResourceResponse' | |
Fields
|
Instances
newTagResourceResponse Source #
Arguments
:: Int | |
-> TagResourceResponse |
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
Response Lenses
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.