libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.ListJobExecutionsForThing

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

  • status :: Maybe JobExecutionStatus

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

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

  • maxResults :: Maybe Natural

    The maximum number of results to be returned per request.

  • thingName :: Text

    The thing name.

Instances

Instances details
Eq ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

Read ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

Show ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

Generic ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

Associated Types

type Rep ListJobExecutionsForThing :: Type -> Type #

NFData ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

Hashable ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

AWSPager ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

AWSRequest ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

ToHeaders ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

ToPath ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

ToQuery ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

type Rep ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

type Rep ListJobExecutionsForThing = D1 ('MetaData "ListJobExecutionsForThing" "Amazonka.IoT.ListJobExecutionsForThing" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "ListJobExecutionsForThing'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionStatus)) :*: S1 ('MetaSel ('Just "namespaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListJobExecutionsForThing Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

newListJobExecutionsForThing Source #

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:

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

$sel:namespaceId: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.

$sel:nextToken:ListJobExecutionsForThing', listJobExecutionsForThing_nextToken - The token to retrieve the next set of results.

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

$sel:thingName:ListJobExecutionsForThing', listJobExecutionsForThing_thingName - The thing name.

Request Lenses

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

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

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_maxResults :: Lens' ListJobExecutionsForThing (Maybe Natural) Source #

The maximum number of results to be returned per request.

Destructuring the Response

data ListJobExecutionsForThingResponse Source #

See: newListJobExecutionsForThingResponse smart constructor.

Constructors

ListJobExecutionsForThingResponse' 

Fields

Instances

Instances details
Eq ListJobExecutionsForThingResponse Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

Read ListJobExecutionsForThingResponse Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

Show ListJobExecutionsForThingResponse Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

Generic ListJobExecutionsForThingResponse Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

Associated Types

type Rep ListJobExecutionsForThingResponse :: Type -> Type #

NFData ListJobExecutionsForThingResponse Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

type Rep ListJobExecutionsForThingResponse Source # 
Instance details

Defined in Amazonka.IoT.ListJobExecutionsForThing

type Rep ListJobExecutionsForThingResponse = D1 ('MetaData "ListJobExecutionsForThingResponse" "Amazonka.IoT.ListJobExecutionsForThing" "libZSservicesZSamazonka-iotZSamazonka-iot" '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 #

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.

$sel:nextToken: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_nextToken :: Lens' ListJobExecutionsForThingResponse (Maybe Text) Source #

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