Get Attached File

connect_get_attached_file

R Documentation

Provides a pre-signed URL for download of an approved attached file¶

Description¶

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.

Usage¶

connect_get_attached_file(InstanceId, FileId, UrlExpiryInSeconds,
  AssociatedResourceArn)

Arguments¶

InstanceId

[required] The unique identifier of the Connect instance.

FileId

[required] The unique identifier of the attached file resource.

UrlExpiryInSeconds

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

AssociatedResourceArn

[required] The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

This value must be a valid ARN.

Value¶

A list with the following syntax:

list(
  FileArn = "string",
  FileId = "string",
  CreationTime = "string",
  FileStatus = "APPROVED"|"REJECTED"|"PROCESSING"|"FAILED",
  FileName = "string",
  FileSizeInBytes = 123,
  AssociatedResourceArn = "string",
  FileUseCaseType = "ATTACHMENT",
  CreatedBy = list(
    ConnectUserArn = "string",
    AWSIdentityArn = "string"
  ),
  DownloadUrlMetadata = list(
    Url = "string",
    UrlExpiry = "string"
  ),
  Tags = list(
    "string"
  )
)

Request syntax¶

svc$get_attached_file(
  InstanceId = "string",
  FileId = "string",
  UrlExpiryInSeconds = 123,
  AssociatedResourceArn = "string"
)