Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Comprehend.Types.Tag

Description

Synopsis

data Tag = Tag' {
- value :: Maybe Text
- key :: Text
}
newTag :: Text -> Tag
tag_value :: Lens' Tag (Maybe Text)
tag_key :: Lens' Tag Text

Documentation

data Tag Source #

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

See: newTag smart constructor.

Constructors

Tag'

Fields

value :: Maybe Text
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
key :: Text
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

Instances

Instances details

Eq Tag Source #
Instance details Defined in Amazonka.Comprehend.Types.Tag Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Read Tag Source #
Instance details Defined in Amazonka.Comprehend.Types.Tag Methods readsPrec :: Int -> ReadS Tag # readList :: ReadS [Tag] # readPrec :: ReadPrec Tag # readListPrec :: ReadPrec [Tag] #
Show Tag Source #
Instance details Defined in Amazonka.Comprehend.Types.Tag Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
Generic Tag Source #
Instance details Defined in Amazonka.Comprehend.Types.Tag Associated Types type Rep Tag :: Type -> Type # Methods from :: Tag -> Rep Tag x # to :: Rep Tag x -> Tag #
NFData Tag Source #
Instance details Defined in Amazonka.Comprehend.Types.Tag Methods rnf :: Tag -> () #
Hashable Tag Source #
Instance details Defined in Amazonka.Comprehend.Types.Tag Methods hashWithSalt :: Int -> Tag -> Int # hash :: Tag -> Int #
ToJSON Tag Source #
Instance details Defined in Amazonka.Comprehend.Types.Tag Methods toJSON :: Tag -> Value # toEncoding :: Tag -> Encoding # toJSONList :: [Tag] -> Value # toEncodingList :: [Tag] -> Encoding #
FromJSON Tag Source #
Instance details Defined in Amazonka.Comprehend.Types.Tag Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] #
type Rep Tag Source #
Instance details Defined in Amazonka.Comprehend.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Comprehend.Types.Tag" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag Source #

Arguments

:: Text	`$sel:key:Tag'`
-> Tag

Create a value of Tag 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:value:Tag', tag_value - The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

$sel:key:Tag', tag_key - The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

tag_value :: Lens' Tag (Maybe Text) Source #

The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

tag_key :: Lens' Tag Text Source #

The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”