AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . location ]

start-job

Description

StartJob starts a new asynchronous bulk processing job. You specify the input data location in Amazon S3, the action to perform, and the output location where results are written.

For more information, see Job concepts in the Amazon Location Service Developer Guide .

See also: AWS API Documentation

Synopsis

  start-job
[--client-token <value>]
--action <value>
[--action-options <value>]
--execution-role-arn <value>
--input-options <value>
[--name <value>]
--output-options <value>
[--tags <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>]
[--v2-debug]

Options

--client-token (string)

A unique identifier for this request to ensure idempotency.

--action (string)

The action to perform on the input data.

Possible values:

  • ValidateAddress

--action-options (structure)

Additional parameters that can be requested for each result.

ValidateAddress -> (structure)

Options specific to address validation jobs.

AdditionalFeatures -> (list)

A list of optional additional parameters that can be requested for each result.

Values:

  • Position - Return the position coordinates of the address if available.
  • CountrySpecificAttributes - Return additional information about the address specific to the country of origin.

(string)

Shorthand Syntax:

ValidateAddress={AdditionalFeatures=[string,string]}

JSON Syntax:

{
  "ValidateAddress": {
    "AdditionalFeatures": ["Position"|"CountrySpecificAttributes", ...]
  }
}

--execution-role-arn (string)

The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.

Note

The IAM role must be created in the same Amazon Web Services account where you plan to run your job.

For more information about configuring IAM roles for Amazon Location jobs, see Configure IAM permissions in the Amazon Location Service Developer Guide .

--input-options (structure)

Configuration for input data location and format.

Note

Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.

Location -> (string)

S3 ARN or URI where input files are stored.

Note

The Amazon S3 bucket must be created in the same Amazon Web Services region where you plan to run your job.

Format -> (string)

Input data format. Currently only Parquet is supported.

Note

Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.

Shorthand Syntax:

Location=string,Format=string

JSON Syntax:

{
  "Location": "string",
  "Format": "Parquet"
}

--name (string)

An optional name for the job resource.

--output-options (structure)

Configuration for output data location and format.

Format -> (string)

Output data format. Currently only “Parquet” is supported.

Location -> (string)

S3 ARN or URI where output files will be written.

Note

The Amazon S3 bucket must exist in the same Amazon Web Services region where you plan to run your job.

Shorthand Syntax:

Format=string,Location=string

JSON Syntax:

{
  "Format": "Parquet",
  "Location": "string"
}

--tags (map)

Tags and corresponding values to be associated with the job.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

CreatedAt -> (timestamp)

Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss .

JobArn -> (string)

The Amazon Resource Name (ARN) for the job resource. Used when you need to specify a resource across all Amazon Web Services.

Format example: arn:aws:geo:region:account-id:job/ExampleJob

JobId -> (string)

Unique job identifier.

Status -> (string)

Initial job status (always “Pending” for new jobs).