libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane
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.IoTJobsData

Description

Derived from API version 2017-09-29 of the AWS service descriptions, licensed under Apache 2.0.

AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform remote troubleshooting operations.

To create a job, you make a job document which is a description of the remote operations to be performed, and you specify a list of targets that should perform the operations. The targets can be individual things, thing groups or both.

AWS IoT Jobs sends a message to inform the targets that a job is available. The target starts the execution of the job by downloading the job document, performing the operations it specifies, and reporting its progress to AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job

Synopsis

Service Configuration

defaultService :: Service Source #

API version 2017-09-29 of the Amazon IoT Jobs Data Plane SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by IoTJobsData.

TerminalStateException

_TerminalStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The job is in a terminal state.

InvalidRequestException

_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

CertificateValidationException

ThrottlingException

ServiceUnavailableException

_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The service is temporarily unavailable.

InvalidStateTransitionException

_InvalidStateTransitionException :: AsError a => Getting (First ServiceError) a ServiceError Source #

An update attempted to change the job execution to a state that is invalid because of the job execution's current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this case, the body of the error message also contains the executionState field.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource does not exist.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

UpdateJobExecution

data UpdateJobExecution Source #

See: newUpdateJobExecution smart constructor.

Instances

Instances details
Eq UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

Read UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

Show UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

Generic UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

Associated Types

type Rep UpdateJobExecution :: Type -> Type #

NFData UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

Methods

rnf :: UpdateJobExecution -> () #

Hashable UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

ToJSON UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

AWSRequest UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

Associated Types

type AWSResponse UpdateJobExecution #

ToHeaders UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

ToPath UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

ToQuery UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

type Rep UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

type Rep UpdateJobExecution = D1 ('MetaData "UpdateJobExecution" "Amazonka.IoTJobsData.UpdateJobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "UpdateJobExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "includeJobDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "stepTimeoutInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "executionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: ((S1 ('MetaSel ('Just "expectedVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "includeJobExecutionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobExecutionStatus))))))
type AWSResponse UpdateJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

newUpdateJobExecution Source #

Create a value of UpdateJobExecution 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:includeJobDocument:UpdateJobExecution', updateJobExecution_includeJobDocument - Optional. When set to true, the response contains the job document. The default is false.

$sel:stepTimeoutInMinutes:UpdateJobExecution', updateJobExecution_stepTimeoutInMinutes - Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

$sel:statusDetails:UpdateJobExecution', updateJobExecution_statusDetails - Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

$sel:executionNumber:UpdateJobExecution', updateJobExecution_executionNumber - Optional. A number that identifies a particular job execution on a particular device.

$sel:expectedVersion:UpdateJobExecution', updateJobExecution_expectedVersion - Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

$sel:includeJobExecutionState:UpdateJobExecution', updateJobExecution_includeJobExecutionState - Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

$sel:jobId:UpdateJobExecution', updateJobExecution_jobId - The unique identifier assigned to this job when it was created.

$sel:thingName:UpdateJobExecution', updateJobExecution_thingName - The name of the thing associated with the device.

$sel:status:UpdateJobExecution', updateJobExecution_status - The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

data UpdateJobExecutionResponse Source #

See: newUpdateJobExecutionResponse smart constructor.

Instances

Instances details
Eq UpdateJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

Read UpdateJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

Show UpdateJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

Generic UpdateJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

Associated Types

type Rep UpdateJobExecutionResponse :: Type -> Type #

NFData UpdateJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

type Rep UpdateJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.UpdateJobExecution

type Rep UpdateJobExecutionResponse = D1 ('MetaData "UpdateJobExecutionResponse" "Amazonka.IoTJobsData.UpdateJobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "UpdateJobExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "executionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateJobExecutionResponse Source #

Create a value of UpdateJobExecutionResponse 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:jobDocument:UpdateJobExecutionResponse', updateJobExecutionResponse_jobDocument - The contents of the Job Documents.

$sel:executionState:UpdateJobExecutionResponse', updateJobExecutionResponse_executionState - A JobExecutionState object.

$sel:httpStatus:UpdateJobExecutionResponse', updateJobExecutionResponse_httpStatus - The response's http status code.

StartNextPendingJobExecution

data StartNextPendingJobExecution Source #

See: newStartNextPendingJobExecution smart constructor.

Instances

Instances details
Eq StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Read StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Show StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Generic StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Associated Types

type Rep StartNextPendingJobExecution :: Type -> Type #

NFData StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Hashable StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

ToJSON StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

AWSRequest StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

ToHeaders StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

ToPath StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

ToQuery StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

type Rep StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

type Rep StartNextPendingJobExecution = D1 ('MetaData "StartNextPendingJobExecution" "Amazonka.IoTJobsData.StartNextPendingJobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "StartNextPendingJobExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stepTimeoutInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StartNextPendingJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

newStartNextPendingJobExecution Source #

Create a value of StartNextPendingJobExecution 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:stepTimeoutInMinutes:StartNextPendingJobExecution', startNextPendingJobExecution_stepTimeoutInMinutes - Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

$sel:statusDetails:StartNextPendingJobExecution', startNextPendingJobExecution_statusDetails - A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

$sel:thingName:StartNextPendingJobExecution', startNextPendingJobExecution_thingName - The name of the thing associated with the device.

data StartNextPendingJobExecutionResponse Source #

Instances

Instances details
Eq StartNextPendingJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Read StartNextPendingJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Show StartNextPendingJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Generic StartNextPendingJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

NFData StartNextPendingJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

type Rep StartNextPendingJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

type Rep StartNextPendingJobExecutionResponse = D1 ('MetaData "StartNextPendingJobExecutionResponse" "Amazonka.IoTJobsData.StartNextPendingJobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "StartNextPendingJobExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "execution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecution)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartNextPendingJobExecutionResponse Source #

Create a value of StartNextPendingJobExecutionResponse 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:execution:StartNextPendingJobExecutionResponse', startNextPendingJobExecutionResponse_execution - A JobExecution object.

$sel:httpStatus:StartNextPendingJobExecutionResponse', startNextPendingJobExecutionResponse_httpStatus - The response's http status code.

DescribeJobExecution

data DescribeJobExecution Source #

See: newDescribeJobExecution smart constructor.

Instances

Instances details
Eq DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Read DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Show DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Generic DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Associated Types

type Rep DescribeJobExecution :: Type -> Type #

NFData DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

rnf :: DescribeJobExecution -> () #

Hashable DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

AWSRequest DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Associated Types

type AWSResponse DescribeJobExecution #

ToHeaders DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

ToPath DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

ToQuery DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

type Rep DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

type Rep DescribeJobExecution = D1 ('MetaData "DescribeJobExecution" "Amazonka.IoTJobsData.DescribeJobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "DescribeJobExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "includeJobDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "executionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeJobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

newDescribeJobExecution Source #

Create a value of DescribeJobExecution 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:includeJobDocument:DescribeJobExecution', describeJobExecution_includeJobDocument - Optional. When set to true, the response contains the job document. The default is false.

$sel:executionNumber:DescribeJobExecution', describeJobExecution_executionNumber - Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

$sel:jobId:DescribeJobExecution', describeJobExecution_jobId - The unique identifier assigned to this job when it was created.

$sel:thingName:DescribeJobExecution', describeJobExecution_thingName - The thing name associated with the device the job execution is running on.

data DescribeJobExecutionResponse Source #

See: newDescribeJobExecutionResponse smart constructor.

Instances

Instances details
Eq DescribeJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Read DescribeJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Show DescribeJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Generic DescribeJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Associated Types

type Rep DescribeJobExecutionResponse :: Type -> Type #

NFData DescribeJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

type Rep DescribeJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.DescribeJobExecution

type Rep DescribeJobExecutionResponse = D1 ('MetaData "DescribeJobExecutionResponse" "Amazonka.IoTJobsData.DescribeJobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "DescribeJobExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "execution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecution)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeJobExecutionResponse Source #

Create a value of DescribeJobExecutionResponse 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:execution:DescribeJobExecutionResponse', describeJobExecutionResponse_execution - Contains data about a job execution.

$sel:httpStatus:DescribeJobExecutionResponse', describeJobExecutionResponse_httpStatus - The response's http status code.

GetPendingJobExecutions

data GetPendingJobExecutions Source #

See: newGetPendingJobExecutions smart constructor.

Instances

Instances details
Eq GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

Read GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

Show GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

Generic GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

Associated Types

type Rep GetPendingJobExecutions :: Type -> Type #

NFData GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

Methods

rnf :: GetPendingJobExecutions -> () #

Hashable GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

AWSRequest GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

ToHeaders GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

ToPath GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

ToQuery GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

type Rep GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

type Rep GetPendingJobExecutions = D1 ('MetaData "GetPendingJobExecutions" "Amazonka.IoTJobsData.GetPendingJobExecutions" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "GetPendingJobExecutions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetPendingJobExecutions Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

newGetPendingJobExecutions Source #

Create a value of GetPendingJobExecutions 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:thingName:GetPendingJobExecutions', getPendingJobExecutions_thingName - The name of the thing that is executing the job.

data GetPendingJobExecutionsResponse Source #

See: newGetPendingJobExecutionsResponse smart constructor.

Instances

Instances details
Eq GetPendingJobExecutionsResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

Read GetPendingJobExecutionsResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

Show GetPendingJobExecutionsResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

Generic GetPendingJobExecutionsResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

Associated Types

type Rep GetPendingJobExecutionsResponse :: Type -> Type #

NFData GetPendingJobExecutionsResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

type Rep GetPendingJobExecutionsResponse Source # 
Instance details

Defined in Amazonka.IoTJobsData.GetPendingJobExecutions

type Rep GetPendingJobExecutionsResponse = D1 ('MetaData "GetPendingJobExecutionsResponse" "Amazonka.IoTJobsData.GetPendingJobExecutions" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "GetPendingJobExecutionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inProgressJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobExecutionSummary])) :*: (S1 ('MetaSel ('Just "queuedJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobExecutionSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetPendingJobExecutionsResponse Source #

Create a value of GetPendingJobExecutionsResponse 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:inProgressJobs:GetPendingJobExecutionsResponse', getPendingJobExecutionsResponse_inProgressJobs - A list of JobExecutionSummary objects with status IN_PROGRESS.

$sel:queuedJobs:GetPendingJobExecutionsResponse', getPendingJobExecutionsResponse_queuedJobs - A list of JobExecutionSummary objects with status QUEUED.

$sel:httpStatus:GetPendingJobExecutionsResponse', getPendingJobExecutionsResponse_httpStatus - The response's http status code.

Types

JobExecutionStatus

newtype JobExecutionStatus Source #

Instances

Instances details
Eq JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

Ord JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

Read JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

Show JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

Generic JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

Associated Types

type Rep JobExecutionStatus :: Type -> Type #

NFData JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

Methods

rnf :: JobExecutionStatus -> () #

Hashable JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

ToJSON JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

ToJSONKey JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

FromJSON JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

FromJSONKey JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

ToLog JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

ToHeader JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

ToQuery JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

FromXML JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

ToXML JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

ToByteString JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

FromText JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

ToText JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

type Rep JobExecutionStatus Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus

type Rep JobExecutionStatus = D1 ('MetaData "JobExecutionStatus" "Amazonka.IoTJobsData.Types.JobExecutionStatus" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'True) (C1 ('MetaCons "JobExecutionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJobExecutionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

JobExecution

data JobExecution Source #

Contains data about a job execution.

See: newJobExecution smart constructor.

Instances

Instances details
Eq JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

Read JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

Show JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

Generic JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

Associated Types

type Rep JobExecution :: Type -> Type #

NFData JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

Methods

rnf :: JobExecution -> () #

Hashable JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

FromJSON JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

type Rep JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

type Rep JobExecution = D1 ('MetaData "JobExecution" "Amazonka.IoTJobsData.Types.JobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "JobExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionStatus)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "approximateSecondsBeforeTimedOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "queuedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :*: ((S1 ('MetaSel ('Just "jobDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "executionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "versionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newJobExecution :: JobExecution Source #

Create a value of JobExecution 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:JobExecution', jobExecution_status - The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

$sel:jobId:JobExecution', jobExecution_jobId - The unique identifier you assigned to this job when it was created.

$sel:lastUpdatedAt:JobExecution', jobExecution_lastUpdatedAt - The time, in milliseconds since the epoch, when the job execution was last updated.

$sel:approximateSecondsBeforeTimedOut:JobExecution', jobExecution_approximateSecondsBeforeTimedOut - The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

$sel:queuedAt:JobExecution', jobExecution_queuedAt - The time, in milliseconds since the epoch, when the job execution was enqueued.

$sel:jobDocument:JobExecution', jobExecution_jobDocument - The content of the job document.

$sel:statusDetails:JobExecution', jobExecution_statusDetails - A collection of name/value pairs that describe the status of the job execution.

$sel:executionNumber:JobExecution', jobExecution_executionNumber - A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

$sel:versionNumber:JobExecution', jobExecution_versionNumber - The version of the job execution. Job execution versions are incremented each time they are updated by a device.

$sel:startedAt:JobExecution', jobExecution_startedAt - The time, in milliseconds since the epoch, when the job execution was started.

$sel:thingName:JobExecution', jobExecution_thingName - The name of the thing that is executing the job.

JobExecutionState

data JobExecutionState Source #

Contains data about the state of a job execution.

See: newJobExecutionState smart constructor.

Instances

Instances details
Eq JobExecutionState Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionState

Read JobExecutionState Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionState

Show JobExecutionState Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionState

Generic JobExecutionState Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionState

Associated Types

type Rep JobExecutionState :: Type -> Type #

NFData JobExecutionState Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionState

Methods

rnf :: JobExecutionState -> () #

Hashable JobExecutionState Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionState

FromJSON JobExecutionState Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionState

type Rep JobExecutionState Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionState

type Rep JobExecutionState = D1 ('MetaData "JobExecutionState" "Amazonka.IoTJobsData.Types.JobExecutionState" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "JobExecutionState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionStatus)) :*: (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "versionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

newJobExecutionState :: JobExecutionState Source #

Create a value of JobExecutionState 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:JobExecutionState', jobExecutionState_status - The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

$sel:statusDetails:JobExecutionState', jobExecutionState_statusDetails - A collection of name/value pairs that describe the status of the job execution.

$sel:versionNumber:JobExecutionState', jobExecutionState_versionNumber - The version of the job execution. Job execution versions are incremented each time they are updated by a device.

JobExecutionSummary

data JobExecutionSummary Source #

Contains a subset of information about a job execution.

See: newJobExecutionSummary smart constructor.

Instances

Instances details
Eq JobExecutionSummary Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary

Read JobExecutionSummary Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary

Show JobExecutionSummary Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary

Generic JobExecutionSummary Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary

Associated Types

type Rep JobExecutionSummary :: Type -> Type #

NFData JobExecutionSummary Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary

Methods

rnf :: JobExecutionSummary -> () #

Hashable JobExecutionSummary Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary

FromJSON JobExecutionSummary Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary

type Rep JobExecutionSummary Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary

type Rep JobExecutionSummary = D1 ('MetaData "JobExecutionSummary" "Amazonka.IoTJobsData.Types.JobExecutionSummary" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "JobExecutionSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "queuedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "executionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "versionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

newJobExecutionSummary :: JobExecutionSummary Source #

Create a value of JobExecutionSummary 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:jobId:JobExecutionSummary', jobExecutionSummary_jobId - The unique identifier you assigned to this job when it was created.

$sel:lastUpdatedAt:JobExecutionSummary', jobExecutionSummary_lastUpdatedAt - The time, in milliseconds since the epoch, when the job execution was last updated.

$sel:queuedAt:JobExecutionSummary', jobExecutionSummary_queuedAt - The time, in milliseconds since the epoch, when the job execution was enqueued.

$sel:executionNumber:JobExecutionSummary', jobExecutionSummary_executionNumber - A number that identifies a particular job execution on a particular device.

$sel:versionNumber:JobExecutionSummary', jobExecutionSummary_versionNumber - The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.

$sel:startedAt:JobExecutionSummary', jobExecutionSummary_startedAt - The time, in milliseconds since the epoch, when the job execution started.