upload_jobs

Creates, updates, deletes, gets or lists a upload_jobs resource.

Overview

Name	upload_jobs
Type	Resource
Id	aws.customer_profiles.upload_jobs

Fields

The following fields are returned by SELECT queries:

get_upload_job

Name	Datatype	Description
completed_at	string (date-time)	The timestamp when the upload job was completed.
created_at	string (date-time)	The timestamp when the upload job was created.
data_expiry	integer	The expiry duration for the profiles ingested with the upload job.
display_name	string	The unique name of the upload job. Could be a file name to identify the upload job.
fields	object	The mapping between CSV Columns and Profile Object attributes for the upload job.
job_id	string	The unique identifier of the upload job. (pattern: <code>[a-f0-9]{32}</code>)
results_summary	object	The summary of results for the upload job, including the number of updated, created, and failed records.
status	string	The status describing the status for the upload job. The following are Valid Values: CREATED: The upload job has been created, but has not started processing yet. IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data. PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data. SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data. FAILED: The upload job has failed to complete. STOPPED: The upload job has been manually stopped or terminated before completion. (CREATED, IN_PROGRESS, PARTIALLY_SUCCEEDED, SUCCEEDED, FAILED, STOPPED)
status_reason	string	The reason for the current status of the upload job. Possible reasons: VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion. INTERNAL_FAILURE: Failure caused from service side (VALIDATION_FAILURE, INTERNAL_FAILURE)
unique_key	string	The unique key columns used for de-duping the keys in the upload job.

list_upload_jobs

Name	Datatype	Description
completed_at	string (date-time)	The timestamp when the upload job was completed.
created_at	string (date-time)	The timestamp when the upload job was created.
data_expiry	integer	The expiry duration for the profiles ingested with the upload job.
display_name	string	The name of the upload job.
job_id	string	The unique identifier of the upload job. (pattern: <code>[a-f0-9]{32}</code>)
status	string	The current status of the upload job. (CREATED, IN_PROGRESS, PARTIALLY_SUCCEEDED, SUCCEEDED, FAILED, STOPPED)
status_reason	string	The reason for the current status of the upload job. (VALIDATION_FAILURE, INTERNAL_FAILURE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_upload_job	select	domain_name, job_id, region		This API retrieves the details of a specific upload job.
list_upload_jobs	select	domain_name, region	max-results, next-token	This API retrieves a list of upload jobs for the specified domain.
create_upload_job	insert	domain_name, region, DisplayName, UniqueKey		Creates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key.

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. Domain should be exists for the upload job to be created.
job_id	string	The unique identifier of the upload job to retrieve.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of upload jobs to return per page.
next-token	string	The pagination token from the previous call to retrieve the next page of results.

SELECT examples

get_upload_job

This API retrieves the details of a specific upload job.

SELECT
completed_at,
created_at,
data_expiry,
display_name,
fields,
job_id,
results_summary,
status,
status_reason,
unique_key
FROM aws.customer_profiles.upload_jobs
WHERE domain_name = '{{ domain_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_upload_jobs

This API retrieves a list of upload jobs for the specified domain.

SELECT
completed_at,
created_at,
data_expiry,
display_name,
job_id,
status,
status_reason
FROM aws.customer_profiles.upload_jobs
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_upload_job

Creates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key.

INSERT INTO aws.customer_profiles.upload_jobs (
DisplayName,
Fields,
UniqueKey,
DataExpiry,
domain_name,
region
)
SELECT 
'{{ DisplayName }}' /* required */,
'{{ Fields }}',
'{{ UniqueKey }}' /* required */,
{{ DataExpiry }},
'{{ domain_name }}',
'{{ region }}'
RETURNING
job_id
;

Manifest

# Description fields are for documentation purposes
- name: upload_jobs
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the upload_jobs resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the upload_jobs resource.
  - name: DisplayName
    value: "{{ DisplayName }}"
  - name: Fields
    value: "{{ Fields }}"
  - name: UniqueKey
    value: "{{ UniqueKey }}"
  - name: DataExpiry
    value: {{ DataExpiry }}