amazonka-kinesis-video-2.0: gen/Amazonka/KinesisVideo/TagResource.hs
{-# 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.KinesisVideo.TagResource
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Adds one or more tags to a signaling channel. A /tag/ is a key-value
-- pair (the value is optional) that you can define and assign to Amazon
-- Web Services resources. If you specify a tag that already exists, the
-- tag value is replaced with the value that you specify in the request.
-- For more information, see
-- <https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html Using Cost Allocation Tags>
-- in the /Billing and Cost Management and Cost Management User Guide/.
module Amazonka.KinesisVideo.TagResource
( -- * Creating a Request
TagResource (..),
newTagResource,
-- * Request Lenses
tagResource_resourceARN,
tagResource_tags,
-- * Destructuring the Response
TagResourceResponse (..),
newTagResourceResponse,
-- * Response Lenses
tagResourceResponse_httpStatus,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.KinesisVideo.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
-- | /See:/ 'newTagResource' smart constructor.
data TagResource = TagResource'
{ -- | The Amazon Resource Name (ARN) of the signaling channel to which you
-- want to add tags.
resourceARN :: Prelude.Text,
-- | A list of tags to associate with the specified signaling channel. Each
-- tag is a key-value pair.
tags :: Prelude.NonEmpty Tag
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'TagResource' 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', 'tagResource_resourceARN' - The Amazon Resource Name (ARN) of the signaling channel to which you
-- want to add tags.
--
-- 'tags', 'tagResource_tags' - A list of tags to associate with the specified signaling channel. Each
-- tag is a key-value pair.
newTagResource ::
-- | 'resourceARN'
Prelude.Text ->
-- | 'tags'
Prelude.NonEmpty Tag ->
TagResource
newTagResource pResourceARN_ pTags_ =
TagResource'
{ resourceARN = pResourceARN_,
tags = Lens.coerced Lens.# pTags_
}
-- | The Amazon Resource Name (ARN) of the signaling channel to which you
-- want to add tags.
tagResource_resourceARN :: Lens.Lens' TagResource Prelude.Text
tagResource_resourceARN = Lens.lens (\TagResource' {resourceARN} -> resourceARN) (\s@TagResource' {} a -> s {resourceARN = a} :: TagResource)
-- | A list of tags to associate with the specified signaling channel. Each
-- tag is a key-value pair.
tagResource_tags :: Lens.Lens' TagResource (Prelude.NonEmpty Tag)
tagResource_tags = Lens.lens (\TagResource' {tags} -> tags) (\s@TagResource' {} a -> s {tags = a} :: TagResource) Prelude.. Lens.coerced
instance Core.AWSRequest TagResource where
type AWSResponse TagResource = TagResourceResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveEmpty
( \s h x ->
TagResourceResponse'
Prelude.<$> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable TagResource where
hashWithSalt _salt TagResource' {..} =
_salt
`Prelude.hashWithSalt` resourceARN
`Prelude.hashWithSalt` tags
instance Prelude.NFData TagResource where
rnf TagResource' {..} =
Prelude.rnf resourceARN
`Prelude.seq` Prelude.rnf tags
instance Data.ToHeaders TagResource where
toHeaders = Prelude.const Prelude.mempty
instance Data.ToJSON TagResource where
toJSON TagResource' {..} =
Data.object
( Prelude.catMaybes
[ Prelude.Just ("ResourceARN" Data..= resourceARN),
Prelude.Just ("Tags" Data..= tags)
]
)
instance Data.ToPath TagResource where
toPath = Prelude.const "/TagResource"
instance Data.ToQuery TagResource where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newTagResourceResponse' smart constructor.
data TagResourceResponse = TagResourceResponse'
{ -- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'TagResourceResponse' 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:
--
-- 'httpStatus', 'tagResourceResponse_httpStatus' - The response's http status code.
newTagResourceResponse ::
-- | 'httpStatus'
Prelude.Int ->
TagResourceResponse
newTagResourceResponse pHttpStatus_ =
TagResourceResponse' {httpStatus = pHttpStatus_}
-- | The response's http status code.
tagResourceResponse_httpStatus :: Lens.Lens' TagResourceResponse Prelude.Int
tagResourceResponse_httpStatus = Lens.lens (\TagResourceResponse' {httpStatus} -> httpStatus) (\s@TagResourceResponse' {} a -> s {httpStatus = a} :: TagResourceResponse)
instance Prelude.NFData TagResourceResponse where
rnf TagResourceResponse' {..} = Prelude.rnf httpStatus