{-# 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.Connect.ListRoutingProfiles -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Provides summary information about the routing profiles for the -- specified Amazon Connect instance. -- -- For more information about routing profiles, see -- -- and -- -- in the /Amazon Connect Administrator Guide/. -- -- This operation returns paginated results. module Amazonka.Connect.ListRoutingProfiles ( -- * Creating a Request ListRoutingProfiles (..), newListRoutingProfiles, -- * Request Lenses listRoutingProfiles_maxResults, listRoutingProfiles_nextToken, listRoutingProfiles_instanceId, -- * Destructuring the Response ListRoutingProfilesResponse (..), newListRoutingProfilesResponse, -- * Response Lenses listRoutingProfilesResponse_nextToken, listRoutingProfilesResponse_routingProfileSummaryList, listRoutingProfilesResponse_httpStatus, ) where import Amazonka.Connect.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:/ 'newListRoutingProfiles' smart constructor. data ListRoutingProfiles = ListRoutingProfiles' { -- | The maximum number of results to return per page. The default MaxResult -- size is 100. maxResults :: Prelude.Maybe Prelude.Natural, -- | The token for the next set of results. Use the value returned in the -- previous response in the next request to retrieve the next set of -- results. nextToken :: Prelude.Maybe Prelude.Text, -- | The identifier of the Amazon Connect instance. You can find the -- instanceId in the ARN of the instance. instanceId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListRoutingProfiles' 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', 'listRoutingProfiles_maxResults' - The maximum number of results to return per page. The default MaxResult -- size is 100. -- -- 'nextToken', 'listRoutingProfiles_nextToken' - The token for the next set of results. Use the value returned in the -- previous response in the next request to retrieve the next set of -- results. -- -- 'instanceId', 'listRoutingProfiles_instanceId' - The identifier of the Amazon Connect instance. You can find the -- instanceId in the ARN of the instance. newListRoutingProfiles :: -- | 'instanceId' Prelude.Text -> ListRoutingProfiles newListRoutingProfiles pInstanceId_ = ListRoutingProfiles' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, instanceId = pInstanceId_ } -- | The maximum number of results to return per page. The default MaxResult -- size is 100. listRoutingProfiles_maxResults :: Lens.Lens' ListRoutingProfiles (Prelude.Maybe Prelude.Natural) listRoutingProfiles_maxResults = Lens.lens (\ListRoutingProfiles' {maxResults} -> maxResults) (\s@ListRoutingProfiles' {} a -> s {maxResults = a} :: ListRoutingProfiles) -- | The token for the next set of results. Use the value returned in the -- previous response in the next request to retrieve the next set of -- results. listRoutingProfiles_nextToken :: Lens.Lens' ListRoutingProfiles (Prelude.Maybe Prelude.Text) listRoutingProfiles_nextToken = Lens.lens (\ListRoutingProfiles' {nextToken} -> nextToken) (\s@ListRoutingProfiles' {} a -> s {nextToken = a} :: ListRoutingProfiles) -- | The identifier of the Amazon Connect instance. You can find the -- instanceId in the ARN of the instance. listRoutingProfiles_instanceId :: Lens.Lens' ListRoutingProfiles Prelude.Text listRoutingProfiles_instanceId = Lens.lens (\ListRoutingProfiles' {instanceId} -> instanceId) (\s@ListRoutingProfiles' {} a -> s {instanceId = a} :: ListRoutingProfiles) instance Core.AWSPager ListRoutingProfiles where page rq rs | Core.stop ( rs Lens.^? listRoutingProfilesResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listRoutingProfilesResponse_routingProfileSummaryList Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listRoutingProfiles_nextToken Lens..~ rs Lens.^? listRoutingProfilesResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListRoutingProfiles where type AWSResponse ListRoutingProfiles = ListRoutingProfilesResponse request overrides = Request.get (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListRoutingProfilesResponse' Prelude.<$> (x Data..?> "NextToken") Prelude.<*> ( x Data..?> "RoutingProfileSummaryList" Core..!@ Prelude.mempty ) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListRoutingProfiles where hashWithSalt _salt ListRoutingProfiles' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` instanceId instance Prelude.NFData ListRoutingProfiles where rnf ListRoutingProfiles' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf instanceId instance Data.ToHeaders ListRoutingProfiles where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToPath ListRoutingProfiles where toPath ListRoutingProfiles' {..} = Prelude.mconcat ["/routing-profiles-summary/", Data.toBS instanceId] instance Data.ToQuery ListRoutingProfiles where toQuery ListRoutingProfiles' {..} = Prelude.mconcat [ "maxResults" Data.=: maxResults, "nextToken" Data.=: nextToken ] -- | /See:/ 'newListRoutingProfilesResponse' smart constructor. data ListRoutingProfilesResponse = ListRoutingProfilesResponse' { -- | If there are additional results, this is the token for the next set of -- results. nextToken :: Prelude.Maybe Prelude.Text, -- | Information about the routing profiles. routingProfileSummaryList :: Prelude.Maybe [RoutingProfileSummary], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListRoutingProfilesResponse' 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', 'listRoutingProfilesResponse_nextToken' - If there are additional results, this is the token for the next set of -- results. -- -- 'routingProfileSummaryList', 'listRoutingProfilesResponse_routingProfileSummaryList' - Information about the routing profiles. -- -- 'httpStatus', 'listRoutingProfilesResponse_httpStatus' - The response's http status code. newListRoutingProfilesResponse :: -- | 'httpStatus' Prelude.Int -> ListRoutingProfilesResponse newListRoutingProfilesResponse pHttpStatus_ = ListRoutingProfilesResponse' { nextToken = Prelude.Nothing, routingProfileSummaryList = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | If there are additional results, this is the token for the next set of -- results. listRoutingProfilesResponse_nextToken :: Lens.Lens' ListRoutingProfilesResponse (Prelude.Maybe Prelude.Text) listRoutingProfilesResponse_nextToken = Lens.lens (\ListRoutingProfilesResponse' {nextToken} -> nextToken) (\s@ListRoutingProfilesResponse' {} a -> s {nextToken = a} :: ListRoutingProfilesResponse) -- | Information about the routing profiles. listRoutingProfilesResponse_routingProfileSummaryList :: Lens.Lens' ListRoutingProfilesResponse (Prelude.Maybe [RoutingProfileSummary]) listRoutingProfilesResponse_routingProfileSummaryList = Lens.lens (\ListRoutingProfilesResponse' {routingProfileSummaryList} -> routingProfileSummaryList) (\s@ListRoutingProfilesResponse' {} a -> s {routingProfileSummaryList = a} :: ListRoutingProfilesResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. listRoutingProfilesResponse_httpStatus :: Lens.Lens' ListRoutingProfilesResponse Prelude.Int listRoutingProfilesResponse_httpStatus = Lens.lens (\ListRoutingProfilesResponse' {httpStatus} -> httpStatus) (\s@ListRoutingProfilesResponse' {} a -> s {httpStatus = a} :: ListRoutingProfilesResponse) instance Prelude.NFData ListRoutingProfilesResponse where rnf ListRoutingProfilesResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf routingProfileSummaryList `Prelude.seq` Prelude.rnf httpStatus