Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchGetAttachedFileMetadata

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.

Request Syntax


POST /attached-files/InstanceId?associatedResourceArn=AssociatedResourceArn HTTP/1.1
Content-type: application/json

{
   "FileIds": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

AssociatedResourceArn

The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email.

Note

This value must be a valid ARN.

Required: Yes

InstanceId

The unique identifier of the Connect instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

FileIds

The unique identifiers of the attached file resource.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "FileId": "string"
      }
   ],
   "Files": [ 
      { 
         "AssociatedResourceArn": "string",
         "CreatedBy": { ... },
         "CreationTime": "string",
         "FileArn": "string",
         "FileId": "string",
         "FileName": "string",
         "FileSizeInBytes": number,
         "FileStatus": "string",
         "FileUseCaseType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

List of errors of attached files that could not be retrieved.

Type: Array of AttachedFileError objects

Files

List of attached files that were successfully retrieved.

Type: Array of AttachedFile objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429