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.Batch.TagResource

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

Synopsis

data TagResource = TagResource' {
- resourceArn :: Text
- tags :: HashMap Text Text
}
newTagResource :: Text -> TagResource
tagResource_resourceArn :: Lens' TagResource Text
tagResource_tags :: Lens' TagResource (HashMap Text Text)
data TagResourceResponse = TagResourceResponse' {
- httpStatus :: Int
}
newTagResourceResponse :: Int -> TagResourceResponse
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource'

Fields

resourceArn :: Text
The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
tags :: HashMap Text Text
The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

Instances

Instances details

Eq TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Methods (==) :: TagResource -> TagResource -> Bool # (/=) :: TagResource -> TagResource -> Bool #
Read TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Methods readsPrec :: Int -> ReadS TagResource # readList :: ReadS [TagResource] # readPrec :: ReadPrec TagResource # readListPrec :: ReadPrec [TagResource] #
Show TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Methods showsPrec :: Int -> TagResource -> ShowS # show :: TagResource -> String # showList :: [TagResource] -> ShowS #
Generic TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Associated Types type Rep TagResource :: Type -> Type # Methods from :: TagResource -> Rep TagResource x # to :: Rep TagResource x -> TagResource #
NFData TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Methods rnf :: TagResource -> () #
Hashable TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Methods hashWithSalt :: Int -> TagResource -> Int # hash :: TagResource -> Int #
ToJSON TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Methods toJSON :: TagResource -> Value # toEncoding :: TagResource -> Encoding # toJSONList :: [TagResource] -> Value # toEncodingList :: [TagResource] -> Encoding #
AWSRequest TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Associated Types type AWSResponse TagResource # Methods request :: TagResource -> Request TagResource # response :: MonadResource m => Logger -> Service -> Proxy TagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TagResource))) #
ToHeaders TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Methods toHeaders :: TagResource -> [Header] #
ToPath TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Methods toPath :: TagResource -> ByteString #
ToQuery TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource Methods toQuery :: TagResource -> QueryString #
type Rep TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.Batch.TagResource" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))
type AWSResponse TagResource Source #
Instance details Defined in Amazonka.Batch.TagResource type AWSResponse TagResource = TagResourceResponse

newTagResource Source #

Arguments

:: Text	`$sel:resourceArn: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 tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

$sel:tags:TagResource', tagResource_tags - The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

Request Lenses

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq TagResourceResponse Source #
Instance details Defined in Amazonka.Batch.TagResource Methods (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool #
Read TagResourceResponse Source #
Instance details Defined in Amazonka.Batch.TagResource Methods readsPrec :: Int -> ReadS TagResourceResponse # readList :: ReadS [TagResourceResponse] # readPrec :: ReadPrec TagResourceResponse # readListPrec :: ReadPrec [TagResourceResponse] #
Show TagResourceResponse Source #
Instance details Defined in Amazonka.Batch.TagResource Methods showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS #
Generic TagResourceResponse Source #
Instance details Defined in Amazonka.Batch.TagResource Associated Types type Rep TagResourceResponse :: Type -> Type # Methods from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse #
NFData TagResourceResponse Source #
Instance details Defined in Amazonka.Batch.TagResource Methods rnf :: TagResourceResponse -> () #
type Rep TagResourceResponse Source #
Instance details Defined in Amazonka.Batch.TagResource type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.Batch.TagResource" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTagResourceResponse Source #

Arguments

:: Int	`$sel:httpStatus: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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.

Response Lenses

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.