ListEarthObservationJobs
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon account.
Request Syntax
POST /list-earth-observation-jobs HTTP/1.1
Content-type: application/json
{
"MaxResults": number
,
"NextToken": "string
",
"SortBy": "string
",
"SortOrder": "string
",
"StatusEquals": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- MaxResults
-
The total number of items to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
- NextToken
-
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Required: No
- SortBy
-
The parameter by which to sort the results.
Type: String
Required: No
- SortOrder
-
An optional value that specifies whether you want the results sorted in
Ascending
orDescending
order.Type: String
Valid Values:
ASCENDING | DESCENDING
Required: No
- StatusEquals
-
A filter that retrieves only jobs with a specific status.
Type: String
Valid Values:
INITIALIZING | IN_PROGRESS | STOPPING | COMPLETED | STOPPED | FAILED | DELETING | DELETED
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EarthObservationJobSummaries": [
{
"Arn": "string",
"CreationTime": "string",
"DurationInSeconds": number,
"Name": "string",
"OperationType": "string",
"Status": "string",
"Tags": {
"string" : "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.
- EarthObservationJobSummaries
-
Contains summary information about the Earth Observation jobs.
Type: Array of ListEarthObservationJobOutputConfig objects
- NextToken
-
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource which does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: