# ListJobs
<a name="API_geojobs_ListJobs"></a>

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

For more information, see [Job concepts](https://docs.aws.amazon.com/location/latest/developerguide/jobs-concepts.html) in the *Amazon Location Service Developer Guide*.

## Request Syntax
<a name="API_geojobs_ListJobs_RequestSyntax"></a>

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

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

## URI Request Parameters
<a name="API_geojobs_ListJobs_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_geojobs_ListJobs_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Filter](#API_geojobs_ListJobs_RequestSyntax) **   <a name="location-geojobs_ListJobs-request-Filter"></a>
An optional structure containing criteria by which to filter job results.  
Type: [JobsFilter](API_geojobs_JobsFilter.md) object  
Required: No

 ** [MaxResults](#API_geojobs_ListJobs_RequestSyntax) **   <a name="location-geojobs_ListJobs-request-MaxResults"></a>
Maximum number of jobs to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_geojobs_ListJobs_RequestSyntax) **   <a name="location-geojobs_ListJobs-request-NextToken"></a>
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
<a name="API_geojobs_ListJobs_ResponseSyntax"></a>

```
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
<a name="API_geojobs_ListJobs_ResponseElements"></a>

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](#API_geojobs_ListJobs_ResponseSyntax) **   <a name="location-geojobs_ListJobs-response-Entries"></a>
List of jobs in your AWS account.  
Type: Array of [ListJobsResponseEntry](API_geojobs_ListJobsResponseEntry.md) objects

 ** [NextToken](#API_geojobs_ListJobs_ResponseSyntax) **   <a name="location-geojobs_ListJobs-response-NextToken"></a>
Token for retrieving the next page (present if more results available).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 60000.

## Errors
<a name="API_geojobs_ListJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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.  
Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.
HTTP Status Code: 400

## See Also
<a name="API_geojobs_ListJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geojobs-2020-11-19/ListJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geojobs-2020-11-19/ListJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geojobs-2020-11-19/ListJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geojobs-2020-11-19/ListJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geojobs-2020-11-19/ListJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geojobs-2020-11-19/ListJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geojobs-2020-11-19/ListJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geojobs-2020-11-19/ListJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geojobs-2020-11-19/ListJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geojobs-2020-11-19/ListJobs)