AWS CLI Command Reference

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 ]

get-upload-job

Description

This API retrieves the details of a specific upload job.

See also: AWS API Documentation

Synopsis

  get-upload-job
--domain-name <value>
--job-id <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 containing the upload job.

--job-id (string)

The unique identifier of the upload job to retrieve.

--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.

Output

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 -> (timestamp)

The timestamp when the upload job was created.

CompletedAt -> (timestamp)

The timestamp when the upload job was completed.

Fields -> (map)

The mapping between CSV Columns and Profile Object attributes for the upload job.

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.

UniqueKey -> (string)

The unique key columns used for de-duping the keys in the upload job.

ResultsSummary -> (structure)

The summary of results for the upload job, including the number of updated, created, and failed records.

UpdatedRecords -> (long)

The number of records that were updated during the upload job.

CreatedRecords -> (long)

The number of records that were newly created during the upload job.

FailedRecords -> (long)

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.