LocationService / Client / start_job

start_job

LocationService.Client.start_job(**kwargs)

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

Request Syntax

response = client.start_job(
    ClientToken='string',
    Action='ValidateAddress',
    ActionOptions={
        'ValidateAddress': {
            'AdditionalFeatures': [
                'Position'|'CountrySpecificAttributes',
            ]
        }
    },
    ExecutionRoleArn='string',
    InputOptions={
        'Location': 'string',
        'Format': 'Parquet'
    },
    Name='string',
    OutputOptions={
        'Format': 'Parquet',
        'Location': 'string'
    },
    Tags={
        'string': 'string'
    }
)

Parameters:

• ClientToken (string) –

  A unique identifier for this request to ensure idempotency.

  This field is autopopulated if not provided.

• Action (string) –

  [REQUIRED]

  The action to perform on the input data.

• ActionOptions (dict) –

  Additional parameters that can be requested for each result.

  • ValidateAddress (dict) –

    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) –

• ExecutionRoleArn (string) –

  [REQUIRED]

  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.

• InputOptions (dict) –

  [REQUIRED]

  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) – [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.

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

• Name (string) – An optional name for the job resource.

• OutputOptions (dict) –

  [REQUIRED]

  Configuration for output data location and format.

  • Format (string) – [REQUIRED]

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

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

• Tags (dict) –

  Tags and corresponding values to be associated with the job.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'CreatedAt': datetime(2015, 1, 1),
    'JobArn': 'string',
    'JobId': 'string',
    'Status': 'Pending'|'Running'|'Completed'|'Failed'|'Cancelling'|'Cancelled'
}

Response Structure

• (dict) –

  • CreatedAt (datetime) –

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

Exceptions

• LocationService.Client.exceptions.InternalServerException

• LocationService.Client.exceptions.AccessDeniedException

• LocationService.Client.exceptions.ValidationException

• LocationService.Client.exceptions.ThrottlingException