libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp
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.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

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource' 

Fields

Instances

Instances details
Eq TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Read TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Generic TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

NFData TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Methods

rnf :: TagResource -> () #

Hashable TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

ToJSON TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Associated Types

type AWSResponse TagResource #

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.CognitoIdentityProvider.TagResource" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))
type AWSResponse TagResource Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

newTagResource Source #

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

Instances details
Eq TagResourceResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Read TagResourceResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Show TagResourceResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Generic TagResourceResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type #

NFData TagResourceResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

Methods

rnf :: TagResourceResponse -> () #

type Rep TagResourceResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.CognitoIdentityProvider.TagResource" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTagResourceResponse Source #

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