Deletes a directory snapshot.
Parameters:
-
snapshot_id
(SnapshotId)
–
The identifier of the directory snapshot to be deleted.
Raises:
Examples:
To delete a snapshot
The following example deletes a directory snapshot.
>>> client.delete_snapshot(snapshot_id='s-9267f8d3f0')
Source code in docs_src/capo_directory_service/_services/directory_service.py
| def delete_snapshot(
self,
snapshot_id: "capo_directory_service.types.snapshot_id.SnapshotId",
*,
config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> "capo_directory_service.types.delete_snapshot_result.DeleteSnapshotResult":
"""<p>Deletes a directory snapshot.</p>
Args:
snapshot_id: <p>The identifier of the directory snapshot to be deleted.</p>
Raises:
capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
capo_directory_service.errors.entity_does_not_exist_exception.EntityDoesNotExistException: <p>The specified entity could not be found.</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.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To delete a snapshot
The following example deletes a directory snapshot.
>>> client.delete_snapshot(snapshot_id='s-9267f8d3f0')
"""
def _handler(
req: "OperationRequest[capo_directory_service.types.delete_snapshot_request.DeleteSnapshotRequest]",
) -> OperationResponse[
"capo_directory_service.types.delete_snapshot_result.DeleteSnapshotResult"
]:
import capo_directory_service._operations.directory_service_20150416.delete_snapshot
output, http_response = (
capo_directory_service._operations.directory_service_20150416.delete_snapshot.delete_snapshot(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteSnapshot")
)
input_: capo_directory_service.types.delete_snapshot_request.DeleteSnapshotRequest = {
"snapshot_id": snapshot_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|