{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.SageMaker.AddTags
-- 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)
--
-- Adds or overwrites one or more tags for the specified Amazon 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
-- <https://aws.amazon.com/answers/account-management/aws-tagging-strategies/ 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.
module Amazonka.SageMaker.AddTags
  ( -- * Creating a Request
    AddTags (..),
    newAddTags,

    -- * Request Lenses
    addTags_resourceArn,
    addTags_tags,

    -- * Destructuring the Response
    AddTagsResponse (..),
    newAddTagsResponse,

    -- * Response Lenses
    addTagsResponse_tags,
    addTagsResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SageMaker.Types

-- | /See:/ 'newAddTags' smart constructor.
data AddTags = AddTags'
  { -- | The Amazon Resource Name (ARN) of the resource that you want to tag.
    AddTags -> Text
resourceArn :: Prelude.Text,
    -- | 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
    -- <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tagging Amazon Web Services Resources>.
    AddTags -> [Tag]
tags :: [Tag]
  }
  deriving (AddTags -> AddTags -> Bool
(AddTags -> AddTags -> Bool)
-> (AddTags -> AddTags -> Bool) -> Eq AddTags
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AddTags -> AddTags -> Bool
$c/= :: AddTags -> AddTags -> Bool
== :: AddTags -> AddTags -> Bool
$c== :: AddTags -> AddTags -> Bool
Prelude.Eq, ReadPrec [AddTags]
ReadPrec AddTags
Int -> ReadS AddTags
ReadS [AddTags]
(Int -> ReadS AddTags)
-> ReadS [AddTags]
-> ReadPrec AddTags
-> ReadPrec [AddTags]
-> Read AddTags
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AddTags]
$creadListPrec :: ReadPrec [AddTags]
readPrec :: ReadPrec AddTags
$creadPrec :: ReadPrec AddTags
readList :: ReadS [AddTags]
$creadList :: ReadS [AddTags]
readsPrec :: Int -> ReadS AddTags
$creadsPrec :: Int -> ReadS AddTags
Prelude.Read, Int -> AddTags -> ShowS
[AddTags] -> ShowS
AddTags -> String
(Int -> AddTags -> ShowS)
-> (AddTags -> String) -> ([AddTags] -> ShowS) -> Show AddTags
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AddTags] -> ShowS
$cshowList :: [AddTags] -> ShowS
show :: AddTags -> String
$cshow :: AddTags -> String
showsPrec :: Int -> AddTags -> ShowS
$cshowsPrec :: Int -> AddTags -> ShowS
Prelude.Show, (forall x. AddTags -> Rep AddTags x)
-> (forall x. Rep AddTags x -> AddTags) -> Generic AddTags
forall x. Rep AddTags x -> AddTags
forall x. AddTags -> Rep AddTags x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AddTags x -> AddTags
$cfrom :: forall x. AddTags -> Rep AddTags x
Prelude.Generic)

-- |
-- Create a value of 'AddTags' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'resourceArn', 'addTags_resourceArn' - The Amazon Resource Name (ARN) of the resource that you want to tag.
--
-- 'tags', '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
-- <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tagging Amazon Web Services Resources>.
newAddTags ::
  -- | 'resourceArn'
  Prelude.Text ->
  AddTags
newAddTags :: Text -> AddTags
newAddTags Text
pResourceArn_ =
  AddTags' :: Text -> [Tag] -> AddTags
AddTags'
    { $sel:resourceArn:AddTags' :: Text
resourceArn = Text
pResourceArn_,
      $sel:tags:AddTags' :: [Tag]
tags = [Tag]
forall a. Monoid a => a
Prelude.mempty
    }

-- | The Amazon Resource Name (ARN) of the resource that you want to tag.
addTags_resourceArn :: Lens.Lens' AddTags Prelude.Text
addTags_resourceArn :: (Text -> f Text) -> AddTags -> f AddTags
addTags_resourceArn = (AddTags -> Text)
-> (AddTags -> Text -> AddTags) -> Lens AddTags AddTags Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AddTags' {Text
resourceArn :: Text
$sel:resourceArn:AddTags' :: AddTags -> Text
resourceArn} -> Text
resourceArn) (\s :: AddTags
s@AddTags' {} Text
a -> AddTags
s {$sel:resourceArn:AddTags' :: Text
resourceArn = Text
a} :: AddTags)

-- | 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
-- <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tagging Amazon Web Services Resources>.
addTags_tags :: Lens.Lens' AddTags [Tag]
addTags_tags :: ([Tag] -> f [Tag]) -> AddTags -> f AddTags
addTags_tags = (AddTags -> [Tag])
-> (AddTags -> [Tag] -> AddTags)
-> Lens AddTags AddTags [Tag] [Tag]
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AddTags' {[Tag]
tags :: [Tag]
$sel:tags:AddTags' :: AddTags -> [Tag]
tags} -> [Tag]
tags) (\s :: AddTags
s@AddTags' {} [Tag]
a -> AddTags
s {$sel:tags:AddTags' :: [Tag]
tags = [Tag]
a} :: AddTags) (([Tag] -> f [Tag]) -> AddTags -> f AddTags)
-> (([Tag] -> f [Tag]) -> [Tag] -> f [Tag])
-> ([Tag] -> f [Tag])
-> AddTags
-> f AddTags
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. ([Tag] -> f [Tag]) -> [Tag] -> f [Tag]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.AWSRequest AddTags where
  type AWSResponse AddTags = AddTagsResponse
  request :: AddTags -> Request AddTags
request = Service -> AddTags -> Request AddTags
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy AddTags
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse AddTags)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse AddTags))
-> Logger
-> Service
-> Proxy AddTags
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse AddTags)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [Tag] -> Int -> AddTagsResponse
AddTagsResponse'
            (Maybe [Tag] -> Int -> AddTagsResponse)
-> Either String (Maybe [Tag])
-> Either String (Int -> AddTagsResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Either String (Maybe (Maybe [Tag]))
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"Tags" Either String (Maybe (Maybe [Tag]))
-> Maybe [Tag] -> Either String (Maybe [Tag])
forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ Maybe [Tag]
forall a. Monoid a => a
Prelude.mempty)
            Either String (Int -> AddTagsResponse)
-> Either String Int -> Either String AddTagsResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable AddTags

instance Prelude.NFData AddTags

instance Core.ToHeaders AddTags where
  toHeaders :: AddTags -> ResponseHeaders
toHeaders =
    ResponseHeaders -> AddTags -> ResponseHeaders
forall a b. a -> b -> a
Prelude.const
      ( [ResponseHeaders] -> ResponseHeaders
forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# (ByteString
"SageMaker.AddTags" :: Prelude.ByteString),
            HeaderName
"Content-Type"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Core.ToJSON AddTags where
  toJSON :: AddTags -> Value
toJSON AddTags' {[Tag]
Text
tags :: [Tag]
resourceArn :: Text
$sel:tags:AddTags' :: AddTags -> [Tag]
$sel:resourceArn:AddTags' :: AddTags -> Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"ResourceArn" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
resourceArn),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Tags" Text -> [Tag] -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= [Tag]
tags)
          ]
      )

instance Core.ToPath AddTags where
  toPath :: AddTags -> ByteString
toPath = ByteString -> AddTags -> ByteString
forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Core.ToQuery AddTags where
  toQuery :: AddTags -> QueryString
toQuery = QueryString -> AddTags -> QueryString
forall a b. a -> b -> a
Prelude.const QueryString
forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newAddTagsResponse' smart constructor.
data AddTagsResponse = AddTagsResponse'
  { -- | A list of tags associated with the Amazon SageMaker resource.
    AddTagsResponse -> Maybe [Tag]
tags :: Prelude.Maybe [Tag],
    -- | The response's http status code.
    AddTagsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (AddTagsResponse -> AddTagsResponse -> Bool
(AddTagsResponse -> AddTagsResponse -> Bool)
-> (AddTagsResponse -> AddTagsResponse -> Bool)
-> Eq AddTagsResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AddTagsResponse -> AddTagsResponse -> Bool
$c/= :: AddTagsResponse -> AddTagsResponse -> Bool
== :: AddTagsResponse -> AddTagsResponse -> Bool
$c== :: AddTagsResponse -> AddTagsResponse -> Bool
Prelude.Eq, ReadPrec [AddTagsResponse]
ReadPrec AddTagsResponse
Int -> ReadS AddTagsResponse
ReadS [AddTagsResponse]
(Int -> ReadS AddTagsResponse)
-> ReadS [AddTagsResponse]
-> ReadPrec AddTagsResponse
-> ReadPrec [AddTagsResponse]
-> Read AddTagsResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AddTagsResponse]
$creadListPrec :: ReadPrec [AddTagsResponse]
readPrec :: ReadPrec AddTagsResponse
$creadPrec :: ReadPrec AddTagsResponse
readList :: ReadS [AddTagsResponse]
$creadList :: ReadS [AddTagsResponse]
readsPrec :: Int -> ReadS AddTagsResponse
$creadsPrec :: Int -> ReadS AddTagsResponse
Prelude.Read, Int -> AddTagsResponse -> ShowS
[AddTagsResponse] -> ShowS
AddTagsResponse -> String
(Int -> AddTagsResponse -> ShowS)
-> (AddTagsResponse -> String)
-> ([AddTagsResponse] -> ShowS)
-> Show AddTagsResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AddTagsResponse] -> ShowS
$cshowList :: [AddTagsResponse] -> ShowS
show :: AddTagsResponse -> String
$cshow :: AddTagsResponse -> String
showsPrec :: Int -> AddTagsResponse -> ShowS
$cshowsPrec :: Int -> AddTagsResponse -> ShowS
Prelude.Show, (forall x. AddTagsResponse -> Rep AddTagsResponse x)
-> (forall x. Rep AddTagsResponse x -> AddTagsResponse)
-> Generic AddTagsResponse
forall x. Rep AddTagsResponse x -> AddTagsResponse
forall x. AddTagsResponse -> Rep AddTagsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AddTagsResponse x -> AddTagsResponse
$cfrom :: forall x. AddTagsResponse -> Rep AddTagsResponse x
Prelude.Generic)

-- |
-- Create a value of 'AddTagsResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'tags', 'addTagsResponse_tags' - A list of tags associated with the Amazon SageMaker resource.
--
-- 'httpStatus', 'addTagsResponse_httpStatus' - The response's http status code.
newAddTagsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  AddTagsResponse
newAddTagsResponse :: Int -> AddTagsResponse
newAddTagsResponse Int
pHttpStatus_ =
  AddTagsResponse' :: Maybe [Tag] -> Int -> AddTagsResponse
AddTagsResponse'
    { $sel:tags:AddTagsResponse' :: Maybe [Tag]
tags = Maybe [Tag]
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:AddTagsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A list of tags associated with the Amazon SageMaker resource.
addTagsResponse_tags :: Lens.Lens' AddTagsResponse (Prelude.Maybe [Tag])
addTagsResponse_tags :: (Maybe [Tag] -> f (Maybe [Tag]))
-> AddTagsResponse -> f AddTagsResponse
addTagsResponse_tags = (AddTagsResponse -> Maybe [Tag])
-> (AddTagsResponse -> Maybe [Tag] -> AddTagsResponse)
-> Lens AddTagsResponse AddTagsResponse (Maybe [Tag]) (Maybe [Tag])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AddTagsResponse' {Maybe [Tag]
tags :: Maybe [Tag]
$sel:tags:AddTagsResponse' :: AddTagsResponse -> Maybe [Tag]
tags} -> Maybe [Tag]
tags) (\s :: AddTagsResponse
s@AddTagsResponse' {} Maybe [Tag]
a -> AddTagsResponse
s {$sel:tags:AddTagsResponse' :: Maybe [Tag]
tags = Maybe [Tag]
a} :: AddTagsResponse) ((Maybe [Tag] -> f (Maybe [Tag]))
 -> AddTagsResponse -> f AddTagsResponse)
-> ((Maybe [Tag] -> f (Maybe [Tag]))
    -> Maybe [Tag] -> f (Maybe [Tag]))
-> (Maybe [Tag] -> f (Maybe [Tag]))
-> AddTagsResponse
-> f AddTagsResponse
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso [Tag] [Tag] [Tag] [Tag]
-> Iso (Maybe [Tag]) (Maybe [Tag]) (Maybe [Tag]) (Maybe [Tag])
forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping AnIso [Tag] [Tag] [Tag] [Tag]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The response's http status code.
addTagsResponse_httpStatus :: Lens.Lens' AddTagsResponse Prelude.Int
addTagsResponse_httpStatus :: (Int -> f Int) -> AddTagsResponse -> f AddTagsResponse
addTagsResponse_httpStatus = (AddTagsResponse -> Int)
-> (AddTagsResponse -> Int -> AddTagsResponse)
-> Lens AddTagsResponse AddTagsResponse Int Int
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AddTagsResponse' {Int
httpStatus :: Int
$sel:httpStatus:AddTagsResponse' :: AddTagsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: AddTagsResponse
s@AddTagsResponse' {} Int
a -> AddTagsResponse
s {$sel:httpStatus:AddTagsResponse' :: Int
httpStatus = Int
a} :: AddTagsResponse)

instance Prelude.NFData AddTagsResponse