Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoT.ListJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists jobs.

Requires permission to access the ListJobs action.

This operation returns paginated results.

Synopsis

data ListJobs = ListJobs' {
- maxResults :: Maybe Natural
- namespaceId :: Maybe Text
- nextToken :: Maybe Text
- status :: Maybe JobStatus
- targetSelection :: Maybe TargetSelection
- thingGroupId :: Maybe Text
- thingGroupName :: Maybe Text
}
newListJobs :: ListJobs
listJobs_maxResults :: Lens' ListJobs (Maybe Natural)
listJobs_namespaceId :: Lens' ListJobs (Maybe Text)
listJobs_nextToken :: Lens' ListJobs (Maybe Text)
listJobs_status :: Lens' ListJobs (Maybe JobStatus)
listJobs_targetSelection :: Lens' ListJobs (Maybe TargetSelection)
listJobs_thingGroupId :: Lens' ListJobs (Maybe Text)
listJobs_thingGroupName :: Lens' ListJobs (Maybe Text)
data ListJobsResponse = ListJobsResponse' {
- jobs :: Maybe [JobSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListJobsResponse :: Int -> ListJobsResponse
listJobsResponse_jobs :: Lens' ListJobsResponse (Maybe [JobSummary])
listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)
listJobsResponse_httpStatus :: Lens' ListJobsResponse Int

Creating a Request

data ListJobs Source #

See: newListJobs smart constructor.

Constructors

ListJobs'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per request.
namespaceId :: Maybe Text
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
nextToken :: Maybe Text
The token to retrieve the next set of results.
status :: Maybe JobStatus
An optional filter that lets you search for jobs that have the specified status.
targetSelection :: Maybe TargetSelection
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.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
thingGroupId :: Maybe Text
A filter that limits the returned jobs to those for the specified group.
thingGroupName :: Maybe Text
A filter that limits the returned jobs to those for the specified group.

Instances

Instances details

ToHeaders ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods toHeaders :: ListJobs -> [Header] #
ToPath ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods toPath :: ListJobs -> ByteString #
ToQuery ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods toQuery :: ListJobs -> QueryString #
AWSPager ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods page :: ListJobs -> AWSResponse ListJobs -> Maybe ListJobs #
AWSRequest ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Associated Types type AWSResponse ListJobs # Methods request :: (Service -> Service) -> ListJobs -> Request ListJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListJobs))) #
Generic ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Associated Types type Rep ListJobs :: Type -> Type # Methods from :: ListJobs -> Rep ListJobs x # to :: Rep ListJobs x -> ListJobs #
Read ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods readsPrec :: Int -> ReadS ListJobs # readList :: ReadS [ListJobs] # readPrec :: ReadPrec ListJobs # readListPrec :: ReadPrec [ListJobs] #
Show ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods showsPrec :: Int -> ListJobs -> ShowS # show :: ListJobs -> String # showList :: [ListJobs] -> ShowS #
NFData ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods rnf :: ListJobs -> () #
Eq ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods (==) :: ListJobs -> ListJobs -> Bool # (/=) :: ListJobs -> ListJobs -> Bool #
Hashable ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods hashWithSalt :: Int -> ListJobs -> Int # hash :: ListJobs -> Int #
type AWSResponse ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs type AWSResponse ListJobs = ListJobsResponse
type Rep ListJobs Source #
Instance details Defined in Amazonka.IoT.ListJobs type Rep ListJobs = D1 ('MetaData "ListJobs" "Amazonka.IoT.ListJobs" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "namespaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :: S1 ('MetaSel ('Just "targetSelection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetSelection))) :: (S1 ('MetaSel ('Just "thingGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "thingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListJobs :: ListJobs Source #

Create a value of ListJobs 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:maxResults:ListJobs', listJobs_maxResults - The maximum number of results to return per request.

ListJobs, listJobs_namespaceId - The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

ListJobs, listJobs_nextToken - The token to retrieve the next set of results.

ListJobs, listJobs_status - An optional filter that lets you search for jobs that have the specified status.

ListJobs, listJobs_targetSelection - 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.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

ListJobs, listJobs_thingGroupId - A filter that limits the returned jobs to those for the specified group.

ListJobs, listJobs_thingGroupName - A filter that limits the returned jobs to those for the specified group.

Request Lenses

listJobs_maxResults :: Lens' ListJobs (Maybe Natural) Source #

The maximum number of results to return per request.

listJobs_namespaceId :: Lens' ListJobs (Maybe Text) Source #

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #

The token to retrieve the next set of results.

listJobs_status :: Lens' ListJobs (Maybe JobStatus) Source #

An optional filter that lets you search for jobs that have the specified status.

listJobs_targetSelection :: 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.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

listJobs_thingGroupId :: Lens' ListJobs (Maybe Text) Source #

A filter that limits the returned jobs to those for the specified group.

listJobs_thingGroupName :: Lens' ListJobs (Maybe Text) Source #

A filter that limits the returned jobs to those for the specified group.

Destructuring the Response

data ListJobsResponse Source #

See: newListJobsResponse smart constructor.

Constructors

ListJobsResponse'
Fields jobs :: Maybe [JobSummary] A list of jobs. nextToken :: Maybe Text The token for the next set of results, or null if there are no additional results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListJobsResponse Source #
Instance details Defined in Amazonka.IoT.ListJobs Associated Types type Rep ListJobsResponse :: Type -> Type # Methods from :: ListJobsResponse -> Rep ListJobsResponse x # to :: Rep ListJobsResponse x -> ListJobsResponse #
Read ListJobsResponse Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods readsPrec :: Int -> ReadS ListJobsResponse # readList :: ReadS [ListJobsResponse] # readPrec :: ReadPrec ListJobsResponse # readListPrec :: ReadPrec [ListJobsResponse] #
Show ListJobsResponse Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods showsPrec :: Int -> ListJobsResponse -> ShowS # show :: ListJobsResponse -> String # showList :: [ListJobsResponse] -> ShowS #
NFData ListJobsResponse Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods rnf :: ListJobsResponse -> () #
Eq ListJobsResponse Source #
Instance details Defined in Amazonka.IoT.ListJobs Methods (==) :: ListJobsResponse -> ListJobsResponse -> Bool # (/=) :: ListJobsResponse -> ListJobsResponse -> Bool #
type Rep ListJobsResponse Source #
Instance details Defined in Amazonka.IoT.ListJobs type Rep ListJobsResponse = D1 ('MetaData "ListJobsResponse" "Amazonka.IoT.ListJobs" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListJobsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListJobsResponse'`
-> ListJobsResponse

Create a value of ListJobsResponse 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:jobs:ListJobsResponse', listJobsResponse_jobs - A list of jobs.

ListJobs, listJobsResponse_nextToken - The token for the next set of results, or null if there are no additional results.

$sel:httpStatus:ListJobsResponse', listJobsResponse_httpStatus - The response's http status code.

Response Lenses

listJobsResponse_jobs :: Lens' ListJobsResponse (Maybe [JobSummary]) Source #

A list of jobs.

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #

The response's http status code.