{-# 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.CognitoIdentityProvider.ListUsersInGroup -- 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 users in the specified group. -- -- Calling this action requires developer credentials. -- -- This operation returns paginated results. module Amazonka.CognitoIdentityProvider.ListUsersInGroup ( -- * Creating a Request ListUsersInGroup (..), newListUsersInGroup, -- * Request Lenses listUsersInGroup_limit, listUsersInGroup_nextToken, listUsersInGroup_userPoolId, listUsersInGroup_groupName, -- * Destructuring the Response ListUsersInGroupResponse (..), newListUsersInGroupResponse, -- * Response Lenses listUsersInGroupResponse_nextToken, listUsersInGroupResponse_users, listUsersInGroupResponse_httpStatus, ) where import Amazonka.CognitoIdentityProvider.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:/ 'newListUsersInGroup' smart constructor. data ListUsersInGroup = ListUsersInGroup' { -- | The limit of the request to list users. limit :: Prelude.Maybe Prelude.Natural, -- | An identifier that was returned from the previous call to this -- operation, which can be used to return the next set of items in the -- list. nextToken :: Prelude.Maybe Prelude.Text, -- | The user pool ID for the user pool. userPoolId :: Prelude.Text, -- | The name of the group. groupName :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListUsersInGroup' 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: -- -- 'limit', 'listUsersInGroup_limit' - The limit of the request to list users. -- -- 'nextToken', 'listUsersInGroup_nextToken' - An identifier that was returned from the previous call to this -- operation, which can be used to return the next set of items in the -- list. -- -- 'userPoolId', 'listUsersInGroup_userPoolId' - The user pool ID for the user pool. -- -- 'groupName', 'listUsersInGroup_groupName' - The name of the group. newListUsersInGroup :: -- | 'userPoolId' Prelude.Text -> -- | 'groupName' Prelude.Text -> ListUsersInGroup newListUsersInGroup pUserPoolId_ pGroupName_ = ListUsersInGroup' { limit = Prelude.Nothing, nextToken = Prelude.Nothing, userPoolId = pUserPoolId_, groupName = pGroupName_ } -- | The limit of the request to list users. listUsersInGroup_limit :: Lens.Lens' ListUsersInGroup (Prelude.Maybe Prelude.Natural) listUsersInGroup_limit = Lens.lens (\ListUsersInGroup' {limit} -> limit) (\s@ListUsersInGroup' {} a -> s {limit = a} :: ListUsersInGroup) -- | An identifier that was returned from the previous call to this -- operation, which can be used to return the next set of items in the -- list. listUsersInGroup_nextToken :: Lens.Lens' ListUsersInGroup (Prelude.Maybe Prelude.Text) listUsersInGroup_nextToken = Lens.lens (\ListUsersInGroup' {nextToken} -> nextToken) (\s@ListUsersInGroup' {} a -> s {nextToken = a} :: ListUsersInGroup) -- | The user pool ID for the user pool. listUsersInGroup_userPoolId :: Lens.Lens' ListUsersInGroup Prelude.Text listUsersInGroup_userPoolId = Lens.lens (\ListUsersInGroup' {userPoolId} -> userPoolId) (\s@ListUsersInGroup' {} a -> s {userPoolId = a} :: ListUsersInGroup) -- | The name of the group. listUsersInGroup_groupName :: Lens.Lens' ListUsersInGroup Prelude.Text listUsersInGroup_groupName = Lens.lens (\ListUsersInGroup' {groupName} -> groupName) (\s@ListUsersInGroup' {} a -> s {groupName = a} :: ListUsersInGroup) instance Core.AWSPager ListUsersInGroup where page rq rs | Core.stop ( rs Lens.^? listUsersInGroupResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listUsersInGroupResponse_users Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listUsersInGroup_nextToken Lens..~ rs Lens.^? listUsersInGroupResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListUsersInGroup where type AWSResponse ListUsersInGroup = ListUsersInGroupResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListUsersInGroupResponse' Prelude.<$> (x Data..?> "NextToken") Prelude.<*> (x Data..?> "Users" Core..!@ Prelude.mempty) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListUsersInGroup where hashWithSalt _salt ListUsersInGroup' {..} = _salt `Prelude.hashWithSalt` limit `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` userPoolId `Prelude.hashWithSalt` groupName instance Prelude.NFData ListUsersInGroup where rnf ListUsersInGroup' {..} = Prelude.rnf limit `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf userPoolId `Prelude.seq` Prelude.rnf groupName instance Data.ToHeaders ListUsersInGroup where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AWSCognitoIdentityProviderService.ListUsersInGroup" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListUsersInGroup where toJSON ListUsersInGroup' {..} = Data.object ( Prelude.catMaybes [ ("Limit" Data..=) Prelude.<$> limit, ("NextToken" Data..=) Prelude.<$> nextToken, Prelude.Just ("UserPoolId" Data..= userPoolId), Prelude.Just ("GroupName" Data..= groupName) ] ) instance Data.ToPath ListUsersInGroup where toPath = Prelude.const "/" instance Data.ToQuery ListUsersInGroup where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newListUsersInGroupResponse' smart constructor. data ListUsersInGroupResponse = ListUsersInGroupResponse' { -- | An identifier that you can use in a later request to return the next set -- of items in the list. nextToken :: Prelude.Maybe Prelude.Text, -- | The users returned in the request to list users. users :: Prelude.Maybe [UserType], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListUsersInGroupResponse' 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', 'listUsersInGroupResponse_nextToken' - An identifier that you can use in a later request to return the next set -- of items in the list. -- -- 'users', 'listUsersInGroupResponse_users' - The users returned in the request to list users. -- -- 'httpStatus', 'listUsersInGroupResponse_httpStatus' - The response's http status code. newListUsersInGroupResponse :: -- | 'httpStatus' Prelude.Int -> ListUsersInGroupResponse newListUsersInGroupResponse pHttpStatus_ = ListUsersInGroupResponse' { nextToken = Prelude.Nothing, users = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | An identifier that you can use in a later request to return the next set -- of items in the list. listUsersInGroupResponse_nextToken :: Lens.Lens' ListUsersInGroupResponse (Prelude.Maybe Prelude.Text) listUsersInGroupResponse_nextToken = Lens.lens (\ListUsersInGroupResponse' {nextToken} -> nextToken) (\s@ListUsersInGroupResponse' {} a -> s {nextToken = a} :: ListUsersInGroupResponse) -- | The users returned in the request to list users. listUsersInGroupResponse_users :: Lens.Lens' ListUsersInGroupResponse (Prelude.Maybe [UserType]) listUsersInGroupResponse_users = Lens.lens (\ListUsersInGroupResponse' {users} -> users) (\s@ListUsersInGroupResponse' {} a -> s {users = a} :: ListUsersInGroupResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. listUsersInGroupResponse_httpStatus :: Lens.Lens' ListUsersInGroupResponse Prelude.Int listUsersInGroupResponse_httpStatus = Lens.lens (\ListUsersInGroupResponse' {httpStatus} -> httpStatus) (\s@ListUsersInGroupResponse' {} a -> s {httpStatus = a} :: ListUsersInGroupResponse) instance Prelude.NFData ListUsersInGroupResponse where rnf ListUsersInGroupResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf users `Prelude.seq` Prelude.rnf httpStatus