CustomerProfiles / Client / create_upload_job

create_upload_job

CustomerProfiles.Client.create_upload_job(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_upload_job(
    DomainName='string',
    DisplayName='string',
    Fields={
        'string': {
            'Source': 'string',
            'Target': 'string',
            'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
        }
    },
    UniqueKey='string',
    DataExpiry=123
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain. Domain should be exists for the upload job to be created.

  • DisplayName (string) –

    [REQUIRED]

    The unique name of the upload job. Could be a file name to identify the upload job.

  • Fields (dict) –

    [REQUIRED]

    The mapping between CSV Columns and Profile Object attributes. A map of the name and ObjectType field.

    • (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) –

    [REQUIRED]

    The unique key columns for de-duping the profiles used to map data to the profile.

  • DataExpiry (integer) – The expiry duration for the profiles ingested with the job. If not provided, the system default of 2 weeks is used.

Return type:

dict

Returns:

Response Syntax

{
    'JobId': 'string'
}

Response Structure

  • (dict) –

    • JobId (string) –

      The unique identifier for the created upload job.

Exceptions