GetUploadJobPath - Amazon Connect

GetUploadJobPath

This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.

Request Syntax

GET /domains/DomainName/upload-jobs/JobId/path HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain containing the upload job.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

JobId

The unique identifier of the upload job to retrieve the upload path for. This is generated from the CreateUploadJob API.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ClientToken": "string", "Url": "string", "ValidUntil": number }

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.

ClientToken

The plaintext data key used to encrypt the upload file.

To persist to the pre-signed url, use the client token and MD5 client token as header. The required headers are as follows:

  • x-amz-server-side-encryption-customer-key: Client Token

  • x-amz-server-side-encryption-customer-key-MD5: MD5 Client Token

  • x-amz-server-side-encryption-customer-algorithm: AES256

Type: String

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

Url

The pre-signed S3 URL for uploading the CSV file associated with the upload job.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: .*

ValidUntil

The expiry timestamp for the pre-signed URL, after which the URL will no longer be valid.

Type: Timestamp

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: