CustomerProfiles / Client / get_upload_job_path

get_upload_job_path

CustomerProfiles.Client.get_upload_job_path(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_upload_job_path(
    DomainName='string',
    JobId='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain containing the upload job.

  • JobId (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Url': 'string',
    'ClientToken': 'string',
    'ValidUntil': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • Url (string) –

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

    • ClientToken (string) –

      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

    • ValidUntil (datetime) –

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

Exceptions