DescribeClientAuthenticationSettings

class DirectoryService.Paginator.DescribeClientAuthenticationSettings
paginator = client.get_paginator('describe_client_authentication_settings')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DirectoryService.Client.describe_client_authentication_settings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DirectoryId='string',
    Type='SmartCard'|'SmartCardOrPassword',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory for which to retrieve information.

  • Type (string) -- 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.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ClientAuthenticationSettingsInfo': [
        {
            'Type': 'SmartCard'|'SmartCardOrPassword',
            'Status': 'Enabled'|'Disabled',
            'LastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • ClientAuthenticationSettingsInfo (list) --

      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.

      • (dict) --

        Contains information about a client authentication method for a directory.

        • Type (string) --

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

        • Status (string) --

          Whether the client authentication type is enabled or disabled for the specified directory.

        • LastUpdatedDateTime (datetime) --

          The date and time when the status of the client authentication type was last updated.