delete_document `async` ¶

delete_document(
    document_id: ResourceIdType,
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
) -> None

Permanently deletes the specified document and its associated metadata.

Parameters:

authentication_token (Optional[AuthenticationHeaderType], default: None ) –

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id (ResourceIdType) –

The ID of the document.

Raises:

ConcurrentModificationException –

The resource hierarchy is changing.
ConflictingOperationException –

Another operation is in progress on the resource that conflicts with the current operation.
EntityNotExistsException –

The resource does not exist.
FailedDependencyException –

The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
LimitExceededException –

The maximum of 100,000 files and folders under the parent folder has been exceeded.
ProhibitedStateException –

The specified document version is not in the INITIALIZED state.
ServiceUnavailableException –

One or more of the dependencies is unavailable.
UnauthorizedOperationException –

The operation is not permitted.
UnauthorizedResourceAccessException –

The caller does not have access to perform the action on the resource.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_workdocs/_services/async_work_docs.py

async def delete_document(
    self,
    document_id: "capo_workdocs.types.resource_id_type.ResourceIdType",
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
) -> None:
    """<p>Permanently deletes the specified document and its associated metadata.</p>

    Args:
        authentication_token: <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
        document_id: <p>The ID of the document.</p>

    Raises:
        capo_workdocs.errors.concurrent_modification_exception.ConcurrentModificationException: <p>The resource hierarchy is changing.</p>
        capo_workdocs.errors.conflicting_operation_exception.ConflictingOperationException: <p>Another operation is in progress on the resource that conflicts with the current operation.</p>
        capo_workdocs.errors.entity_not_exists_exception.EntityNotExistsException: <p>The resource does not exist.</p>
        capo_workdocs.errors.failed_dependency_exception.FailedDependencyException: <p>The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.</p>
        capo_workdocs.errors.limit_exceeded_exception.LimitExceededException: <p>The maximum of 100,000 files and folders under the parent folder has been exceeded.</p>
        capo_workdocs.errors.prohibited_state_exception.ProhibitedStateException: <p>The specified document version is not in the INITIALIZED state.</p>
        capo_workdocs.errors.service_unavailable_exception.ServiceUnavailableException: <p>One or more of the dependencies is unavailable.</p>
        capo_workdocs.errors.unauthorized_operation_exception.UnauthorizedOperationException: <p>The operation is not permitted.</p>
        capo_workdocs.errors.unauthorized_resource_access_exception.UnauthorizedResourceAccessException: <p>The caller does not have access to perform the action on the resource.</p>
        capo_workdocs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workdocs.types.delete_document_request.DeleteDocumentRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_workdocs._operations.aws_gorilla_boy_service.delete_document

        (
            output,
            http_response,
        ) = await capo_workdocs._operations.aws_gorilla_boy_service.delete_document.async_delete_document(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workdocs.types.delete_document_request.DeleteDocumentRequest",
    ) -> dict[str, Any]:
        import capo_workdocs.types.delete_document_request

        return capo_workdocs.types.delete_document_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DeleteDocument", redact_input=_redact_input),
    )
    input_: capo_workdocs.types.delete_document_request.DeleteDocumentRequest = {
        "document_id": document_id
    }
    if authentication_token is not None:
        input_["authentication_token"] = authentication_token

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

delete_document async ¶

delete_document `async` ¶