{-# 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.ListImpersonationRoles -- 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 impersonation roles for the given WorkMail organization. module Amazonka.WorkMail.ListImpersonationRoles ( -- * Creating a Request ListImpersonationRoles (..), newListImpersonationRoles, -- * Request Lenses listImpersonationRoles_maxResults, listImpersonationRoles_nextToken, listImpersonationRoles_organizationId, -- * Destructuring the Response ListImpersonationRolesResponse (..), newListImpersonationRolesResponse, -- * Response Lenses listImpersonationRolesResponse_nextToken, listImpersonationRolesResponse_roles, listImpersonationRolesResponse_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:/ 'newListImpersonationRoles' smart constructor. data ListImpersonationRoles = ListImpersonationRoles' { -- | The maximum number of results returned in a single call. maxResults :: Prelude.Maybe Prelude.Natural, -- | The token used to retrieve the next page of results. The first call -- doesn\'t require a token. nextToken :: Prelude.Maybe Prelude.Text, -- | The WorkMail organization to which the listed impersonation roles -- belong. organizationId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListImpersonationRoles' 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', 'listImpersonationRoles_maxResults' - The maximum number of results returned in a single call. -- -- 'nextToken', 'listImpersonationRoles_nextToken' - The token used to retrieve the next page of results. The first call -- doesn\'t require a token. -- -- 'organizationId', 'listImpersonationRoles_organizationId' - The WorkMail organization to which the listed impersonation roles -- belong. newListImpersonationRoles :: -- | 'organizationId' Prelude.Text -> ListImpersonationRoles newListImpersonationRoles pOrganizationId_ = ListImpersonationRoles' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, organizationId = pOrganizationId_ } -- | The maximum number of results returned in a single call. listImpersonationRoles_maxResults :: Lens.Lens' ListImpersonationRoles (Prelude.Maybe Prelude.Natural) listImpersonationRoles_maxResults = Lens.lens (\ListImpersonationRoles' {maxResults} -> maxResults) (\s@ListImpersonationRoles' {} a -> s {maxResults = a} :: ListImpersonationRoles) -- | The token used to retrieve the next page of results. The first call -- doesn\'t require a token. listImpersonationRoles_nextToken :: Lens.Lens' ListImpersonationRoles (Prelude.Maybe Prelude.Text) listImpersonationRoles_nextToken = Lens.lens (\ListImpersonationRoles' {nextToken} -> nextToken) (\s@ListImpersonationRoles' {} a -> s {nextToken = a} :: ListImpersonationRoles) -- | The WorkMail organization to which the listed impersonation roles -- belong. listImpersonationRoles_organizationId :: Lens.Lens' ListImpersonationRoles Prelude.Text listImpersonationRoles_organizationId = Lens.lens (\ListImpersonationRoles' {organizationId} -> organizationId) (\s@ListImpersonationRoles' {} a -> s {organizationId = a} :: ListImpersonationRoles) instance Core.AWSRequest ListImpersonationRoles where type AWSResponse ListImpersonationRoles = ListImpersonationRolesResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListImpersonationRolesResponse' Prelude.<$> (x Data..?> "NextToken") Prelude.<*> (x Data..?> "Roles" Core..!@ Prelude.mempty) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListImpersonationRoles where hashWithSalt _salt ListImpersonationRoles' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` organizationId instance Prelude.NFData ListImpersonationRoles where rnf ListImpersonationRoles' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf organizationId instance Data.ToHeaders ListImpersonationRoles where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "WorkMailService.ListImpersonationRoles" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListImpersonationRoles where toJSON ListImpersonationRoles' {..} = Data.object ( Prelude.catMaybes [ ("MaxResults" Data..=) Prelude.<$> maxResults, ("NextToken" Data..=) Prelude.<$> nextToken, Prelude.Just ("OrganizationId" Data..= organizationId) ] ) instance Data.ToPath ListImpersonationRoles where toPath = Prelude.const "/" instance Data.ToQuery ListImpersonationRoles where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newListImpersonationRolesResponse' smart constructor. data ListImpersonationRolesResponse = ListImpersonationRolesResponse' { -- | The token to retrieve the next page of results. The value is @null@ when -- there are no results to return. nextToken :: Prelude.Maybe Prelude.Text, -- | The list of impersonation roles under the given WorkMail organization. roles :: Prelude.Maybe [ImpersonationRole], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListImpersonationRolesResponse' 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', 'listImpersonationRolesResponse_nextToken' - The token to retrieve the next page of results. The value is @null@ when -- there are no results to return. -- -- 'roles', 'listImpersonationRolesResponse_roles' - The list of impersonation roles under the given WorkMail organization. -- -- 'httpStatus', 'listImpersonationRolesResponse_httpStatus' - The response's http status code. newListImpersonationRolesResponse :: -- | 'httpStatus' Prelude.Int -> ListImpersonationRolesResponse newListImpersonationRolesResponse pHttpStatus_ = ListImpersonationRolesResponse' { nextToken = Prelude.Nothing, roles = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | The token to retrieve the next page of results. The value is @null@ when -- there are no results to return. listImpersonationRolesResponse_nextToken :: Lens.Lens' ListImpersonationRolesResponse (Prelude.Maybe Prelude.Text) listImpersonationRolesResponse_nextToken = Lens.lens (\ListImpersonationRolesResponse' {nextToken} -> nextToken) (\s@ListImpersonationRolesResponse' {} a -> s {nextToken = a} :: ListImpersonationRolesResponse) -- | The list of impersonation roles under the given WorkMail organization. listImpersonationRolesResponse_roles :: Lens.Lens' ListImpersonationRolesResponse (Prelude.Maybe [ImpersonationRole]) listImpersonationRolesResponse_roles = Lens.lens (\ListImpersonationRolesResponse' {roles} -> roles) (\s@ListImpersonationRolesResponse' {} a -> s {roles = a} :: ListImpersonationRolesResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. listImpersonationRolesResponse_httpStatus :: Lens.Lens' ListImpersonationRolesResponse Prelude.Int listImpersonationRolesResponse_httpStatus = Lens.lens (\ListImpersonationRolesResponse' {httpStatus} -> httpStatus) (\s@ListImpersonationRolesResponse' {} a -> s {httpStatus = a} :: ListImpersonationRolesResponse) instance Prelude.NFData ListImpersonationRolesResponse where rnf ListImpersonationRolesResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf roles `Prelude.seq` Prelude.rnf httpStatus