describe_settings async ¶

async def describe_settings(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    status: Optional[
        "capo_directory_service.types.directory_configuration_status.DirectoryConfigurationStatus"
    ] = None,
    next_token: Optional[
        "capo_directory_service.types.next_token.NextToken"
    ] = None,
) -> "capo_directory_service.types.describe_settings_result.DescribeSettingsResult":
    """<p>Retrieves information about the configurable settings for the specified directory.</p>

    Args:
        directory_id: <p>The identifier of the directory for which to retrieve information.</p>
        status: <p>The status of the directory settings for which to retrieve information.</p>
        next_token: <p>The <code>DescribeSettingsResult.NextToken</code> value from a previous call to <a>DescribeSettings</a>. Pass null if this is the first call.</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_settings_request.DescribeSettingsRequest]",
    ) -> AsyncOperationResponse[
        "capo_directory_service.types.describe_settings_result.DescribeSettingsResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.describe_settings

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSettings")
    )
    input_: capo_directory_service.types.describe_settings_request.DescribeSettingsRequest = {
        "directory_id": directory_id
    }
    if status is not None:
        input_["status"] = status
    if next_token is not None:
        input_["next_token"] = next_token

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