Deletes an Directory Service directory.
Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
Parameters:
-
directory_id
(DirectoryId)
–
The identifier of the directory to delete.
Raises:
Examples:
To delete a directory
The following example deletes a directory from your AWS account.
>>> client.delete_directory(directory_id='d-92654abfed')
Source code in docs_src/capo_directory_service/_services/directory_service.py
| def delete_directory(
self,
directory_id: "capo_directory_service.types.directory_id.DirectoryId",
*,
config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> "capo_directory_service.types.delete_directory_result.DeleteDirectoryResult":
"""<p>Deletes an Directory Service directory.</p> <p>Before you call <code>DeleteDirectory</code>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <code>DeleteDirectory</code> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>
Args:
directory_id: <p>The identifier of the directory to delete.</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.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 directory
The following example deletes a directory from your AWS account.
>>> client.delete_directory(directory_id='d-92654abfed')
"""
def _handler(
req: "OperationRequest[capo_directory_service.types.delete_directory_request.DeleteDirectoryRequest]",
) -> OperationResponse[
"capo_directory_service.types.delete_directory_result.DeleteDirectoryResult"
]:
import capo_directory_service._operations.directory_service_20150416.delete_directory
output, http_response = (
capo_directory_service._operations.directory_service_20150416.delete_directory.delete_directory(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteDirectory")
)
input_: capo_directory_service.types.delete_directory_request.DeleteDirectoryRequest = {
"directory_id": directory_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|