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.ListJobExecutionsForThing

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the job executions for the specified thing.

Requires permission to access the ListJobExecutionsForThing action.

This operation returns paginated results.

Synopsis

Creating a Request

data ListJobExecutionsForThing Source #

See: newListJobExecutionsForThing smart constructor.

Constructors

ListJobExecutionsForThing'

Fields

jobId :: Maybe Text
The unique identifier you assigned to this job when it was created.
maxResults :: Maybe Natural
The maximum number of results to be returned 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 JobExecutionStatus
An optional filter that lets you search for jobs that have the specified status.
thingName :: Text
The thing name.

Instances

Instances details

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

newListJobExecutionsForThing Source #

Arguments

:: Text	`ListJobExecutionsForThing`
-> ListJobExecutionsForThing

Create a value of ListJobExecutionsForThing 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:

ListJobExecutionsForThing, listJobExecutionsForThing_jobId - The unique identifier you assigned to this job when it was created.

$sel:maxResults:ListJobExecutionsForThing', listJobExecutionsForThing_maxResults - The maximum number of results to be returned per request.

ListJobExecutionsForThing, listJobExecutionsForThing_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.

ListJobExecutionsForThing, listJobExecutionsForThing_nextToken - The token to retrieve the next set of results.

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

ListJobExecutionsForThing, listJobExecutionsForThing_thingName - The thing name.

Request Lenses

listJobExecutionsForThing_jobId :: Lens' ListJobExecutionsForThing (Maybe Text) Source #

The unique identifier you assigned to this job when it was created.

listJobExecutionsForThing_maxResults :: Lens' ListJobExecutionsForThing (Maybe Natural) Source #

The maximum number of results to be returned per request.

listJobExecutionsForThing_namespaceId :: Lens' ListJobExecutionsForThing (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.

listJobExecutionsForThing_nextToken :: Lens' ListJobExecutionsForThing (Maybe Text) Source #

The token to retrieve the next set of results.

listJobExecutionsForThing_status :: Lens' ListJobExecutionsForThing (Maybe JobExecutionStatus) Source #

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

listJobExecutionsForThing_thingName :: Lens' ListJobExecutionsForThing Text Source #

The thing name.

Destructuring the Response

data ListJobExecutionsForThingResponse Source #

See: newListJobExecutionsForThingResponse smart constructor.

Constructors

ListJobExecutionsForThingResponse'
Fields executionSummaries :: Maybe [JobExecutionSummaryForThing] A list of job execution summaries. 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 ListJobExecutionsForThingResponse Source #
Instance details Defined in Amazonka.IoT.ListJobExecutionsForThing Associated Types type Rep ListJobExecutionsForThingResponse :: Type -> Type # Methods from :: ListJobExecutionsForThingResponse -> Rep ListJobExecutionsForThingResponse x # to :: Rep ListJobExecutionsForThingResponse x -> ListJobExecutionsForThingResponse #
Read ListJobExecutionsForThingResponse Source #
Instance details Defined in Amazonka.IoT.ListJobExecutionsForThing Methods readsPrec :: Int -> ReadS ListJobExecutionsForThingResponse # readList :: ReadS [ListJobExecutionsForThingResponse] # readPrec :: ReadPrec ListJobExecutionsForThingResponse # readListPrec :: ReadPrec [ListJobExecutionsForThingResponse] #
Show ListJobExecutionsForThingResponse Source #
Instance details Defined in Amazonka.IoT.ListJobExecutionsForThing Methods showsPrec :: Int -> ListJobExecutionsForThingResponse -> ShowS # show :: ListJobExecutionsForThingResponse -> String # showList :: [ListJobExecutionsForThingResponse] -> ShowS #
NFData ListJobExecutionsForThingResponse Source #
Instance details Defined in Amazonka.IoT.ListJobExecutionsForThing Methods rnf :: ListJobExecutionsForThingResponse -> () #
Eq ListJobExecutionsForThingResponse Source #
Instance details Defined in Amazonka.IoT.ListJobExecutionsForThing Methods (==) :: ListJobExecutionsForThingResponse -> ListJobExecutionsForThingResponse -> Bool # (/=) :: ListJobExecutionsForThingResponse -> ListJobExecutionsForThingResponse -> Bool #
type Rep ListJobExecutionsForThingResponse Source #
Instance details Defined in Amazonka.IoT.ListJobExecutionsForThing type Rep ListJobExecutionsForThingResponse = D1 ('MetaData "ListJobExecutionsForThingResponse" "Amazonka.IoT.ListJobExecutionsForThing" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListJobExecutionsForThingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "executionSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobExecutionSummaryForThing])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListJobExecutionsForThingResponse Source #

Arguments

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

Create a value of ListJobExecutionsForThingResponse 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:executionSummaries:ListJobExecutionsForThingResponse', listJobExecutionsForThingResponse_executionSummaries - A list of job execution summaries.

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

$sel:httpStatus:ListJobExecutionsForThingResponse', listJobExecutionsForThingResponse_httpStatus - The response's http status code.

Response Lenses

listJobExecutionsForThingResponse_executionSummaries :: Lens' ListJobExecutionsForThingResponse (Maybe [JobExecutionSummaryForThing]) Source #

A list of job execution summaries.

listJobExecutionsForThingResponse_nextToken :: Lens' ListJobExecutionsForThingResponse (Maybe Text) Source #

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

listJobExecutionsForThingResponse_httpStatus :: Lens' ListJobExecutionsForThingResponse Int Source #

The response's http status code.