Amazonka.QuickSight.TagResource

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 Amazon Web Services services, except for the following:

• You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.
• Amazon QuickSight doesn't currently support the tag editor for Resource Groups.

Creating a Request

data TagResource

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

ToJSON TagResource

Defined in Amazonka.QuickSight.TagResource

Methods

toJSON :: TagResource -> Value

toEncoding :: TagResource -> Encoding

toJSONList :: [TagResource] -> Value

toEncodingList :: [TagResource] -> Encoding

ToHeaders TagResource

Defined in Amazonka.QuickSight.TagResource

Methods

toHeaders :: TagResource -> [Header]

ToPath TagResource

Defined in Amazonka.QuickSight.TagResource

Methods

toPath :: TagResource -> ByteString

ToQuery TagResource

Defined in Amazonka.QuickSight.TagResource

Methods

toQuery :: TagResource -> QueryString

AWSRequest TagResource

Defined in Amazonka.QuickSight.TagResource

Associated Types

type AWSResponse TagResource

Methods

request :: (Service -> Service) -> TagResource -> Request TagResource

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TagResource)))

Generic TagResource

Defined in Amazonka.QuickSight.TagResource

Associated Types

type Rep TagResource :: Type -> Type

Methods

from :: TagResource -> Rep TagResource x

to :: Rep TagResource x -> TagResource

Read TagResource

Defined in Amazonka.QuickSight.TagResource

Methods

readsPrec :: Int -> ReadS TagResource

readList :: ReadS [TagResource]

readPrec :: ReadPrec TagResource

readListPrec :: ReadPrec [TagResource]

Show TagResource

Defined in Amazonka.QuickSight.TagResource

Methods

showsPrec :: Int -> TagResource -> ShowS

show :: TagResource -> String

showList :: [TagResource] -> ShowS

NFData TagResource

Defined in Amazonka.QuickSight.TagResource

Methods

rnf :: TagResource -> ()

Eq TagResource

Defined in Amazonka.QuickSight.TagResource

Methods

(==) :: TagResource -> TagResource -> Bool

(/=) :: TagResource -> TagResource -> Bool

Hashable TagResource

Defined in Amazonka.QuickSight.TagResource

Methods

hashWithSalt :: Int -> TagResource -> Int

hash :: TagResource -> Int

type AWSResponse TagResource

Defined in Amazonka.QuickSight.TagResource

type AWSResponse TagResource = TagResourceResponse

type Rep TagResource

Defined in Amazonka.QuickSight.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.QuickSight.TagResource" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" '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))))

newTagResource

Arguments

:: Text

$sel:resourceArn:TagResource'

-> NonEmpty Tag

TagResource

-> 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 resource that you want to tag.

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

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

tagResource_tags :: Lens' TagResource (NonEmpty Tag)

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

Destructuring the Response

data TagResourceResponse

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'

Fields

• requestId :: Maybe Text

  The Amazon Web Services request ID for this operation.

• status :: Int

  The HTTP status of the request.

Instances

Generic TagResourceResponse

Defined in Amazonka.QuickSight.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type

Methods

from :: TagResourceResponse -> Rep TagResourceResponse x

to :: Rep TagResourceResponse x -> TagResourceResponse

Read TagResourceResponse

Defined in Amazonka.QuickSight.TagResource

Methods

readsPrec :: Int -> ReadS TagResourceResponse

readList :: ReadS [TagResourceResponse]

readPrec :: ReadPrec TagResourceResponse

readListPrec :: ReadPrec [TagResourceResponse]

Show TagResourceResponse

Defined in Amazonka.QuickSight.TagResource

Methods

showsPrec :: Int -> TagResourceResponse -> ShowS

show :: TagResourceResponse -> String

showList :: [TagResourceResponse] -> ShowS

NFData TagResourceResponse

Defined in Amazonka.QuickSight.TagResource

Methods

rnf :: TagResourceResponse -> ()

Eq TagResourceResponse

Defined in Amazonka.QuickSight.TagResource

Methods

(==) :: TagResourceResponse -> TagResourceResponse -> Bool

(/=) :: TagResourceResponse -> TagResourceResponse -> Bool

type Rep TagResourceResponse

Defined in Amazonka.QuickSight.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.QuickSight.TagResource" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" '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

Arguments

:: Int

TagResourceResponse

-> 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:requestId:TagResourceResponse', tagResourceResponse_requestId - The Amazon Web Services request ID for this operation.

TagResourceResponse, tagResourceResponse_status - The HTTP status of the request.

Response Lenses

tagResourceResponse_requestId :: Lens' TagResourceResponse (Maybe Text)

The Amazon Web Services request ID for this operation.

tagResourceResponse_status :: Lens' TagResourceResponse Int

The HTTP status of the request.