{-# 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.WorkMail.ListGroups -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Returns summaries of the organization\'s groups. -- -- This operation returns paginated results. module Amazonka.WorkMail.ListGroups ( -- * Creating a Request ListGroups (..), newListGroups, -- * Request Lenses listGroups_maxResults, listGroups_nextToken, listGroups_organizationId, -- * Destructuring the Response ListGroupsResponse (..), newListGroupsResponse, -- * Response Lenses listGroupsResponse_groups, listGroupsResponse_nextToken, listGroupsResponse_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.WorkMail.Types -- | /See:/ 'newListGroups' smart constructor. data ListGroups = ListGroups' { -- | The maximum number of results to return in a single call. maxResults :: Prelude.Maybe Prelude.Natural, -- | The token to use to retrieve the next page of results. The first call -- does not contain any tokens. nextToken :: Prelude.Maybe Prelude.Text, -- | The identifier for the organization under which the groups exist. organizationId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListGroups' 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', 'listGroups_maxResults' - The maximum number of results to return in a single call. -- -- 'nextToken', 'listGroups_nextToken' - The token to use to retrieve the next page of results. The first call -- does not contain any tokens. -- -- 'organizationId', 'listGroups_organizationId' - The identifier for the organization under which the groups exist. newListGroups :: -- | 'organizationId' Prelude.Text -> ListGroups newListGroups pOrganizationId_ = ListGroups' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, organizationId = pOrganizationId_ } -- | The maximum number of results to return in a single call. listGroups_maxResults :: Lens.Lens' ListGroups (Prelude.Maybe Prelude.Natural) listGroups_maxResults = Lens.lens (\ListGroups' {maxResults} -> maxResults) (\s@ListGroups' {} a -> s {maxResults = a} :: ListGroups) -- | The token to use to retrieve the next page of results. The first call -- does not contain any tokens. listGroups_nextToken :: Lens.Lens' ListGroups (Prelude.Maybe Prelude.Text) listGroups_nextToken = Lens.lens (\ListGroups' {nextToken} -> nextToken) (\s@ListGroups' {} a -> s {nextToken = a} :: ListGroups) -- | The identifier for the organization under which the groups exist. listGroups_organizationId :: Lens.Lens' ListGroups Prelude.Text listGroups_organizationId = Lens.lens (\ListGroups' {organizationId} -> organizationId) (\s@ListGroups' {} a -> s {organizationId = a} :: ListGroups) instance Core.AWSPager ListGroups where page rq rs | Core.stop ( rs Lens.^? listGroupsResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listGroupsResponse_groups Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listGroups_nextToken Lens..~ rs Lens.^? listGroupsResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListGroups where type AWSResponse ListGroups = ListGroupsResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListGroupsResponse' Prelude.<$> (x Data..?> "Groups" Core..!@ Prelude.mempty) Prelude.<*> (x Data..?> "NextToken") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListGroups where hashWithSalt _salt ListGroups' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` organizationId instance Prelude.NFData ListGroups where rnf ListGroups' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf organizationId instance Data.ToHeaders ListGroups where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ("WorkMailService.ListGroups" :: Prelude.ByteString), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListGroups where toJSON ListGroups' {..} = Data.object ( Prelude.catMaybes [ ("MaxResults" Data..=) Prelude.<$> maxResults, ("NextToken" Data..=) Prelude.<$> nextToken, Prelude.Just ("OrganizationId" Data..= organizationId) ] ) instance Data.ToPath ListGroups where toPath = Prelude.const "/" instance Data.ToQuery ListGroups where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newListGroupsResponse' smart constructor. data ListGroupsResponse = ListGroupsResponse' { -- | The overview of groups for an organization. groups :: Prelude.Maybe [Group], -- | The token to use to retrieve the next page of results. The value is -- \"null\" when there are no more results to return. 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 'ListGroupsResponse' 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: -- -- 'groups', 'listGroupsResponse_groups' - The overview of groups for an organization. -- -- 'nextToken', 'listGroupsResponse_nextToken' - The token to use to retrieve the next page of results. The value is -- \"null\" when there are no more results to return. -- -- 'httpStatus', 'listGroupsResponse_httpStatus' - The response's http status code. newListGroupsResponse :: -- | 'httpStatus' Prelude.Int -> ListGroupsResponse newListGroupsResponse pHttpStatus_ = ListGroupsResponse' { groups = Prelude.Nothing, nextToken = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | The overview of groups for an organization. listGroupsResponse_groups :: Lens.Lens' ListGroupsResponse (Prelude.Maybe [Group]) listGroupsResponse_groups = Lens.lens (\ListGroupsResponse' {groups} -> groups) (\s@ListGroupsResponse' {} a -> s {groups = a} :: ListGroupsResponse) Prelude.. Lens.mapping Lens.coerced -- | The token to use to retrieve the next page of results. The value is -- \"null\" when there are no more results to return. listGroupsResponse_nextToken :: Lens.Lens' ListGroupsResponse (Prelude.Maybe Prelude.Text) listGroupsResponse_nextToken = Lens.lens (\ListGroupsResponse' {nextToken} -> nextToken) (\s@ListGroupsResponse' {} a -> s {nextToken = a} :: ListGroupsResponse) -- | The response's http status code. listGroupsResponse_httpStatus :: Lens.Lens' ListGroupsResponse Prelude.Int listGroupsResponse_httpStatus = Lens.lens (\ListGroupsResponse' {httpStatus} -> httpStatus) (\s@ListGroupsResponse' {} a -> s {httpStatus = a} :: ListGroupsResponse) instance Prelude.NFData ListGroupsResponse where rnf ListGroupsResponse' {..} = Prelude.rnf groups `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf httpStatus