Skip to content

Batch Get Attached File Metadata

connect_batch_get_attached_file_metadata R Documentation

Allows you to retrieve metadata about multiple attached files on an associated resource

Description

Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

Usage

connect_batch_get_attached_file_metadata(FileIds, InstanceId,
  AssociatedResourceArn)

Arguments

FileIds

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

InstanceId

[required] The unique identifier of the Connect instance.

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(
  Files = list(
    list(
      CreationTime = "string",
      FileArn = "string",
      FileId = "string",
      FileName = "string",
      FileSizeInBytes = 123,
      FileStatus = "APPROVED"|"REJECTED"|"PROCESSING"|"FAILED",
      CreatedBy = list(
        ConnectUserArn = "string",
        AWSIdentityArn = "string"
      ),
      FileUseCaseType = "ATTACHMENT",
      AssociatedResourceArn = "string",
      Tags = list(
        "string"
      )
    )
  ),
  Errors = list(
    list(
      ErrorCode = "string",
      ErrorMessage = "string",
      FileId = "string"
    )
  )
)

Request syntax

svc$batch_get_attached_file_metadata(
  FileIds = list(
    "string"
  ),
  InstanceId = "string",
  AssociatedResourceArn = "string"
)