CustomerProfiles / Client / get_upload_job

get_upload_job¶

CustomerProfiles.Client.get_upload_job(**kwargs)¶

This API retrieves the details of a specific upload job.

Request Syntax

response = client.get_upload_job(
    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.

Return type:

dict

Returns:

Response Syntax

{
    'JobId': 'string',
    'DisplayName': 'string',
    'Status': 'CREATED'|'IN_PROGRESS'|'PARTIALLY_SUCCEEDED'|'SUCCEEDED'|'FAILED'|'STOPPED',
    'StatusReason': 'VALIDATION_FAILURE'|'INTERNAL_FAILURE',
    'CreatedAt': datetime(2015, 1, 1),
    'CompletedAt': datetime(2015, 1, 1),
    'Fields': {
        'string': {
            'Source': 'string',
            'Target': 'string',
            'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
        }
    },
    'UniqueKey': 'string',
    'ResultsSummary': {
        'UpdatedRecords': 123,
        'CreatedRecords': 123,
        'FailedRecords': 123
    },
    'DataExpiry': 123
}

Response Structure

(dict) –
- JobId (string) –
  
  The unique identifier of the upload job.
- DisplayName (string) –
  
  The unique name of the upload job. Could be a file name to identify the upload job.
- 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.
- StatusReason (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
- CreatedAt (datetime) –
  
  The timestamp when the upload job was created.
- CompletedAt (datetime) –
  
  The timestamp when the upload job was completed.
- Fields (dict) –
  
  The mapping between CSV Columns and Profile Object attributes for the upload job.
  - (string) –
    - (dict) –
      
      Represents a field in a ProfileObjectType.
      - Source (string) –
        
        A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
      - Target (string) –
        
        The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
      - ContentType (string) –
        
        The content type of the field. Used for determining equality when searching.
- UniqueKey (string) –
  
  The unique key columns used for de-duping the keys in the upload job.
- ResultsSummary (dict) –
  
  The summary of results for the upload job, including the number of updated, created, and failed records.
  - UpdatedRecords (integer) –
    
    The number of records that were updated during the upload job.
  - CreatedRecords (integer) –
    
    The number of records that were newly created during the upload job.
  - FailedRecords (integer) –
    
    The number of records that failed to be processed during the upload job.
- DataExpiry (integer) –
  
  The expiry duration for the profiles ingested with the upload job.

Exceptions

CustomerProfiles.Client.exceptions.ResourceNotFoundException
CustomerProfiles.Client.exceptions.InternalServerException
CustomerProfiles.Client.exceptions.BadRequestException
CustomerProfiles.Client.exceptions.ThrottlingException
CustomerProfiles.Client.exceptions.AccessDeniedException