GetFileUploadURL

Description

The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. For information about the FileUploadAnswer answer, see QuestionForm.

The temporary URL is generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds.

[Note]Note

URL expiration allows your application to retrieve the file without credentials, but still retain control over who can access your data, because you need an access key ID and signature to get the temporary URL. If you need to retrieve the file after the URL has expired, call GetFileUploadURL again to get a new URL.

You can get a temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are deleted, and cannot be retrieved.

Request Parameters

The GetFileUploadURL operation accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.

The following parameters are specific to the GetFileUploadURL operation:

NameDescriptionRequired

Operation

The name of the operation

Type: String

Valid Values: GetFileUploadURL

Default: None

Yes

AssignmentId

The ID of the assignment that contains the question with a FileUploadAnswer.

Type: String

Default: None

Yes

QuestionIdentifier

The identifier of the question with a FileUploadAnswer, as specified in the QuestionForm of the HIT.

Type: String

Default: None

Yes

Response Elements

A successful request for the GetFileUploadURL operation has a GetFileUploadURLResult element in the response.

The GetFileUploadURLResult element includes the elements described in the following table.

NameDescription

FileUploadURL

A temporary URL for the file that the Worker uploaded for the answer.

Type: URL

Examples

The following example shows how to use the GetFileUploadURL operation.

Sample Request

The following example of a call to the GetFileUploadURL operation retrieves the temporary URL for a file-upload answer to the given question in the given assignment.

http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2008-08-02
&Operation=GetFileUploadURL
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&AssignmentId=123RVWYBAZW00EXAMPLE456RVWYBAZW00EXAMPLE
&QuestionIdentifier=ReadAloudAudio
            

Sample Response

The following is an example response.

<GetFileUploadURLResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
  <FileUploadURL>http://s3.amazonaws.com/TestAnswers/puppy.jpg</FileUploadURL>
</GetFileUploadURLResult>