update_directory_setup
async
¶
update_directory_setup(
directory_id: DirectoryId,
update_type: UpdateType,
*,
config_overrides: Optional[AsyncDirectoryServiceClientConfig] = 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/async_directory_service.py
5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 | |