Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DirectoryService.DescribeClientAuthenticationSettings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeClientAuthenticationSettings Source #

See: newDescribeClientAuthenticationSettings smart constructor.

Constructors

DescribeClientAuthenticationSettings'

Fields

limit :: Maybe Natural
The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
nextToken :: Maybe Text
The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.
type' :: Maybe ClientAuthenticationType
The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.
directoryId :: Text
The identifier of the directory for which to retrieve information.

Instances

Instances details

ToJSON DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods toJSON :: DescribeClientAuthenticationSettings -> Value # toEncoding :: DescribeClientAuthenticationSettings -> Encoding # toJSONList :: [DescribeClientAuthenticationSettings] -> Value # toEncodingList :: [DescribeClientAuthenticationSettings] -> Encoding #
ToHeaders DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods toHeaders :: DescribeClientAuthenticationSettings -> [Header] #
ToPath DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods toPath :: DescribeClientAuthenticationSettings -> ByteString #
ToQuery DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods toQuery :: DescribeClientAuthenticationSettings -> QueryString #
AWSPager DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods page :: DescribeClientAuthenticationSettings -> AWSResponse DescribeClientAuthenticationSettings -> Maybe DescribeClientAuthenticationSettings #
AWSRequest DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Associated Types type AWSResponse DescribeClientAuthenticationSettings # Methods request :: (Service -> Service) -> DescribeClientAuthenticationSettings -> Request DescribeClientAuthenticationSettings # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeClientAuthenticationSettings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeClientAuthenticationSettings))) #
Generic DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Associated Types type Rep DescribeClientAuthenticationSettings :: Type -> Type # Methods from :: DescribeClientAuthenticationSettings -> Rep DescribeClientAuthenticationSettings x # to :: Rep DescribeClientAuthenticationSettings x -> DescribeClientAuthenticationSettings #
Read DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods readsPrec :: Int -> ReadS DescribeClientAuthenticationSettings # readList :: ReadS [DescribeClientAuthenticationSettings] # readPrec :: ReadPrec DescribeClientAuthenticationSettings # readListPrec :: ReadPrec [DescribeClientAuthenticationSettings] #
Show DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods showsPrec :: Int -> DescribeClientAuthenticationSettings -> ShowS # show :: DescribeClientAuthenticationSettings -> String # showList :: [DescribeClientAuthenticationSettings] -> ShowS #
NFData DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods rnf :: DescribeClientAuthenticationSettings -> () #
Eq DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods (==) :: DescribeClientAuthenticationSettings -> DescribeClientAuthenticationSettings -> Bool # (/=) :: DescribeClientAuthenticationSettings -> DescribeClientAuthenticationSettings -> Bool #
Hashable DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods hashWithSalt :: Int -> DescribeClientAuthenticationSettings -> Int # hash :: DescribeClientAuthenticationSettings -> Int #
type AWSResponse DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings type AWSResponse DescribeClientAuthenticationSettings = DescribeClientAuthenticationSettingsResponse
type Rep DescribeClientAuthenticationSettings Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings type Rep DescribeClientAuthenticationSettings = D1 ('MetaData "DescribeClientAuthenticationSettings" "Amazonka.DirectoryService.DescribeClientAuthenticationSettings" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeClientAuthenticationSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientAuthenticationType)) :*: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeClientAuthenticationSettings Source #

Arguments

:: Text	`DescribeClientAuthenticationSettings`
-> DescribeClientAuthenticationSettings

Create a value of DescribeClientAuthenticationSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:DescribeClientAuthenticationSettings', describeClientAuthenticationSettings_limit - The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

DescribeClientAuthenticationSettings, describeClientAuthenticationSettings_nextToken - The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.

DescribeClientAuthenticationSettings, describeClientAuthenticationSettings_type - The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.

DescribeClientAuthenticationSettings, describeClientAuthenticationSettings_directoryId - The identifier of the directory for which to retrieve information.

Request Lenses

describeClientAuthenticationSettings_limit :: Lens' DescribeClientAuthenticationSettings (Maybe Natural) Source #

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

describeClientAuthenticationSettings_nextToken :: Lens' DescribeClientAuthenticationSettings (Maybe Text) Source #

The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.

describeClientAuthenticationSettings_type :: Lens' DescribeClientAuthenticationSettings (Maybe ClientAuthenticationType) Source #

The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.

describeClientAuthenticationSettings_directoryId :: Lens' DescribeClientAuthenticationSettings Text Source #

The identifier of the directory for which to retrieve information.

Destructuring the Response

data DescribeClientAuthenticationSettingsResponse Source #

See: newDescribeClientAuthenticationSettingsResponse smart constructor.

Constructors

DescribeClientAuthenticationSettingsResponse'

Fields

clientAuthenticationSettingsInfo :: Maybe [ClientAuthenticationSettingInfo]
Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.
nextToken :: Maybe Text
The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeClientAuthenticationSettingsResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Associated Types type Rep DescribeClientAuthenticationSettingsResponse :: Type -> Type # Methods from :: DescribeClientAuthenticationSettingsResponse -> Rep DescribeClientAuthenticationSettingsResponse x # to :: Rep DescribeClientAuthenticationSettingsResponse x -> DescribeClientAuthenticationSettingsResponse #
Read DescribeClientAuthenticationSettingsResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods readsPrec :: Int -> ReadS DescribeClientAuthenticationSettingsResponse # readList :: ReadS [DescribeClientAuthenticationSettingsResponse] # readPrec :: ReadPrec DescribeClientAuthenticationSettingsResponse # readListPrec :: ReadPrec [DescribeClientAuthenticationSettingsResponse] #
Show DescribeClientAuthenticationSettingsResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods showsPrec :: Int -> DescribeClientAuthenticationSettingsResponse -> ShowS # show :: DescribeClientAuthenticationSettingsResponse -> String # showList :: [DescribeClientAuthenticationSettingsResponse] -> ShowS #
NFData DescribeClientAuthenticationSettingsResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods rnf :: DescribeClientAuthenticationSettingsResponse -> () #
Eq DescribeClientAuthenticationSettingsResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings Methods (==) :: DescribeClientAuthenticationSettingsResponse -> DescribeClientAuthenticationSettingsResponse -> Bool # (/=) :: DescribeClientAuthenticationSettingsResponse -> DescribeClientAuthenticationSettingsResponse -> Bool #
type Rep DescribeClientAuthenticationSettingsResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings type Rep DescribeClientAuthenticationSettingsResponse = D1 ('MetaData "DescribeClientAuthenticationSettingsResponse" "Amazonka.DirectoryService.DescribeClientAuthenticationSettings" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeClientAuthenticationSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientAuthenticationSettingsInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClientAuthenticationSettingInfo])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeClientAuthenticationSettingsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeClientAuthenticationSettingsResponse'`
-> DescribeClientAuthenticationSettingsResponse

Create a value of DescribeClientAuthenticationSettingsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientAuthenticationSettingsInfo:DescribeClientAuthenticationSettingsResponse', describeClientAuthenticationSettingsResponse_clientAuthenticationSettingsInfo - Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.

DescribeClientAuthenticationSettings, describeClientAuthenticationSettingsResponse_nextToken - The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.

$sel:httpStatus:DescribeClientAuthenticationSettingsResponse', describeClientAuthenticationSettingsResponse_httpStatus - The response's http status code.

Response Lenses

describeClientAuthenticationSettingsResponse_clientAuthenticationSettingsInfo :: Lens' DescribeClientAuthenticationSettingsResponse (Maybe [ClientAuthenticationSettingInfo]) Source #

Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.

describeClientAuthenticationSettingsResponse_nextToken :: Lens' DescribeClientAuthenticationSettingsResponse (Maybe Text) Source #

The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.

describeClientAuthenticationSettingsResponse_httpStatus :: Lens' DescribeClientAuthenticationSettingsResponse Int Source #

The response's http status code.