{-# 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.CloudTrail.ListTags -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Lists the tags for the trail or event data store in the current region. -- -- This operation returns paginated results. module Amazonka.CloudTrail.ListTags ( -- * Creating a Request ListTags (..), newListTags, -- * Request Lenses listTags_nextToken, listTags_resourceIdList, -- * Destructuring the Response ListTagsResponse (..), newListTagsResponse, -- * Response Lenses listTagsResponse_nextToken, listTagsResponse_resourceTagList, listTagsResponse_httpStatus, ) where import Amazonka.CloudTrail.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | Specifies a list of tags to return. -- -- /See:/ 'newListTags' smart constructor. data ListTags = ListTags' { -- | Reserved for future use. nextToken :: Prelude.Maybe Prelude.Text, -- | Specifies a list of trail and event data store ARNs whose tags will be -- listed. The list has a limit of 20 ARNs. resourceIdList :: [Prelude.Text] } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListTags' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'nextToken', 'listTags_nextToken' - Reserved for future use. -- -- 'resourceIdList', 'listTags_resourceIdList' - Specifies a list of trail and event data store ARNs whose tags will be -- listed. The list has a limit of 20 ARNs. newListTags :: ListTags newListTags = ListTags' { nextToken = Prelude.Nothing, resourceIdList = Prelude.mempty } -- | Reserved for future use. listTags_nextToken :: Lens.Lens' ListTags (Prelude.Maybe Prelude.Text) listTags_nextToken = Lens.lens (\ListTags' {nextToken} -> nextToken) (\s@ListTags' {} a -> s {nextToken = a} :: ListTags) -- | Specifies a list of trail and event data store ARNs whose tags will be -- listed. The list has a limit of 20 ARNs. listTags_resourceIdList :: Lens.Lens' ListTags [Prelude.Text] listTags_resourceIdList = Lens.lens (\ListTags' {resourceIdList} -> resourceIdList) (\s@ListTags' {} a -> s {resourceIdList = a} :: ListTags) Prelude.. Lens.coerced instance Core.AWSPager ListTags where page rq rs | Core.stop ( rs Lens.^? listTagsResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listTagsResponse_resourceTagList Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listTags_nextToken Lens..~ rs Lens.^? listTagsResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListTags where type AWSResponse ListTags = ListTagsResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListTagsResponse' Prelude.<$> (x Data..?> "NextToken") Prelude.<*> ( x Data..?> "ResourceTagList" Core..!@ Prelude.mempty ) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListTags where hashWithSalt _salt ListTags' {..} = _salt `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` resourceIdList instance Prelude.NFData ListTags where rnf ListTags' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf resourceIdList instance Data.ToHeaders ListTags where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101.ListTags" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListTags where toJSON ListTags' {..} = Data.object ( Prelude.catMaybes [ ("NextToken" Data..=) Prelude.<$> nextToken, Prelude.Just ("ResourceIdList" Data..= resourceIdList) ] ) instance Data.ToPath ListTags where toPath = Prelude.const "/" instance Data.ToQuery ListTags where toQuery = Prelude.const Prelude.mempty -- | Returns the objects or data listed below if successful. Otherwise, -- returns an error. -- -- /See:/ 'newListTagsResponse' smart constructor. data ListTagsResponse = ListTagsResponse' { -- | Reserved for future use. nextToken :: Prelude.Maybe Prelude.Text, -- | A list of resource tags. resourceTagList :: Prelude.Maybe [ResourceTag], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListTagsResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'nextToken', 'listTagsResponse_nextToken' - Reserved for future use. -- -- 'resourceTagList', 'listTagsResponse_resourceTagList' - A list of resource tags. -- -- 'httpStatus', 'listTagsResponse_httpStatus' - The response's http status code. newListTagsResponse :: -- | 'httpStatus' Prelude.Int -> ListTagsResponse newListTagsResponse pHttpStatus_ = ListTagsResponse' { nextToken = Prelude.Nothing, resourceTagList = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | Reserved for future use. listTagsResponse_nextToken :: Lens.Lens' ListTagsResponse (Prelude.Maybe Prelude.Text) listTagsResponse_nextToken = Lens.lens (\ListTagsResponse' {nextToken} -> nextToken) (\s@ListTagsResponse' {} a -> s {nextToken = a} :: ListTagsResponse) -- | A list of resource tags. listTagsResponse_resourceTagList :: Lens.Lens' ListTagsResponse (Prelude.Maybe [ResourceTag]) listTagsResponse_resourceTagList = Lens.lens (\ListTagsResponse' {resourceTagList} -> resourceTagList) (\s@ListTagsResponse' {} a -> s {resourceTagList = a} :: ListTagsResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. listTagsResponse_httpStatus :: Lens.Lens' ListTagsResponse Prelude.Int listTagsResponse_httpStatus = Lens.lens (\ListTagsResponse' {httpStatus} -> httpStatus) (\s@ListTagsResponse' {} a -> s {httpStatus = a} :: ListTagsResponse) instance Prelude.NFData ListTagsResponse where rnf ListTagsResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf resourceTagList `Prelude.seq` Prelude.rnf httpStatus