get_job¶

LocationService.Client.get_job(**kwargs)¶

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.

Request Syntax

response = client.get_job(
    JobId='string'
)

Parameters:

JobId (string) –

[REQUIRED]

The unique identifier of the job to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Action': 'ValidateAddress',
    'ActionOptions': {
        'ValidateAddress': {
            'AdditionalFeatures': [
                'Position'|'CountrySpecificAttributes',
            ]
        }
    },
    'CreatedAt': datetime(2015, 1, 1),
    'EndedAt': datetime(2015, 1, 1),
    'Error': {
        'Code': 'ValidationError'|'InternalServerError',
        'Messages': [
            'string',
        ]
    },
    'ExecutionRoleArn': 'string',
    'InputOptions': {
        'Location': 'string',
        'Format': 'Parquet'
    },
    'JobArn': 'string',
    'JobId': 'string',
    'Name': 'string',
    'OutputOptions': {
        'Format': 'Parquet',
        'Location': 'string'
    },
    'Status': 'Pending'|'Running'|'Completed'|'Failed'|'Cancelling'|'Cancelled',
    'UpdatedAt': datetime(2015, 1, 1),
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- Action (string) –
  
  Action performed by the job.
- ActionOptions (dict) –
  
  Additional options for configuring job action parameters.
  - 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) –
- CreatedAt (datetime) –
  
  Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.
- EndedAt (datetime) –
  
  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 (dict) –
  
  Error information if the job failed.
  - Code (string) –
    
    Error code indicating the type of error that occurred.
  - Messages (list) –
    
    Error messages providing details about the failure.
    - (string) –
- ExecutionRoleArn (string) –
  
  IAM role used for permissions when running the job.
- InputOptions (dict) –
  
  Input configuration.
  - 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.
- JobArn (string) –
  
  Amazon Resource Name (ARN) of the specified job.
- JobId (string) –
  
  Unique job identifier.
- Name (string) –
  
  Job name (if provided during creation).
- OutputOptions (dict) –
  
  Output configuration.
  - 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.
- Status (string) –
  
  Current job status.
- UpdatedAt (datetime) –
  
  Last update time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.
- Tags (dict) –
  
  Tags and corresponding values associated with the specified job.
  - (string) –
    - (string) –

Exceptions

LocationService.Client.exceptions.InternalServerException
LocationService.Client.exceptions.ResourceNotFoundException
LocationService.Client.exceptions.AccessDeniedException
LocationService.Client.exceptions.ValidationException
LocationService.Client.exceptions.ThrottlingException