{-# 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.VoiceId.ListDomains -- 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 all the domains in the Amazon Web Services account. -- -- This operation returns paginated results. module Amazonka.VoiceId.ListDomains ( -- * Creating a Request ListDomains (..), newListDomains, -- * Request Lenses listDomains_maxResults, listDomains_nextToken, -- * Destructuring the Response ListDomainsResponse (..), newListDomainsResponse, -- * Response Lenses listDomainsResponse_domainSummaries, listDomainsResponse_nextToken, listDomainsResponse_httpStatus, ) where 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 import Amazonka.VoiceId.Types -- | /See:/ 'newListDomains' smart constructor. data ListDomains = ListDomains' { -- | The maximum number of domains to list per API call. maxResults :: Prelude.Maybe Prelude.Natural, -- | If @NextToken@ is returned, there are more results available. The value -- of @NextToken@ is a unique pagination token for each page. Make the call -- again using the returned token to retrieve the next page. Keep all other -- arguments unchanged. Each pagination token expires after 24 hours. nextToken :: Prelude.Maybe Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListDomains' 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', 'listDomains_maxResults' - The maximum number of domains to list per API call. -- -- 'nextToken', 'listDomains_nextToken' - If @NextToken@ is returned, there are more results available. The value -- of @NextToken@ is a unique pagination token for each page. Make the call -- again using the returned token to retrieve the next page. Keep all other -- arguments unchanged. Each pagination token expires after 24 hours. newListDomains :: ListDomains newListDomains = ListDomains' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing } -- | The maximum number of domains to list per API call. listDomains_maxResults :: Lens.Lens' ListDomains (Prelude.Maybe Prelude.Natural) listDomains_maxResults = Lens.lens (\ListDomains' {maxResults} -> maxResults) (\s@ListDomains' {} a -> s {maxResults = a} :: ListDomains) -- | If @NextToken@ is returned, there are more results available. The value -- of @NextToken@ is a unique pagination token for each page. Make the call -- again using the returned token to retrieve the next page. Keep all other -- arguments unchanged. Each pagination token expires after 24 hours. listDomains_nextToken :: Lens.Lens' ListDomains (Prelude.Maybe Prelude.Text) listDomains_nextToken = Lens.lens (\ListDomains' {nextToken} -> nextToken) (\s@ListDomains' {} a -> s {nextToken = a} :: ListDomains) instance Core.AWSPager ListDomains where page rq rs | Core.stop ( rs Lens.^? listDomainsResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listDomainsResponse_domainSummaries Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listDomains_nextToken Lens..~ rs Lens.^? listDomainsResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListDomains where type AWSResponse ListDomains = ListDomainsResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListDomainsResponse' Prelude.<$> ( x Data..?> "DomainSummaries" Core..!@ Prelude.mempty ) Prelude.<*> (x Data..?> "NextToken") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListDomains where hashWithSalt _salt ListDomains' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken instance Prelude.NFData ListDomains where rnf ListDomains' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken instance Data.ToHeaders ListDomains where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ("VoiceID.ListDomains" :: Prelude.ByteString), "Content-Type" Data.=# ( "application/x-amz-json-1.0" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListDomains where toJSON ListDomains' {..} = Data.object ( Prelude.catMaybes [ ("MaxResults" Data..=) Prelude.<$> maxResults, ("NextToken" Data..=) Prelude.<$> nextToken ] ) instance Data.ToPath ListDomains where toPath = Prelude.const "/" instance Data.ToQuery ListDomains where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newListDomainsResponse' smart constructor. data ListDomainsResponse = ListDomainsResponse' { -- | A list containing details about each domain in the Amazon Web Services -- account. domainSummaries :: Prelude.Maybe [DomainSummary], -- | If @NextToken@ is returned, there are more results available. The value -- of @NextToken@ is a unique pagination token for each page. Make the call -- again using the returned token to retrieve the next page. Keep all other -- arguments unchanged. Each pagination token expires after 24 hours. nextToken :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListDomainsResponse' 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: -- -- 'domainSummaries', 'listDomainsResponse_domainSummaries' - A list containing details about each domain in the Amazon Web Services -- account. -- -- 'nextToken', 'listDomainsResponse_nextToken' - If @NextToken@ is returned, there are more results available. The value -- of @NextToken@ is a unique pagination token for each page. Make the call -- again using the returned token to retrieve the next page. Keep all other -- arguments unchanged. Each pagination token expires after 24 hours. -- -- 'httpStatus', 'listDomainsResponse_httpStatus' - The response's http status code. newListDomainsResponse :: -- | 'httpStatus' Prelude.Int -> ListDomainsResponse newListDomainsResponse pHttpStatus_ = ListDomainsResponse' { domainSummaries = Prelude.Nothing, nextToken = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | A list containing details about each domain in the Amazon Web Services -- account. listDomainsResponse_domainSummaries :: Lens.Lens' ListDomainsResponse (Prelude.Maybe [DomainSummary]) listDomainsResponse_domainSummaries = Lens.lens (\ListDomainsResponse' {domainSummaries} -> domainSummaries) (\s@ListDomainsResponse' {} a -> s {domainSummaries = a} :: ListDomainsResponse) Prelude.. Lens.mapping Lens.coerced -- | If @NextToken@ is returned, there are more results available. The value -- of @NextToken@ is a unique pagination token for each page. Make the call -- again using the returned token to retrieve the next page. Keep all other -- arguments unchanged. Each pagination token expires after 24 hours. listDomainsResponse_nextToken :: Lens.Lens' ListDomainsResponse (Prelude.Maybe Prelude.Text) listDomainsResponse_nextToken = Lens.lens (\ListDomainsResponse' {nextToken} -> nextToken) (\s@ListDomainsResponse' {} a -> s {nextToken = a} :: ListDomainsResponse) -- | The response's http status code. listDomainsResponse_httpStatus :: Lens.Lens' ListDomainsResponse Prelude.Int listDomainsResponse_httpStatus = Lens.lens (\ListDomainsResponse' {httpStatus} -> httpStatus) (\s@ListDomainsResponse' {} a -> s {httpStatus = a} :: ListDomainsResponse) instance Prelude.NFData ListDomainsResponse where rnf ListDomainsResponse' {..} = Prelude.rnf domainSummaries `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf httpStatus