| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Snowball.ListClusterJobs
Description
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.
This operation returns paginated results.
Synopsis
- data ListClusterJobs = ListClusterJobs' {}
- newListClusterJobs :: Text -> ListClusterJobs
- listClusterJobs_nextToken :: Lens' ListClusterJobs (Maybe Text)
- listClusterJobs_maxResults :: Lens' ListClusterJobs (Maybe Natural)
- listClusterJobs_clusterId :: Lens' ListClusterJobs Text
- data ListClusterJobsResponse = ListClusterJobsResponse' {
- jobListEntries :: Maybe [JobListEntry]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListClusterJobsResponse :: Int -> ListClusterJobsResponse
- listClusterJobsResponse_jobListEntries :: Lens' ListClusterJobsResponse (Maybe [JobListEntry])
- listClusterJobsResponse_nextToken :: Lens' ListClusterJobsResponse (Maybe Text)
- listClusterJobsResponse_httpStatus :: Lens' ListClusterJobsResponse Int
Creating a Request
data ListClusterJobs Source #
See: newListClusterJobs smart constructor.
Constructors
| ListClusterJobs' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListClusterJobs |
Create a value of ListClusterJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListClusterJobs', listClusterJobs_nextToken - HTTP requests are stateless. To identify what object comes "next" in
the list of JobListEntry objects, you have the option of specifying
NextToken as the starting point for your returned list.
$sel:maxResults:ListClusterJobs', listClusterJobs_maxResults - The number of JobListEntry objects to return.
$sel:clusterId:ListClusterJobs', listClusterJobs_clusterId - The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000.
Request Lenses
listClusterJobs_nextToken :: Lens' ListClusterJobs (Maybe Text) Source #
HTTP requests are stateless. To identify what object comes "next" in
the list of JobListEntry objects, you have the option of specifying
NextToken as the starting point for your returned list.
listClusterJobs_maxResults :: Lens' ListClusterJobs (Maybe Natural) Source #
The number of JobListEntry objects to return.
listClusterJobs_clusterId :: Lens' ListClusterJobs Text Source #
The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000.
Destructuring the Response
data ListClusterJobsResponse Source #
See: newListClusterJobsResponse smart constructor.
Constructors
| ListClusterJobsResponse' | |
Fields
| |
Instances
newListClusterJobsResponse Source #
Create a value of ListClusterJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobListEntries:ListClusterJobsResponse', listClusterJobsResponse_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.
$sel:nextToken:ListClusterJobs', listClusterJobsResponse_nextToken - HTTP requests are stateless. If you use the automatically generated
NextToken value in your next ListClusterJobsResult call, your list
of returned jobs will start from this point in the array.
$sel:httpStatus:ListClusterJobsResponse', listClusterJobsResponse_httpStatus - The response's http status code.
Response Lenses
listClusterJobsResponse_jobListEntries :: Lens' ListClusterJobsResponse (Maybe [JobListEntry]) Source #
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.
listClusterJobsResponse_nextToken :: Lens' ListClusterJobsResponse (Maybe Text) Source #
HTTP requests are stateless. If you use the automatically generated
NextToken value in your next ListClusterJobsResult call, your list
of returned jobs will start from this point in the array.
listClusterJobsResponse_httpStatus :: Lens' ListClusterJobsResponse Int Source #
The response's http status code.