Skip to content

update_settings async 

update_settings(
    directory_id: DirectoryId,
    settings: Settings,
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
) -> UpdateSettingsResult

Updates the configurable settings for the specified directory.

Parameters:

  • directory_id (DirectoryId) –

    The identifier of the directory for which to update settings.

  • settings (Settings) –

    The list of Setting objects.

Raises:

Source code in docs_src/capo_directory_service/_services/async_directory_service.py 
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
async def update_settings(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    settings: "capo_directory_service.types.settings.Settings",
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
) -> "capo_directory_service.types.update_settings_result.UpdateSettingsResult":
    """<p>Updates the configurable settings for the specified directory.</p>

    Args:
        directory_id: <p>The identifier of the directory for which to update settings.</p>
        settings: <p>The list of <a>Setting</a> objects.</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.directory_unavailable_exception.DirectoryUnavailableException: <p>The specified directory is unavailable.</p>
        capo_directory_service.errors.incompatible_settings_exception.IncompatibleSettingsException: <p>The specified directory setting is not compatible with other settings.</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.unsupported_settings_exception.UnsupportedSettingsException: <p>The specified directory setting 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.update_settings_request.UpdateSettingsRequest]",
    ) -> AsyncOperationResponse[
        "capo_directory_service.types.update_settings_result.UpdateSettingsResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.update_settings

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSettings")
    )
    input_: capo_directory_service.types.update_settings_request.UpdateSettingsRequest = {
        "directory_id": directory_id,
        "settings": settings,
    }

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