{-# 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.DirectoryService.DescribeLDAPSSettings -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Describes the status of LDAP security for the specified directory. -- -- This operation returns paginated results. module Amazonka.DirectoryService.DescribeLDAPSSettings ( -- * Creating a Request DescribeLDAPSSettings (..), newDescribeLDAPSSettings, -- * Request Lenses describeLDAPSSettings_limit, describeLDAPSSettings_nextToken, describeLDAPSSettings_type, describeLDAPSSettings_directoryId, -- * Destructuring the Response DescribeLDAPSSettingsResponse (..), newDescribeLDAPSSettingsResponse, -- * Response Lenses describeLDAPSSettingsResponse_lDAPSSettingsInfo, describeLDAPSSettingsResponse_nextToken, describeLDAPSSettingsResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.DirectoryService.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newDescribeLDAPSSettings' smart constructor. data DescribeLDAPSSettings = DescribeLDAPSSettings' { -- | Specifies the number of items that should be displayed on one page. limit :: Prelude.Maybe Prelude.Natural, -- | The type of next token used for pagination. nextToken :: Prelude.Maybe Prelude.Text, -- | The type of LDAP security to enable. Currently only the value @Client@ -- is supported. type' :: Prelude.Maybe LDAPSType, -- | The identifier of the directory. directoryId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeLDAPSSettings' 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', 'describeLDAPSSettings_limit' - Specifies the number of items that should be displayed on one page. -- -- 'nextToken', 'describeLDAPSSettings_nextToken' - The type of next token used for pagination. -- -- 'type'', 'describeLDAPSSettings_type' - The type of LDAP security to enable. Currently only the value @Client@ -- is supported. -- -- 'directoryId', 'describeLDAPSSettings_directoryId' - The identifier of the directory. newDescribeLDAPSSettings :: -- | 'directoryId' Prelude.Text -> DescribeLDAPSSettings newDescribeLDAPSSettings pDirectoryId_ = DescribeLDAPSSettings' { limit = Prelude.Nothing, nextToken = Prelude.Nothing, type' = Prelude.Nothing, directoryId = pDirectoryId_ } -- | Specifies the number of items that should be displayed on one page. describeLDAPSSettings_limit :: Lens.Lens' DescribeLDAPSSettings (Prelude.Maybe Prelude.Natural) describeLDAPSSettings_limit = Lens.lens (\DescribeLDAPSSettings' {limit} -> limit) (\s@DescribeLDAPSSettings' {} a -> s {limit = a} :: DescribeLDAPSSettings) -- | The type of next token used for pagination. describeLDAPSSettings_nextToken :: Lens.Lens' DescribeLDAPSSettings (Prelude.Maybe Prelude.Text) describeLDAPSSettings_nextToken = Lens.lens (\DescribeLDAPSSettings' {nextToken} -> nextToken) (\s@DescribeLDAPSSettings' {} a -> s {nextToken = a} :: DescribeLDAPSSettings) -- | The type of LDAP security to enable. Currently only the value @Client@ -- is supported. describeLDAPSSettings_type :: Lens.Lens' DescribeLDAPSSettings (Prelude.Maybe LDAPSType) describeLDAPSSettings_type = Lens.lens (\DescribeLDAPSSettings' {type'} -> type') (\s@DescribeLDAPSSettings' {} a -> s {type' = a} :: DescribeLDAPSSettings) -- | The identifier of the directory. describeLDAPSSettings_directoryId :: Lens.Lens' DescribeLDAPSSettings Prelude.Text describeLDAPSSettings_directoryId = Lens.lens (\DescribeLDAPSSettings' {directoryId} -> directoryId) (\s@DescribeLDAPSSettings' {} a -> s {directoryId = a} :: DescribeLDAPSSettings) instance Core.AWSPager DescribeLDAPSSettings where page rq rs | Core.stop ( rs Lens.^? describeLDAPSSettingsResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? describeLDAPSSettingsResponse_lDAPSSettingsInfo Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& describeLDAPSSettings_nextToken Lens..~ rs Lens.^? describeLDAPSSettingsResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest DescribeLDAPSSettings where type AWSResponse DescribeLDAPSSettings = DescribeLDAPSSettingsResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeLDAPSSettingsResponse' Prelude.<$> ( x Data..?> "LDAPSSettingsInfo" Core..!@ Prelude.mempty ) Prelude.<*> (x Data..?> "NextToken") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable DescribeLDAPSSettings where hashWithSalt _salt DescribeLDAPSSettings' {..} = _salt `Prelude.hashWithSalt` limit `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` type' `Prelude.hashWithSalt` directoryId instance Prelude.NFData DescribeLDAPSSettings where rnf DescribeLDAPSSettings' {..} = Prelude.rnf limit `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf type' `Prelude.seq` Prelude.rnf directoryId instance Data.ToHeaders DescribeLDAPSSettings where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "DirectoryService_20150416.DescribeLDAPSSettings" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DescribeLDAPSSettings where toJSON DescribeLDAPSSettings' {..} = Data.object ( Prelude.catMaybes [ ("Limit" Data..=) Prelude.<$> limit, ("NextToken" Data..=) Prelude.<$> nextToken, ("Type" Data..=) Prelude.<$> type', Prelude.Just ("DirectoryId" Data..= directoryId) ] ) instance Data.ToPath DescribeLDAPSSettings where toPath = Prelude.const "/" instance Data.ToQuery DescribeLDAPSSettings where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeLDAPSSettingsResponse' smart constructor. data DescribeLDAPSSettingsResponse = DescribeLDAPSSettingsResponse' { -- | Information about LDAP security for the specified directory, including -- status of enablement, state last updated date time, and the reason for -- the state. lDAPSSettingsInfo :: Prelude.Maybe [LDAPSSettingInfo], -- | The next token used to retrieve the LDAPS settings if the number of -- setting types exceeds page limit and there is another page. 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 'DescribeLDAPSSettingsResponse' 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: -- -- 'lDAPSSettingsInfo', 'describeLDAPSSettingsResponse_lDAPSSettingsInfo' - Information about LDAP security for the specified directory, including -- status of enablement, state last updated date time, and the reason for -- the state. -- -- 'nextToken', 'describeLDAPSSettingsResponse_nextToken' - The next token used to retrieve the LDAPS settings if the number of -- setting types exceeds page limit and there is another page. -- -- 'httpStatus', 'describeLDAPSSettingsResponse_httpStatus' - The response's http status code. newDescribeLDAPSSettingsResponse :: -- | 'httpStatus' Prelude.Int -> DescribeLDAPSSettingsResponse newDescribeLDAPSSettingsResponse pHttpStatus_ = DescribeLDAPSSettingsResponse' { lDAPSSettingsInfo = Prelude.Nothing, nextToken = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | Information about LDAP security for the specified directory, including -- status of enablement, state last updated date time, and the reason for -- the state. describeLDAPSSettingsResponse_lDAPSSettingsInfo :: Lens.Lens' DescribeLDAPSSettingsResponse (Prelude.Maybe [LDAPSSettingInfo]) describeLDAPSSettingsResponse_lDAPSSettingsInfo = Lens.lens (\DescribeLDAPSSettingsResponse' {lDAPSSettingsInfo} -> lDAPSSettingsInfo) (\s@DescribeLDAPSSettingsResponse' {} a -> s {lDAPSSettingsInfo = a} :: DescribeLDAPSSettingsResponse) Prelude.. Lens.mapping Lens.coerced -- | The next token used to retrieve the LDAPS settings if the number of -- setting types exceeds page limit and there is another page. describeLDAPSSettingsResponse_nextToken :: Lens.Lens' DescribeLDAPSSettingsResponse (Prelude.Maybe Prelude.Text) describeLDAPSSettingsResponse_nextToken = Lens.lens (\DescribeLDAPSSettingsResponse' {nextToken} -> nextToken) (\s@DescribeLDAPSSettingsResponse' {} a -> s {nextToken = a} :: DescribeLDAPSSettingsResponse) -- | The response's http status code. describeLDAPSSettingsResponse_httpStatus :: Lens.Lens' DescribeLDAPSSettingsResponse Prelude.Int describeLDAPSSettingsResponse_httpStatus = Lens.lens (\DescribeLDAPSSettingsResponse' {httpStatus} -> httpStatus) (\s@DescribeLDAPSSettingsResponse' {} a -> s {httpStatus = a} :: DescribeLDAPSSettingsResponse) instance Prelude.NFData DescribeLDAPSSettingsResponse where rnf DescribeLDAPSSettingsResponse' {..} = Prelude.rnf lDAPSSettingsInfo `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf httpStatus