ListClusterJobs
Returns an array of JobListEntry
objects of the specified length. Each
JobListEntry
object is for a job in the specified cluster and contains a job's
state, a job's ID, and other information.
Request Syntax
{
"ClusterId": "string
",
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClusterId
-
The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000
.Type: String
Length Constraints: Fixed length of 39.
Pattern:
CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Required: Yes
- MaxResults
-
The number of
JobListEntry
objects to return.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- NextToken
-
HTTP requests are stateless. To identify what object comes "next" in the list of
JobListEntry
objects, you have the option of specifyingNextToken
as the starting point for your returned list.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*
Required: No
Response Syntax
{
"JobListEntries": [
{
"CreationDate": number,
"Description": "string",
"IsMaster": boolean,
"JobId": "string",
"JobState": "string",
"JobType": "string",
"SnowballType": "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.
- JobListEntries
-
Each
JobListEntry
object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.Type: Array of JobListEntry objects
- NextToken
-
HTTP requests are stateless. If you use the automatically generated
NextToken
value in your nextListClusterJobsResult
call, your list of returned jobs will start from this point in the array.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextTokenException
-
The
NextToken
string was altered unexpectedly, and the operation has stopped. Run the operation without changing theNextToken
string, and try again.HTTP Status Code: 400
- InvalidResourceException
-
The specified resource can't be found. Check the information you provided in your last request, and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: