Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartJob

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. Currently, the Jobs APIs support bulk address validation.

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

Request Syntax


POST /metadata/v0/jobs HTTP/1.1
Content-type: application/json

{
   "Action": "string",
   "ActionOptions": { 
      "ValidateAddress": { 
         "AdditionalFeatures": [ "string" ]
      }
   },
   "ClientToken": "string",
   "ExecutionRoleArn": "string",
   "InputOptions": { 
      "Format": "string",
      "Location": "string"
   },
   "Name": "string",
   "OutputOptions": { 
      "Format": "string",
      "Location": "string"
   },
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Action

The action to perform on the input data.

Type: String

Valid Values: ValidateAddress

Required: Yes

ActionOptions

Additional parameters that can be requested for each result.

Type: JobActionOptions object

Required: No

ClientToken

A unique identifier for this request to ensure idempotency.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No

ExecutionRoleArn

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

Type: String

Required: Yes

InputOptions

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.

Type: JobInputOptions object

Required: Yes

Name

An optional name for the job resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

Required: No

OutputOptions

Configuration for output data location and format.

Type: JobOutputOptions object

Required: Yes

Tags

Tags and corresponding values to be associated with the job.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": "string",
   "JobArn": "string",
   "JobId": "string",
   "Status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedAt

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

Type: Timestamp

JobArn

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

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))

JobId

Unique job identifier.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [-._\w]+

Status

Initial job status (always "Pending" for new jobs).

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

Note

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

HTTP Status Code: 400