Skip to content

get_attached_file async

get_attached_file(
    instance_id: InstanceId,
    file_id: FileId,
    associated_resource_arn: ARN,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    url_expiry_in_seconds: Optional[URLExpiryInSeconds] = None,
) -> GetAttachedFileResponse

Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.

Parameters:

  • instance_id (InstanceId) –

    The unique identifier of the Connect Customer instance.

  • file_id (FileId) –

    The unique identifier of the attached file resource.

  • url_expiry_in_seconds (Optional[URLExpiryInSeconds], default: None ) –

    Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

  • 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 get_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,
    url_expiry_in_seconds: Optional[
        "capo_connect.types.url_expiry_in_seconds.URLExpiryInSeconds"
    ] = None,
) -> "capo_connect.types.get_attached_file_response.GetAttachedFileResponse":
    """<p>Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is <code>APPROVED</code>.</p>

    Args:
        instance_id: <p>The unique identifier of the Connect Customer instance.</p>
        file_id: <p>The unique identifier of the attached file resource.</p>
        url_expiry_in_seconds: <p>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</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.get_attached_file_request.GetAttachedFileRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.get_attached_file_response.GetAttachedFileResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.get_attached_file

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.get_attached_file.async_get_attached_file(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAttachedFile")
    )
    input_: capo_connect.types.get_attached_file_request.GetAttachedFileRequest = {
        "instance_id": instance_id,
        "file_id": file_id,
        "associated_resource_arn": associated_resource_arn,
    }
    if url_expiry_in_seconds is not None:
        input_["url_expiry_in_seconds"] = url_expiry_in_seconds

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