LocationService / Client / list_jobs

list_jobs

LocationService.Client.list_jobs(**kwargs)

ListJobs retrieves a list of jobs with optional filtering and pagination support.

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

See also: AWS API Documentation

Request Syntax

response = client.list_jobs(
    Filter={
        'JobStatus': 'Pending'|'Running'|'Completed'|'Failed'|'Cancelling'|'Cancelled'
    },
    MaxResults=123,
    NextToken='string'
)

Parameters:

• Filter (dict) –

  An optional structure containing criteria by which to filter job results.

  • JobStatus (string) –

    Filter by job status.

• MaxResults (integer) – Maximum number of jobs to return.

• NextToken (string) – The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • Entries (list) –

    List of jobs in your Amazon Web Services account.

    • (dict) –

      Job summary information returned in list operations.

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

      • ExecutionRoleArn (string) –

        IAM role used for job execution.

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

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

      • JobId (string) –

        Unique job identifier.

      • JobArn (string) –

        Amazon Resource Name (ARN) of the job.

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

  • NextToken (string) –

    Token for retrieving the next page (present if more results available).

Exceptions

• LocationService.Client.exceptions.InternalServerException

• LocationService.Client.exceptions.AccessDeniedException

• LocationService.Client.exceptions.ValidationException

• LocationService.Client.exceptions.ThrottlingException