libZSservicesZSamazonka-dsZSamazonka-ds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DirectoryService.DescribeClientAuthenticationSettings

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.

Synopsis

Creating a Request

data DescribeClientAuthenticationSettings Source #

Constructors

DescribeClientAuthenticationSettings' 

Fields

  • nextToken :: Maybe Text

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

  • 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.

  • 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
Eq DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

Read DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

Show DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

Generic DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

NFData DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

Hashable DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

ToJSON DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

AWSRequest DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

ToHeaders DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

ToPath DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

ToQuery DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

type Rep DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

type Rep DescribeClientAuthenticationSettings = D1 ('MetaData "DescribeClientAuthenticationSettings" "Amazonka.DirectoryService.DescribeClientAuthenticationSettings" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "DescribeClientAuthenticationSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientAuthenticationType)) :*: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeClientAuthenticationSettings Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

newDescribeClientAuthenticationSettings Source #

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:nextToken:DescribeClientAuthenticationSettings', describeClientAuthenticationSettings_nextToken - The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.

$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.

$sel:type':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.

$sel:directoryId:DescribeClientAuthenticationSettings', describeClientAuthenticationSettings_directoryId - The identifier of the directory for which to retrieve information.

Request Lenses

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_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_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 #

Constructors

DescribeClientAuthenticationSettingsResponse' 

Fields

  • 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.

  • 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeClientAuthenticationSettingsResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

Read DescribeClientAuthenticationSettingsResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

Show DescribeClientAuthenticationSettingsResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

Generic DescribeClientAuthenticationSettingsResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

NFData DescribeClientAuthenticationSettingsResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

type Rep DescribeClientAuthenticationSettingsResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeClientAuthenticationSettings

type Rep DescribeClientAuthenticationSettingsResponse = D1 ('MetaData "DescribeClientAuthenticationSettingsResponse" "Amazonka.DirectoryService.DescribeClientAuthenticationSettings" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "DescribeClientAuthenticationSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clientAuthenticationSettingsInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClientAuthenticationSettingInfo])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeClientAuthenticationSettingsResponse Source #

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:nextToken: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: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.

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

Response Lenses

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_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.