{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.CognitoIdentityProvider.TagResource -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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 Identity and Access Management 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. module Amazonka.CognitoIdentityProvider.TagResource ( -- * Creating a Request TagResource (..), newTagResource, -- * Request Lenses tagResource_resourceArn, tagResource_tags, -- * Destructuring the Response TagResourceResponse (..), newTagResourceResponse, -- * Response Lenses tagResourceResponse_httpStatus, ) where import Amazonka.CognitoIdentityProvider.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newTagResource' smart constructor. data TagResource = TagResource' { -- | The Amazon Resource Name (ARN) of the user pool to assign the tags to. resourceArn :: Prelude.Text, -- | The tags to assign to the user pool. tags :: Prelude.HashMap Prelude.Text Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'TagResource' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'resourceArn', 'tagResource_resourceArn' - The Amazon Resource Name (ARN) of the user pool to assign the tags to. -- -- 'tags', 'tagResource_tags' - The tags to assign to the user pool. newTagResource :: -- | 'resourceArn' Prelude.Text -> TagResource newTagResource pResourceArn_ = TagResource' { resourceArn = pResourceArn_, tags = Prelude.mempty } -- | The Amazon Resource Name (ARN) of the user pool to assign the tags to. tagResource_resourceArn :: Lens.Lens' TagResource Prelude.Text tagResource_resourceArn = Lens.lens (\TagResource' {resourceArn} -> resourceArn) (\s@TagResource' {} a -> s {resourceArn = a} :: TagResource) -- | The tags to assign to the user pool. tagResource_tags :: Lens.Lens' TagResource (Prelude.HashMap Prelude.Text Prelude.Text) tagResource_tags = Lens.lens (\TagResource' {tags} -> tags) (\s@TagResource' {} a -> s {tags = a} :: TagResource) Prelude.. Lens.coerced instance Core.AWSRequest TagResource where type AWSResponse TagResource = TagResourceResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveEmpty ( \s h x -> TagResourceResponse' Prelude.<$> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable TagResource where hashWithSalt _salt TagResource' {..} = _salt `Prelude.hashWithSalt` resourceArn `Prelude.hashWithSalt` tags instance Prelude.NFData TagResource where rnf TagResource' {..} = Prelude.rnf resourceArn `Prelude.seq` Prelude.rnf tags instance Data.ToHeaders TagResource where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AWSCognitoIdentityProviderService.TagResource" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON TagResource where toJSON TagResource' {..} = Data.object ( Prelude.catMaybes [ Prelude.Just ("ResourceArn" Data..= resourceArn), Prelude.Just ("Tags" Data..= tags) ] ) instance Data.ToPath TagResource where toPath = Prelude.const "/" instance Data.ToQuery TagResource where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newTagResourceResponse' smart constructor. data TagResourceResponse = TagResourceResponse' { -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'TagResourceResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'httpStatus', 'tagResourceResponse_httpStatus' - The response's http status code. newTagResourceResponse :: -- | 'httpStatus' Prelude.Int -> TagResourceResponse newTagResourceResponse pHttpStatus_ = TagResourceResponse' {httpStatus = pHttpStatus_} -- | The response's http status code. tagResourceResponse_httpStatus :: Lens.Lens' TagResourceResponse Prelude.Int tagResourceResponse_httpStatus = Lens.lens (\TagResourceResponse' {httpStatus} -> httpStatus) (\s@TagResourceResponse' {} a -> s {httpStatus = a} :: TagResourceResponse) instance Prelude.NFData TagResourceResponse where rnf TagResourceResponse' {..} = Prelude.rnf httpStatus