Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transfer.TagResource

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

Synopsis

data TagResource = TagResource' {
- arn :: Text
- tags :: NonEmpty Tag
}
newTagResource :: Text -> NonEmpty Tag -> TagResource
tagResource_arn :: Lens' TagResource Text
tagResource_tags :: Lens' TagResource (NonEmpty Tag)
data TagResourceResponse = TagResourceResponse' {
}
newTagResourceResponse :: TagResourceResponse

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource'
Fields arn :: Text An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role. tags :: NonEmpty Tag Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.

Instances

Instances details

ToJSON TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods toJSON :: TagResource -> Value # toEncoding :: TagResource -> Encoding # toJSONList :: [TagResource] -> Value # toEncodingList :: [TagResource] -> Encoding #
ToHeaders TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods toHeaders :: TagResource -> [Header] #
ToPath TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods toPath :: TagResource -> ByteString #
ToQuery TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods toQuery :: TagResource -> QueryString #
AWSRequest TagResource Source #
Instance details Defined in Amazonka.Transfer.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 Source #
Instance details Defined in Amazonka.Transfer.TagResource Associated Types type Rep TagResource :: Type -> Type # Methods from :: TagResource -> Rep TagResource x # to :: Rep TagResource x -> TagResource #
Read TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods readsPrec :: Int -> ReadS TagResource # readList :: ReadS [TagResource] # readPrec :: ReadPrec TagResource # readListPrec :: ReadPrec [TagResource] #
Show TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods showsPrec :: Int -> TagResource -> ShowS # show :: TagResource -> String # showList :: [TagResource] -> ShowS #
NFData TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods rnf :: TagResource -> () #
Eq TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods (==) :: TagResource -> TagResource -> Bool # (/=) :: TagResource -> TagResource -> Bool #
Hashable TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods hashWithSalt :: Int -> TagResource -> Int # hash :: TagResource -> Int #
type AWSResponse TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource type AWSResponse TagResource = TagResourceResponse
type Rep TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.Transfer.TagResource" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Tag))))

newTagResource Source #

Arguments

:: Text	`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:

TagResource, tagResource_arn - An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.

TagResource, tagResource_tags - Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.

Request Lenses

tagResource_arn :: Lens' TagResource Text Source #

An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.

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

Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'

Instances

Instances details

Generic TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource Associated Types type Rep TagResourceResponse :: Type -> Type # Methods from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse #
Read TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods readsPrec :: Int -> ReadS TagResourceResponse # readList :: ReadS [TagResourceResponse] # readPrec :: ReadPrec TagResourceResponse # readListPrec :: ReadPrec [TagResourceResponse] #
Show TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS #
NFData TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods rnf :: TagResourceResponse -> () #
Eq TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool #
type Rep TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.Transfer.TagResource" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newTagResourceResponse :: TagResourceResponse Source #

Create a value of TagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.