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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Adds one or more tags to the specified resource.

Currently, you can attach tags to the following resources in Organizations.

Amazon Web Services account
Organization root
Organizational unit (OU)
Policy (any type)

This operation can be called only from the organization's management account.

Synopsis

data TagResource = TagResource' {
- resourceId :: Text
- tags :: [Tag]
}
newTagResource :: Text -> TagResource
tagResource_resourceId :: Lens' TagResource Text
tagResource_tags :: Lens' TagResource [Tag]
data TagResourceResponse = TagResourceResponse' {
}
newTagResourceResponse :: TagResourceResponse

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource'

Fields

resourceId :: Text
The ID of the resource to add a tag to.
You can specify any of the following taggable resources.
- Amazon Web Services account – specify the account ID number.
- Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz
- Root – specify the root ID that begins with r- and looks similar to: r-1a2b
- Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3
tags :: [Tag]
A list of tags to add to the specified resource.
For each tag in the list, you must specify both a tag key and a value. The value can be an empty string, but you can't set it to null.
If any one of the tags is invalid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails.

Instances

Instances details

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

newTagResource Source #

Arguments

:: Text	`$sel:resourceId: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:resourceId:TagResource', tagResource_resourceId - The ID of the resource to add a tag to.

You can specify any of the following taggable resources.

Amazon Web Services account – specify the account ID number.
Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz
Root – specify the root ID that begins with r- and looks similar to: r-1a2b
Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

$sel:tags:TagResource', tagResource_tags - A list of tags to add to the specified resource.

For each tag in the list, you must specify both a tag key and a value. The value can be an empty string, but you can't set it to null.

If any one of the tags is invalid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails.

Request Lenses

tagResource_resourceId :: Lens' TagResource Text Source #

The ID of the resource to add a tag to.

You can specify any of the following taggable resources.

Amazon Web Services account – specify the account ID number.
Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz
Root – specify the root ID that begins with r- and looks similar to: r-1a2b
Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

tagResource_tags :: Lens' TagResource [Tag] Source #

A list of tags to add to the specified resource.

For each tag in the list, you must specify both a tag key and a value. The value can be an empty string, but you can't set it to null.

If any one of the tags is invalid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails.

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'

Instances

Instances details

Generic TagResourceResponse Source #
Instance details Defined in Amazonka.Organizations.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.Organizations.TagResource Methods readsPrec :: Int -> ReadS TagResourceResponse # readList :: ReadS [TagResourceResponse] # readPrec :: ReadPrec TagResourceResponse # readListPrec :: ReadPrec [TagResourceResponse] #
Show TagResourceResponse Source #
Instance details Defined in Amazonka.Organizations.TagResource Methods showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS #
NFData TagResourceResponse Source #
Instance details Defined in Amazonka.Organizations.TagResource Methods rnf :: TagResourceResponse -> () #
Eq TagResourceResponse Source #
Instance details Defined in Amazonka.Organizations.TagResource Methods (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool #
type Rep TagResourceResponse Source #
Instance details Defined in Amazonka.Organizations.TagResource type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.Organizations.TagResource" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" '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.