[ aws . location ]

get-job

Description

GetJob retrieves detailed information about a specific job, including its current status, configuration, and error information if the job failed.

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

See also: AWS API Documentation

Synopsis

  get-job
--job-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--job-id (string) [required]

The unique identifier of the job to retrieve.

Constraints:

• min: 1
• max: 200
• pattern: [-._\w]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream
• off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

Action -> (string)

Action performed by the job.

Possible values:

• ValidateAddress

ActionOptions -> (structure)

Additional options for configuring job action parameters.

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.

Constraints:

• min: 1
• max: 2

(string)

Possible values:

• Position
• CountrySpecificAttributes

CreatedAt -> (timestamp)

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

EndedAt -> (timestamp)

Job completion time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss . Only returned for jobs in a terminal status: Completed | Failed | Cancelled .

Error -> (structure)

Error information if the job failed.

Code -> (string) [required]

Error code indicating the type of error that occurred.

Possible values:

• ValidationError
• InternalServerError

Messages -> (list)

Error messages providing details about the failure.

Constraints:

• min: 1
• max: 4

(string)

Constraints:

• min: 1
• max: 200

ExecutionRoleArn -> (string)

IAM role used for permissions when running the job.

InputOptions -> (structure)

Input configuration.

Location -> (string) [required]

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.

Constraints:

• min: 0
• max: 300
• pattern: (arn:aws(-[a-z]+)*:[a-z0-9-]+:[a-z0-9-]*:(\d{12})?:[\w/+=,.-]+|s3://[a-z0-9][a-z0-9._-]{2,254}(/[^/]+)*/?)

Format -> (string) [required]

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.

Possible values:

• Parquet

JobArn -> (string)

Amazon Resource Name (ARN) of the specified job.

Constraints:

• min: 0
• max: 1600
• pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))

JobId -> (string)

Unique job identifier.

Constraints:

• min: 1
• max: 200
• pattern: [-._\w]+

Name -> (string)

Job name (if provided during creation).

Constraints:

• min: 1
• max: 100
• pattern: [-._\w]+

OutputOptions -> (structure)

Output configuration.

Format -> (string) [required]

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

Possible values:

• Parquet

Location -> (string) [required]

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.

Constraints:

• min: 0
• max: 300
• pattern: (arn:aws(-[a-z]+)*:[a-z0-9-]+:[a-z0-9-]*:(\d{12})?:[\w/+=,.-]+|s3://[a-z0-9][a-z0-9._-]{2,254}(/[^/]+)*/)

Status -> (string)

Current job status.

Possible values:

• Pending
• Running
• Completed
• Failed
• Cancelling
• Cancelled

UpdatedAt -> (timestamp)

Last update time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss .

Tags -> (map)

Tags and corresponding values associated with the specified job.

Constraints:

• min: 0
• max: 50

key -> (string)

Constraints:

• min: 1
• max: 128
• pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

value -> (string)

Constraints:

• min: 0
• max: 256
• pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)