{-# 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.CertificateManagerPCA.ListCertificateAuthorities -- 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 private certificate authorities that you created by using the -- -- action. -- -- This operation returns paginated results. module Amazonka.CertificateManagerPCA.ListCertificateAuthorities ( -- * Creating a Request ListCertificateAuthorities (..), newListCertificateAuthorities, -- * Request Lenses listCertificateAuthorities_maxResults, listCertificateAuthorities_nextToken, listCertificateAuthorities_resourceOwner, -- * Destructuring the Response ListCertificateAuthoritiesResponse (..), newListCertificateAuthoritiesResponse, -- * Response Lenses listCertificateAuthoritiesResponse_certificateAuthorities, listCertificateAuthoritiesResponse_nextToken, listCertificateAuthoritiesResponse_httpStatus, ) where import Amazonka.CertificateManagerPCA.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 -- | /See:/ 'newListCertificateAuthorities' smart constructor. data ListCertificateAuthorities = ListCertificateAuthorities' { -- | Use this parameter when paginating results to specify the maximum number -- of items to return in the response on each page. If additional items -- exist beyond the number you specify, the @NextToken@ element is sent in -- the response. Use this @NextToken@ value in a subsequent request to -- retrieve additional items. maxResults :: Prelude.Maybe Prelude.Natural, -- | Use this parameter when paginating results in a subsequent request after -- you receive a response with truncated results. Set it to the value of -- the @NextToken@ parameter from the response you just received. nextToken :: Prelude.Maybe Prelude.Text, -- | Use this parameter to filter the returned set of certificate authorities -- based on their owner. The default is SELF. resourceOwner :: Prelude.Maybe ResourceOwner } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListCertificateAuthorities' 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: -- -- 'maxResults', 'listCertificateAuthorities_maxResults' - Use this parameter when paginating results to specify the maximum number -- of items to return in the response on each page. If additional items -- exist beyond the number you specify, the @NextToken@ element is sent in -- the response. Use this @NextToken@ value in a subsequent request to -- retrieve additional items. -- -- 'nextToken', 'listCertificateAuthorities_nextToken' - Use this parameter when paginating results in a subsequent request after -- you receive a response with truncated results. Set it to the value of -- the @NextToken@ parameter from the response you just received. -- -- 'resourceOwner', 'listCertificateAuthorities_resourceOwner' - Use this parameter to filter the returned set of certificate authorities -- based on their owner. The default is SELF. newListCertificateAuthorities :: ListCertificateAuthorities newListCertificateAuthorities = ListCertificateAuthorities' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, resourceOwner = Prelude.Nothing } -- | Use this parameter when paginating results to specify the maximum number -- of items to return in the response on each page. If additional items -- exist beyond the number you specify, the @NextToken@ element is sent in -- the response. Use this @NextToken@ value in a subsequent request to -- retrieve additional items. listCertificateAuthorities_maxResults :: Lens.Lens' ListCertificateAuthorities (Prelude.Maybe Prelude.Natural) listCertificateAuthorities_maxResults = Lens.lens (\ListCertificateAuthorities' {maxResults} -> maxResults) (\s@ListCertificateAuthorities' {} a -> s {maxResults = a} :: ListCertificateAuthorities) -- | Use this parameter when paginating results in a subsequent request after -- you receive a response with truncated results. Set it to the value of -- the @NextToken@ parameter from the response you just received. listCertificateAuthorities_nextToken :: Lens.Lens' ListCertificateAuthorities (Prelude.Maybe Prelude.Text) listCertificateAuthorities_nextToken = Lens.lens (\ListCertificateAuthorities' {nextToken} -> nextToken) (\s@ListCertificateAuthorities' {} a -> s {nextToken = a} :: ListCertificateAuthorities) -- | Use this parameter to filter the returned set of certificate authorities -- based on their owner. The default is SELF. listCertificateAuthorities_resourceOwner :: Lens.Lens' ListCertificateAuthorities (Prelude.Maybe ResourceOwner) listCertificateAuthorities_resourceOwner = Lens.lens (\ListCertificateAuthorities' {resourceOwner} -> resourceOwner) (\s@ListCertificateAuthorities' {} a -> s {resourceOwner = a} :: ListCertificateAuthorities) instance Core.AWSPager ListCertificateAuthorities where page rq rs | Core.stop ( rs Lens.^? listCertificateAuthoritiesResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listCertificateAuthoritiesResponse_certificateAuthorities Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listCertificateAuthorities_nextToken Lens..~ rs Lens.^? listCertificateAuthoritiesResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListCertificateAuthorities where type AWSResponse ListCertificateAuthorities = ListCertificateAuthoritiesResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListCertificateAuthoritiesResponse' Prelude.<$> ( x Data..?> "CertificateAuthorities" Core..!@ Prelude.mempty ) Prelude.<*> (x Data..?> "NextToken") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListCertificateAuthorities where hashWithSalt _salt ListCertificateAuthorities' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` resourceOwner instance Prelude.NFData ListCertificateAuthorities where rnf ListCertificateAuthorities' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf resourceOwner instance Data.ToHeaders ListCertificateAuthorities where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "ACMPrivateCA.ListCertificateAuthorities" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListCertificateAuthorities where toJSON ListCertificateAuthorities' {..} = Data.object ( Prelude.catMaybes [ ("MaxResults" Data..=) Prelude.<$> maxResults, ("NextToken" Data..=) Prelude.<$> nextToken, ("ResourceOwner" Data..=) Prelude.<$> resourceOwner ] ) instance Data.ToPath ListCertificateAuthorities where toPath = Prelude.const "/" instance Data.ToQuery ListCertificateAuthorities where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newListCertificateAuthoritiesResponse' smart constructor. data ListCertificateAuthoritiesResponse = ListCertificateAuthoritiesResponse' { -- | Summary information about each certificate authority you have created. certificateAuthorities :: Prelude.Maybe [CertificateAuthority], -- | When the list is truncated, this value is present and should be used for -- the @NextToken@ parameter in a subsequent pagination request. nextToken :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListCertificateAuthoritiesResponse' 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: -- -- 'certificateAuthorities', 'listCertificateAuthoritiesResponse_certificateAuthorities' - Summary information about each certificate authority you have created. -- -- 'nextToken', 'listCertificateAuthoritiesResponse_nextToken' - When the list is truncated, this value is present and should be used for -- the @NextToken@ parameter in a subsequent pagination request. -- -- 'httpStatus', 'listCertificateAuthoritiesResponse_httpStatus' - The response's http status code. newListCertificateAuthoritiesResponse :: -- | 'httpStatus' Prelude.Int -> ListCertificateAuthoritiesResponse newListCertificateAuthoritiesResponse pHttpStatus_ = ListCertificateAuthoritiesResponse' { certificateAuthorities = Prelude.Nothing, nextToken = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | Summary information about each certificate authority you have created. listCertificateAuthoritiesResponse_certificateAuthorities :: Lens.Lens' ListCertificateAuthoritiesResponse (Prelude.Maybe [CertificateAuthority]) listCertificateAuthoritiesResponse_certificateAuthorities = Lens.lens (\ListCertificateAuthoritiesResponse' {certificateAuthorities} -> certificateAuthorities) (\s@ListCertificateAuthoritiesResponse' {} a -> s {certificateAuthorities = a} :: ListCertificateAuthoritiesResponse) Prelude.. Lens.mapping Lens.coerced -- | When the list is truncated, this value is present and should be used for -- the @NextToken@ parameter in a subsequent pagination request. listCertificateAuthoritiesResponse_nextToken :: Lens.Lens' ListCertificateAuthoritiesResponse (Prelude.Maybe Prelude.Text) listCertificateAuthoritiesResponse_nextToken = Lens.lens (\ListCertificateAuthoritiesResponse' {nextToken} -> nextToken) (\s@ListCertificateAuthoritiesResponse' {} a -> s {nextToken = a} :: ListCertificateAuthoritiesResponse) -- | The response's http status code. listCertificateAuthoritiesResponse_httpStatus :: Lens.Lens' ListCertificateAuthoritiesResponse Prelude.Int listCertificateAuthoritiesResponse_httpStatus = Lens.lens (\ListCertificateAuthoritiesResponse' {httpStatus} -> httpStatus) (\s@ListCertificateAuthoritiesResponse' {} a -> s {httpStatus = a} :: ListCertificateAuthoritiesResponse) instance Prelude.NFData ListCertificateAuthoritiesResponse where rnf ListCertificateAuthoritiesResponse' {..} = Prelude.rnf certificateAuthorities `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf httpStatus