upload_job_paths
Creates, updates, deletes, gets or lists a upload_job_paths resource.
Overview
| Name | upload_job_paths |
| Type | Resource |
| Id | aws.customer_profiles.upload_job_paths |
Fields
The following fields are returned by SELECT queries:
- get_upload_job_path
| Name | Datatype | Description |
|---|---|---|
client_token | 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 |
url | string | The pre-signed S3 URL for uploading the CSV file associated with the upload job. (pattern: <code>.*</code>) |
valid_until | string (date-time) | The expiry timestamp for the pre-signed URL, after which the URL will no longer be valid. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_upload_job_path | select | domain_name, job_id, region | This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
domain_name | string | The unique name of the domain containing the upload job. |
job_id | string | The unique identifier of the upload job to retrieve the upload path for. This is generated from the CreateUploadJob API. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_upload_job_path
This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.
SELECT
client_token,
url,
valid_until
FROM aws.customer_profiles.upload_job_paths
WHERE domain_name = '{{ domain_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;