{-# 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.QuickSight.ListGroupMemberships -- 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 member users in a group. module Amazonka.QuickSight.ListGroupMemberships ( -- * Creating a Request ListGroupMemberships (..), newListGroupMemberships, -- * Request Lenses listGroupMemberships_maxResults, listGroupMemberships_nextToken, listGroupMemberships_groupName, listGroupMemberships_awsAccountId, listGroupMemberships_namespace, -- * Destructuring the Response ListGroupMembershipsResponse (..), newListGroupMembershipsResponse, -- * Response Lenses listGroupMembershipsResponse_groupMemberList, listGroupMembershipsResponse_nextToken, listGroupMembershipsResponse_requestId, listGroupMembershipsResponse_status, ) 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 Amazonka.QuickSight.Types import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newListGroupMemberships' smart constructor. data ListGroupMemberships = ListGroupMemberships' { -- | The maximum number of results to return from this request. maxResults :: Prelude.Maybe Prelude.Natural, -- | A pagination token that can be used in a subsequent request. nextToken :: Prelude.Maybe Prelude.Text, -- | The name of the group that you want to see a membership list of. groupName :: Prelude.Text, -- | The ID for the Amazon Web Services account that the group is in. -- Currently, you use the ID for the Amazon Web Services account that -- contains your Amazon QuickSight account. awsAccountId :: Prelude.Text, -- | The namespace of the group that you want a list of users from. namespace :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListGroupMemberships' 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', 'listGroupMemberships_maxResults' - The maximum number of results to return from this request. -- -- 'nextToken', 'listGroupMemberships_nextToken' - A pagination token that can be used in a subsequent request. -- -- 'groupName', 'listGroupMemberships_groupName' - The name of the group that you want to see a membership list of. -- -- 'awsAccountId', 'listGroupMemberships_awsAccountId' - The ID for the Amazon Web Services account that the group is in. -- Currently, you use the ID for the Amazon Web Services account that -- contains your Amazon QuickSight account. -- -- 'namespace', 'listGroupMemberships_namespace' - The namespace of the group that you want a list of users from. newListGroupMemberships :: -- | 'groupName' Prelude.Text -> -- | 'awsAccountId' Prelude.Text -> -- | 'namespace' Prelude.Text -> ListGroupMemberships newListGroupMemberships pGroupName_ pAwsAccountId_ pNamespace_ = ListGroupMemberships' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, groupName = pGroupName_, awsAccountId = pAwsAccountId_, namespace = pNamespace_ } -- | The maximum number of results to return from this request. listGroupMemberships_maxResults :: Lens.Lens' ListGroupMemberships (Prelude.Maybe Prelude.Natural) listGroupMemberships_maxResults = Lens.lens (\ListGroupMemberships' {maxResults} -> maxResults) (\s@ListGroupMemberships' {} a -> s {maxResults = a} :: ListGroupMemberships) -- | A pagination token that can be used in a subsequent request. listGroupMemberships_nextToken :: Lens.Lens' ListGroupMemberships (Prelude.Maybe Prelude.Text) listGroupMemberships_nextToken = Lens.lens (\ListGroupMemberships' {nextToken} -> nextToken) (\s@ListGroupMemberships' {} a -> s {nextToken = a} :: ListGroupMemberships) -- | The name of the group that you want to see a membership list of. listGroupMemberships_groupName :: Lens.Lens' ListGroupMemberships Prelude.Text listGroupMemberships_groupName = Lens.lens (\ListGroupMemberships' {groupName} -> groupName) (\s@ListGroupMemberships' {} a -> s {groupName = a} :: ListGroupMemberships) -- | The ID for the Amazon Web Services account that the group is in. -- Currently, you use the ID for the Amazon Web Services account that -- contains your Amazon QuickSight account. listGroupMemberships_awsAccountId :: Lens.Lens' ListGroupMemberships Prelude.Text listGroupMemberships_awsAccountId = Lens.lens (\ListGroupMemberships' {awsAccountId} -> awsAccountId) (\s@ListGroupMemberships' {} a -> s {awsAccountId = a} :: ListGroupMemberships) -- | The namespace of the group that you want a list of users from. listGroupMemberships_namespace :: Lens.Lens' ListGroupMemberships Prelude.Text listGroupMemberships_namespace = Lens.lens (\ListGroupMemberships' {namespace} -> namespace) (\s@ListGroupMemberships' {} a -> s {namespace = a} :: ListGroupMemberships) instance Core.AWSRequest ListGroupMemberships where type AWSResponse ListGroupMemberships = ListGroupMembershipsResponse request overrides = Request.get (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListGroupMembershipsResponse' Prelude.<$> ( x Data..?> "GroupMemberList" Core..!@ Prelude.mempty ) Prelude.<*> (x Data..?> "NextToken") Prelude.<*> (x Data..?> "RequestId") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListGroupMemberships where hashWithSalt _salt ListGroupMemberships' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` groupName `Prelude.hashWithSalt` awsAccountId `Prelude.hashWithSalt` namespace instance Prelude.NFData ListGroupMemberships where rnf ListGroupMemberships' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf groupName `Prelude.seq` Prelude.rnf awsAccountId `Prelude.seq` Prelude.rnf namespace instance Data.ToHeaders ListGroupMemberships where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.0" :: Prelude.ByteString ) ] ) instance Data.ToPath ListGroupMemberships where toPath ListGroupMemberships' {..} = Prelude.mconcat [ "/accounts/", Data.toBS awsAccountId, "/namespaces/", Data.toBS namespace, "/groups/", Data.toBS groupName, "/members" ] instance Data.ToQuery ListGroupMemberships where toQuery ListGroupMemberships' {..} = Prelude.mconcat [ "max-results" Data.=: maxResults, "next-token" Data.=: nextToken ] -- | /See:/ 'newListGroupMembershipsResponse' smart constructor. data ListGroupMembershipsResponse = ListGroupMembershipsResponse' { -- | The list of the members of the group. groupMemberList :: Prelude.Maybe [GroupMember], -- | A pagination token that can be used in a subsequent request. nextToken :: Prelude.Maybe Prelude.Text, -- | The Amazon Web Services request ID for this operation. requestId :: Prelude.Maybe Prelude.Text, -- | The HTTP status of the request. status :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListGroupMembershipsResponse' 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: -- -- 'groupMemberList', 'listGroupMembershipsResponse_groupMemberList' - The list of the members of the group. -- -- 'nextToken', 'listGroupMembershipsResponse_nextToken' - A pagination token that can be used in a subsequent request. -- -- 'requestId', 'listGroupMembershipsResponse_requestId' - The Amazon Web Services request ID for this operation. -- -- 'status', 'listGroupMembershipsResponse_status' - The HTTP status of the request. newListGroupMembershipsResponse :: -- | 'status' Prelude.Int -> ListGroupMembershipsResponse newListGroupMembershipsResponse pStatus_ = ListGroupMembershipsResponse' { groupMemberList = Prelude.Nothing, nextToken = Prelude.Nothing, requestId = Prelude.Nothing, status = pStatus_ } -- | The list of the members of the group. listGroupMembershipsResponse_groupMemberList :: Lens.Lens' ListGroupMembershipsResponse (Prelude.Maybe [GroupMember]) listGroupMembershipsResponse_groupMemberList = Lens.lens (\ListGroupMembershipsResponse' {groupMemberList} -> groupMemberList) (\s@ListGroupMembershipsResponse' {} a -> s {groupMemberList = a} :: ListGroupMembershipsResponse) Prelude.. Lens.mapping Lens.coerced -- | A pagination token that can be used in a subsequent request. listGroupMembershipsResponse_nextToken :: Lens.Lens' ListGroupMembershipsResponse (Prelude.Maybe Prelude.Text) listGroupMembershipsResponse_nextToken = Lens.lens (\ListGroupMembershipsResponse' {nextToken} -> nextToken) (\s@ListGroupMembershipsResponse' {} a -> s {nextToken = a} :: ListGroupMembershipsResponse) -- | The Amazon Web Services request ID for this operation. listGroupMembershipsResponse_requestId :: Lens.Lens' ListGroupMembershipsResponse (Prelude.Maybe Prelude.Text) listGroupMembershipsResponse_requestId = Lens.lens (\ListGroupMembershipsResponse' {requestId} -> requestId) (\s@ListGroupMembershipsResponse' {} a -> s {requestId = a} :: ListGroupMembershipsResponse) -- | The HTTP status of the request. listGroupMembershipsResponse_status :: Lens.Lens' ListGroupMembershipsResponse Prelude.Int listGroupMembershipsResponse_status = Lens.lens (\ListGroupMembershipsResponse' {status} -> status) (\s@ListGroupMembershipsResponse' {} a -> s {status = a} :: ListGroupMembershipsResponse) instance Prelude.NFData ListGroupMembershipsResponse where rnf ListGroupMembershipsResponse' {..} = Prelude.rnf groupMemberList `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf requestId `Prelude.seq` Prelude.rnf status