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.SageMaker.AddTags

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

Synopsis

data AddTags = AddTags' {
- resourceArn :: Text
- tags :: [Tag]
}
newAddTags :: Text -> AddTags
addTags_resourceArn :: Lens' AddTags Text
addTags_tags :: Lens' AddTags [Tag]
data AddTagsResponse = AddTagsResponse' {
- tags :: Maybe [Tag]
- httpStatus :: Int
}
newAddTagsResponse :: Int -> AddTagsResponse
addTagsResponse_tags :: Lens' AddTagsResponse (Maybe [Tag])
addTagsResponse_httpStatus :: Lens' AddTagsResponse Int

Creating a Request

data AddTags Source #

See: newAddTags smart constructor.

Constructors

AddTags'
Fields resourceArn :: Text The Amazon Resource Name (ARN) of the resource that you want to tag. tags :: [Tag] An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Instances

Instances details

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

newAddTags Source #

Arguments

:: Text	`$sel:resourceArn:AddTags'`
-> AddTags

Create a value of AddTags 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:AddTags', addTags_resourceArn - The Amazon Resource Name (ARN) of the resource that you want to tag.

AddTags, addTags_tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Request Lenses

addTags_resourceArn :: Lens' AddTags Text Source #

The Amazon Resource Name (ARN) of the resource that you want to tag.

addTags_tags :: Lens' AddTags [Tag] Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Destructuring the Response

data AddTagsResponse Source #

See: newAddTagsResponse smart constructor.

Constructors

AddTagsResponse'
Fields tags :: Maybe [Tag] A list of tags associated with the SageMaker resource. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic AddTagsResponse Source #
Instance details Defined in Amazonka.SageMaker.AddTags Associated Types type Rep AddTagsResponse :: Type -> Type # Methods from :: AddTagsResponse -> Rep AddTagsResponse x # to :: Rep AddTagsResponse x -> AddTagsResponse #
Read AddTagsResponse Source #
Instance details Defined in Amazonka.SageMaker.AddTags Methods readsPrec :: Int -> ReadS AddTagsResponse # readList :: ReadS [AddTagsResponse] # readPrec :: ReadPrec AddTagsResponse # readListPrec :: ReadPrec [AddTagsResponse] #
Show AddTagsResponse Source #
Instance details Defined in Amazonka.SageMaker.AddTags Methods showsPrec :: Int -> AddTagsResponse -> ShowS # show :: AddTagsResponse -> String # showList :: [AddTagsResponse] -> ShowS #
NFData AddTagsResponse Source #
Instance details Defined in Amazonka.SageMaker.AddTags Methods rnf :: AddTagsResponse -> () #
Eq AddTagsResponse Source #
Instance details Defined in Amazonka.SageMaker.AddTags Methods (==) :: AddTagsResponse -> AddTagsResponse -> Bool # (/=) :: AddTagsResponse -> AddTagsResponse -> Bool #
type Rep AddTagsResponse Source #
Instance details Defined in Amazonka.SageMaker.AddTags type Rep AddTagsResponse = D1 ('MetaData "AddTagsResponse" "Amazonka.SageMaker.AddTags" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "AddTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAddTagsResponse Source #

Arguments

:: Int	`$sel:httpStatus:AddTagsResponse'`
-> AddTagsResponse

Create a value of AddTagsResponse 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:

AddTags, addTagsResponse_tags - A list of tags associated with the SageMaker resource.

$sel:httpStatus:AddTagsResponse', addTagsResponse_httpStatus - The response's http status code.

Response Lenses

addTagsResponse_tags :: Lens' AddTagsResponse (Maybe [Tag]) Source #

A list of tags associated with the SageMaker resource.

addTagsResponse_httpStatus :: Lens' AddTagsResponse Int Source #

The response's http status code.