Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . customer-profiles ]
create-upload-job¶
Description¶
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
Synopsis¶
create-upload-job
--domain-name <value>
--display-name <value>
--fields <value>
--unique-key <value>
[--data-expiry <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--domain-name (string)
The unique name of the domain. Domain should be exists for the upload job to be created.
--display-name (string)
The unique name of the upload job. Could be a file name to identify the upload job.
--fields (map)
The mapping between CSV Columns and Profile Object attributes. A map of the name and ObjectType field.
key -> (string)
value -> (structure)
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.
Shorthand Syntax:
KeyName1=Source=string,Target=string,ContentType=string,KeyName2=Source=string,Target=string,ContentType=string
JSON Syntax:
{"string": {
"Source": "string",
"Target": "string",
"ContentType": "STRING"|"NUMBER"|"PHONE_NUMBER"|"EMAIL_ADDRESS"|"NAME"
}
...}
--unique-key (string)
The unique key columns for de-duping the profiles used to map data to the profile.
--data-expiry (integer)
The expiry duration for the profiles ingested with the job. If not provided, the system default of 2 weeks is used.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.