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

ListJobs

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.

Request Syntax


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

{
   "Filter": { 
      "JobStatus": "string"
   },
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filter

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

Type: JobsFilter object

Required: No

MaxResults

Maximum number of jobs to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Entries": [ 
      { 
         "Action": "string",
         "ActionOptions": { 
            "ValidateAddress": { 
               "AdditionalFeatures": [ "string" ]
            }
         },
         "CreatedAt": "string",
         "EndedAt": "string",
         "Error": { 
            "Code": "string",
            "Messages": [ "string" ]
         },
         "ExecutionRoleArn": "string",
         "InputOptions": { 
            "Format": "string",
            "Location": "string"
         },
         "JobArn": "string",
         "JobId": "string",
         "Name": "string",
         "OutputOptions": { 
            "Format": "string",
            "Location": "string"
         },
         "Status": "string",
         "UpdatedAt": "string"
      }
   ],
   "NextToken": "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.

Entries

List of jobs in your AWS account.

Type: Array of ListJobsResponseEntry objects

NextToken

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

Type: String

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

Errors

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

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

FieldList: The field where the invalid entry was detected.
Reason: A message with the reason for the validation exception error.

HTTP Status Code: 400