libZSservicesZSamazonka-quicksightZSamazonka-quicksight
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.QuickSight.TagResource

Description

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, and template.

Tagging for Amazon QuickSight works in a similar way to tagging for other AWS services, except for the following:

  • You can't use tags to track AWS costs for Amazon QuickSight. This restriction is because Amazon QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
  • Amazon QuickSight doesn't currently support the Tag Editor for Resource Groups.
Synopsis

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource' 

Fields

  • resourceArn :: Text

    The Amazon Resource Name (ARN) of the resource that you want to tag.

  • tags :: NonEmpty Tag

    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Instances

Instances details
Eq TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Read TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Generic TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

NFData TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Methods

rnf :: TagResource -> () #

Hashable TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

ToJSON TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Associated Types

type AWSResponse TagResource #

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.QuickSight.TagResource" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Tag))))
type AWSResponse TagResource Source # 
Instance details

Defined in Amazonka.QuickSight.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 resource that you want to tag.

$sel:tags:TagResource', tagResource_tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Request Lenses

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want to tag.

tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse' 

Fields

Instances

Instances details
Eq TagResourceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Read TagResourceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Show TagResourceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Generic TagResourceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type #

NFData TagResourceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

Methods

rnf :: TagResourceResponse -> () #

type Rep TagResourceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.QuickSight.TagResource" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") '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:requestId:TagResourceResponse', tagResourceResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:status:TagResourceResponse', tagResourceResponse_status - The HTTP status of the request.

Response Lenses

tagResourceResponse_requestId :: Lens' TagResourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.