@datafire/amazonaws_data_jobs_iot v5.0.0

@datafire/amazonaws_data_jobs_iot

Client library for AWS IoT Jobs Data Plane

Installation and Usage

npm install --save @datafire/amazonaws_data_jobs_iot

let amazonaws_data_jobs_iot = require('@datafire/amazonaws_data_jobs_iot').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_data_jobs_iot.GetPendingJobExecutions({
  "thingName": ""
}).then(data => {
  console.log(data);
});

Description

Actions

GetPendingJobExecutions

amazonaws_data_jobs_iot.GetPendingJobExecutions({
  "thingName": ""
}, context)

Input

• input object
  • thingName required string

Output

• output GetPendingJobExecutionsResponse

StartNextPendingJobExecution

amazonaws_data_jobs_iot.StartNextPendingJobExecution({
  "thingName": ""
}, context)

Input

• input object
  • thingName required string
  • statusDetails DetailsMap

Output

• output StartNextPendingJobExecutionResponse

DescribeJobExecution

amazonaws_data_jobs_iot.DescribeJobExecution({
  "jobId": "",
  "thingName": ""
}, context)

Input

• input object
  • jobId required string
  • thingName required string

Output

• output DescribeJobExecutionResponse

UpdateJobExecution

amazonaws_data_jobs_iot.UpdateJobExecution({
  "jobId": "",
  "thingName": "",
  "status": ""
}, context)

Input

• input object
  • jobId required string
  • thingName required string
  • executionNumber ExecutionNumber
  • expectedVersion ExpectedVersion
  • includeJobDocument IncludeJobDocument
  • includeJobExecutionState IncludeExecutionState
  • status required JobExecutionStatus
  • statusDetails DetailsMap

Output

• output UpdateJobExecutionResponse

Definitions

CertificateValidationException

• CertificateValidationException object: The certificate is invalid.
  • message errorMessage

DescribeJobExecutionJobId

• DescribeJobExecutionJobId string

DescribeJobExecutionRequest

• DescribeJobExecutionRequest object

DescribeJobExecutionResponse

• DescribeJobExecutionResponse object
  • execution JobExecution

DetailsKey

• DetailsKey string

DetailsMap

• DetailsMap array
  • items object
    • key DetailsKey
    • value DetailsValue

DetailsValue

• DetailsValue string

ExecutionNumber

• ExecutionNumber integer

ExpectedVersion

• ExpectedVersion integer

GetPendingJobExecutionsRequest

• GetPendingJobExecutionsRequest object

GetPendingJobExecutionsResponse

• GetPendingJobExecutionsResponse object
  • inProgressJobs JobExecutionSummaryList
  • queuedJobs JobExecutionSummaryList

IncludeExecutionState

• IncludeExecutionState boolean

IncludeJobDocument

• IncludeJobDocument boolean

InvalidRequestException

• InvalidRequestException object: 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.
  • message errorMessage

InvalidStateTransitionException

• InvalidStateTransitionException object: 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.
  • message errorMessage

JobDocument

• JobDocument string

JobExecution

• JobExecution object: Contains data about a job execution.
  • executionNumber ExecutionNumber
  • jobDocument JobDocument
  • jobId JobId
  • lastUpdatedAt LastUpdatedAt
  • queuedAt QueuedAt
  • startedAt StartedAt
  • status JobExecutionStatus
  • statusDetails DetailsMap
  • thingName ThingName
  • versionNumber VersionNumber

JobExecutionState

• JobExecutionState object: Contains data about the state of a job execution.
  • status JobExecutionStatus
  • statusDetails DetailsMap
  • versionNumber VersionNumber

JobExecutionStatus

• JobExecutionStatus string (values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED, REMOVED, CANCELED)

JobExecutionSummary

• JobExecutionSummary object: Contains a subset of information about a job execution.
  • executionNumber ExecutionNumber
  • jobId JobId
  • lastUpdatedAt LastUpdatedAt
  • queuedAt QueuedAt
  • startedAt StartedAt
  • versionNumber VersionNumber

JobExecutionSummaryList

• JobExecutionSummaryList array
  • items JobExecutionSummary

JobId

• JobId string

LastUpdatedAt

• LastUpdatedAt integer

QueuedAt

• QueuedAt integer

ResourceNotFoundException

• ResourceNotFoundException object: The specified resource does not exist.
  • message errorMessage

ServiceUnavailableException

• ServiceUnavailableException object: The service is temporarily unavailable.
  • message errorMessage

StartNextPendingJobExecutionRequest

• StartNextPendingJobExecutionRequest object
  • statusDetails DetailsMap

StartNextPendingJobExecutionResponse

• StartNextPendingJobExecutionResponse object
  • execution JobExecution

StartedAt

• StartedAt integer

TerminalStateException

• TerminalStateException object: The job is in a terminal state.
  • message errorMessage

ThingName

• ThingName string

ThrottlingException

• ThrottlingException object: The rate exceeds the limit.
  • message errorMessage

UpdateJobExecutionRequest

• UpdateJobExecutionRequest object
  • executionNumber ExecutionNumber
  • expectedVersion ExpectedVersion
  • includeJobDocument IncludeJobDocument
  • includeJobExecutionState IncludeExecutionState
  • status required JobExecutionStatus
  • statusDetails DetailsMap

UpdateJobExecutionResponse

• UpdateJobExecutionResponse object
  • executionState JobExecutionState
  • jobDocument JobDocument

VersionNumber

• VersionNumber integer

errorMessage

• errorMessage string