describe_ldaps_settings async ¶

async def describe_ldaps_settings(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    type: Optional["capo_directory_service.types.ldaps_type.LDAPSType"] = None,
    next_token: Optional[
        "capo_directory_service.types.next_token.NextToken"
    ] = None,
    limit: Optional["capo_directory_service.types.page_limit.PageLimit"] = None,
) -> "capo_directory_service.types.describe_ldaps_settings_result.DescribeLDAPSSettingsResult":
    """<p>Describes the status of LDAP security for the specified directory.</p>

    Args:
        directory_id: <p>The identifier of the directory.</p>
        type: <p>The type of LDAP security to enable. Currently only the value <code>Client</code> is supported.</p>
        next_token: <p>The type of next token used for pagination.</p>
        limit: <p>Specifies the number of items that should be displayed on one page.</p>

    Raises:
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.directory_does_not_exist_exception.DirectoryDoesNotExistException: <p>The specified directory does not exist in the system.</p>
        capo_directory_service.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> value is not valid.</p>
        capo_directory_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_directory_service.types.describe_ldaps_settings_request.DescribeLDAPSSettingsRequest]",
    ) -> AsyncOperationResponse[
        "capo_directory_service.types.describe_ldaps_settings_result.DescribeLDAPSSettingsResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.describe_ldaps_settings

        (
            output,
            http_response,
        ) = await capo_directory_service._operations.directory_service_20150416.describe_ldaps_settings.async_describe_ldaps_settings(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeLDAPSSettings")
    )
    input_: capo_directory_service.types.describe_ldaps_settings_request.DescribeLDAPSSettingsRequest = {
        "directory_id": directory_id
    }
    if type is not None:
        input_["type"] = type
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output