update_directory_setup
¶
update_directory_setup(
directory_id: DirectoryId,
update_type: UpdateType,
*,
config_overrides: Optional[DirectoryServiceClientConfig] = None,
os_update_settings: Optional[OSUpdateSettings] = None,
directory_size_update_settings: Optional[DirectorySizeUpdateSettings] = None,
network_update_settings: Optional[NetworkUpdateSettings] = None,
create_snapshot_before_update: Optional[CreateSnapshotBeforeUpdate] = None,
) -> UpdateDirectorySetupResult
Updates directory configuration for the specified update type.
Parameters:
-
directory_id(DirectoryId) –The identifier of the directory to update.
-
update_type(UpdateType) –The type of update to perform on the directory.
-
os_update_settings(Optional[OSUpdateSettings], default:None) –Operating system configuration to apply during the directory update operation.
-
directory_size_update_settings(Optional[DirectorySizeUpdateSettings], default:None) –Directory size configuration to apply during the update operation.
-
network_update_settings(Optional[NetworkUpdateSettings], default:None) –Network configuration to apply during the directory update operation.
-
create_snapshot_before_update(Optional[CreateSnapshotBeforeUpdate], default:None) –Specifies whether to create a directory snapshot before performing the update.
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.
-
DirectoryInDesiredStateException–The directory is already updated to desired update type settings.
-
DirectoryUnavailableException–The specified directory is unavailable.
-
InvalidParameterException–One or more parameters are not valid.
-
ServiceException–An exception has occurred in Directory Service.
-
SnapshotLimitExceededException–The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.
-
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
5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 | |