amazonka-athena-2.0: Amazon Athena SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Athena.TagResource

Description

Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

Synopsis

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource' 

Fields

  • resourceARN :: Text

    Specifies the ARN of the Athena resource (workgroup or data catalog) to which tags are to be added.

  • tags :: [Tag]

    A collection of one or more tags, separated by commas, to be added to an Athena workgroup or data catalog resource.

Instances

Instances details
ToJSON TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

Associated Types

type AWSResponse TagResource #

Generic TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

Read TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

NFData TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

Methods

rnf :: TagResource -> () #

Eq TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

Hashable TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

type AWSResponse TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.Athena.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.Athena.TagResource" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))

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 - Specifies the ARN of the Athena resource (workgroup or data catalog) to which tags are to be added.

$sel:tags:TagResource', tagResource_tags - A collection of one or more tags, separated by commas, to be added to an Athena workgroup or data catalog resource.

Request Lenses

tagResource_resourceARN :: Lens' TagResource Text Source #

Specifies the ARN of the Athena resource (workgroup or data catalog) to which tags are to be added.

tagResource_tags :: Lens' TagResource [Tag] Source #

A collection of one or more tags, separated by commas, to be added to an Athena workgroup or data catalog resource.

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse' 

Fields

Instances

Instances details
Generic TagResourceResponse Source # 
Instance details

Defined in Amazonka.Athena.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type #

Read TagResourceResponse Source # 
Instance details

Defined in Amazonka.Athena.TagResource

Show TagResourceResponse Source # 
Instance details

Defined in Amazonka.Athena.TagResource

NFData TagResourceResponse Source # 
Instance details

Defined in Amazonka.Athena.TagResource

Methods

rnf :: TagResourceResponse -> () #

Eq TagResourceResponse Source # 
Instance details

Defined in Amazonka.Athena.TagResource

type Rep TagResourceResponse Source # 
Instance details

Defined in Amazonka.Athena.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.Athena.TagResource" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" '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