Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
Parameters:
-
instance_id
(InstanceId)
–
The unique identifier of the Connect instance.
-
file_id
(FileId)
–
The unique identifier of the attached file resource.
-
associated_resource_arn
(ARN)
–
The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.
This value must be a valid ARN.
Raises:
Source code in docs_src/capo_connect/_services/async_connect.py
| async def delete_attached_file(
self,
instance_id: "capo_connect.types.instance_id.InstanceId",
file_id: "capo_connect.types.file_id.FileId",
associated_resource_arn: "capo_connect.types.arn.ARN",
*,
config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> "capo_connect.types.delete_attached_file_response.DeleteAttachedFileResponse":
"""<p>Deletes an attached file along with the underlying S3 Object.</p> <important> <p>The attached file is <b>permanently deleted</b> if S3 bucket versioning is not enabled.</p> </important>
Args:
instance_id: <p>The unique identifier of the Connect instance.</p>
file_id: <p>The unique identifier of the attached file resource.</p>
associated_resource_arn: <p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a>, <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>, and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-getting-started-tasks.html">Task</a>.</p> <note> <p>This value must be a valid ARN.</p> </note>
Raises:
capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_connect.types.delete_attached_file_request.DeleteAttachedFileRequest]",
) -> AsyncOperationResponse[
"capo_connect.types.delete_attached_file_response.DeleteAttachedFileResponse"
]:
import capo_connect._operations.amazon_connect_service.delete_attached_file
(
output,
http_response,
) = await capo_connect._operations.amazon_connect_service.delete_attached_file.async_delete_attached_file(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteAttachedFile")
)
input_: capo_connect.types.delete_attached_file_request.DeleteAttachedFileRequest = {
"instance_id": instance_id,
"file_id": file_id,
"associated_resource_arn": associated_resource_arn,
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|