describe_client_authentication_settings
¶
describe_client_authentication_settings(
directory_id: DirectoryId,
*,
config_overrides: Optional[DirectoryServiceClientConfig] = None,
type: Optional[ClientAuthenticationType] = None,
next_token: Optional[NextToken] = None,
limit: Optional[PageLimit] = None,
) -> DescribeClientAuthenticationSettingsResult
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.
Parameters:
-
directory_id(DirectoryId) –The identifier of the directory for which to retrieve information.
-
type(Optional[ClientAuthenticationType], default:None) –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.
-
next_token(Optional[NextToken], default:None) –The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.
-
limit(Optional[PageLimit], default:None) –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.
Raises:
-
AccessDeniedException–You do not have sufficient access to perform this action.
-
ClientException–A client exception has occurred.
-
DirectoryDoesNotExistException–The specified directory does not exist in the system.
-
InvalidParameterException–One or more parameters are not valid.
-
ServiceException–An exception has occurred in Directory Service.
-
UnsupportedOperationException–The operation is not supported.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_directory_service/_services/directory_service.py
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 | |