Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Lists jobs.
Synopsis
- listJobs :: ListJobs
- data ListJobs
- ljStatus :: Lens' ListJobs (Maybe JobStatus)
- ljThingGroupId :: Lens' ListJobs (Maybe Text)
- ljNextToken :: Lens' ListJobs (Maybe Text)
- ljThingGroupName :: Lens' ListJobs (Maybe Text)
- ljMaxResults :: Lens' ListJobs (Maybe Natural)
- ljTargetSelection :: Lens' ListJobs (Maybe TargetSelection)
- listJobsResponse :: Int -> ListJobsResponse
- data ListJobsResponse
- ljrsJobs :: Lens' ListJobsResponse [JobSummary]
- ljrsNextToken :: Lens' ListJobsResponse (Maybe Text)
- ljrsResponseStatus :: Lens' ListJobsResponse Int
Creating a Request
Creates a value of ListJobs
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ljStatus
- An optional filter that lets you search for jobs that have the specified status.ljThingGroupId
- A filter that limits the returned jobs to those for the specified group.ljNextToken
- The token to retrieve the next set of results.ljThingGroupName
- A filter that limits the returned jobs to those for the specified group.ljMaxResults
- The maximum number of results to return per request.ljTargetSelection
- Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
See: listJobs
smart constructor.
Instances
Request Lenses
ljStatus :: Lens' ListJobs (Maybe JobStatus) Source #
An optional filter that lets you search for jobs that have the specified status.
ljThingGroupId :: Lens' ListJobs (Maybe Text) Source #
A filter that limits the returned jobs to those for the specified group.
ljThingGroupName :: Lens' ListJobs (Maybe Text) Source #
A filter that limits the returned jobs to those for the specified group.
ljMaxResults :: Lens' ListJobs (Maybe Natural) Source #
The maximum number of results to return per request.
ljTargetSelection :: Lens' ListJobs (Maybe TargetSelection) Source #
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
Destructuring the Response
Creates a value of ListJobsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ljrsJobs
- A list of jobs.ljrsNextToken
- The token for the next set of results, or null if there are no additional results.ljrsResponseStatus
- -- | The response status code.
data ListJobsResponse Source #
See: listJobsResponse
smart constructor.
Instances
Response Lenses
ljrsJobs :: Lens' ListJobsResponse [JobSummary] Source #
A list of jobs.
ljrsNextToken :: Lens' ListJobsResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
ljrsResponseStatus :: Lens' ListJobsResponse Int Source #
- - | The response status code.