iotjobs.py

# Copyright Amazon.com, Inc. or its affiliates. All rights reserved.
# SPDX-License-Identifier: Apache-2.0.

# This file is generated

importawsiot
importconcurrent.futures
importdatetime
importtyping

classIotJobsClient(awsiot.MqttServiceClient):
"""

 The AWS IoT jobs service can be used to define a set of remote operations that are sent to and executed on one or more devices connected to AWS IoT.

 AWS Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#jobs-mqtt-api

 """

defpublish_describe_job_execution(self, request, qos):
# type: (DescribeJobExecutionRequest, int) -> concurrent.futures.Future
"""

 Gets detailed information about a job execution.

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-describejobexecution

 Args:
 request: `DescribeJobExecutionRequest` instance.
 qos: The Quality of Service guarantee of this message

 Returns:
 A Future whose result will be None if the
 request is successfully published. The Future's result will be an
 exception if the request cannot be published.
 """
ifnotrequest.job_id:
raiseValueError("request.job_id is required")
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

returnself._publish_operation(
topic='$aws/things/{0.thing_name}/jobs/{0.job_id}/get'.format(request),
qos=qos,
payload=request.to_payload())

defpublish_get_pending_job_executions(self, request, qos):
# type: (GetPendingJobExecutionsRequest, int) -> concurrent.futures.Future
"""

 Gets the list of all jobs for a thing that are not in a terminal state.

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-getpendingjobexecutions

 Args:
 request: `GetPendingJobExecutionsRequest` instance.
 qos: The Quality of Service guarantee of this message

 Returns:
 A Future whose result will be None if the
 request is successfully published. The Future's result will be an
 exception if the request cannot be published.
 """
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

returnself._publish_operation(
topic='$aws/things/{0.thing_name}/jobs/get'.format(request),
qos=qos,
payload=request.to_payload())

defpublish_start_next_pending_job_execution(self, request, qos):
# type: (StartNextPendingJobExecutionRequest, int) -> concurrent.futures.Future
"""

 Gets and starts the next pending job execution for a thing (status IN_PROGRESS or QUEUED).

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-startnextpendingjobexecution

 Args:
 request: `StartNextPendingJobExecutionRequest` instance.
 qos: The Quality of Service guarantee of this message

 Returns:
 A Future whose result will be None if the
 request is successfully published. The Future's result will be an
 exception if the request cannot be published.
 """
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

returnself._publish_operation(
topic='$aws/things/{0.thing_name}/jobs/start-next'.format(request),
qos=qos,
payload=request.to_payload())

defpublish_update_job_execution(self, request, qos):
# type: (UpdateJobExecutionRequest, int) -> concurrent.futures.Future
"""

 Updates the status of a job execution. You can optionally create a step timer by setting a value for the stepTimeoutInMinutes property. If you don't update the value of this property by running UpdateJobExecution again, the job execution times out when the step timer expires.

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-updatejobexecution

 Args:
 request: `UpdateJobExecutionRequest` instance.
 qos: The Quality of Service guarantee of this message

 Returns:
 A Future whose result will be None if the
 request is successfully published. The Future's result will be an
 exception if the request cannot be published.
 """
ifnotrequest.job_id:
raiseValueError("request.job_id is required")
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

returnself._publish_operation(
topic='$aws/things/{0.thing_name}/jobs/{0.job_id}/update'.format(request),
qos=qos,
payload=request.to_payload())

defsubscribe_to_describe_job_execution_accepted(self, request, qos, callback):
# type: (DescribeJobExecutionSubscriptionRequest, int, typing.Callable[[DescribeJobExecutionResponse], None]) -> typing.Tuple[concurrent.futures.Future, str]
"""

 Subscribes to the accepted topic for the DescribeJobExecution operation

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-describejobexecution

 Args:
 request: `DescribeJobExecutionSubscriptionRequest` instance.
 qos: The Quality of Service guarantee of this message
 callback: Callback to invoke each time the event is received.
 The callback should take 1 argument of type `DescribeJobExecutionResponse`.
 The callback is not expected to return anything.

 Returns:
 Tuple with two values. The first is a `Future` whose result will be the
 `awscrt.mqtt.QoS` granted by the server, or an exception if the
 subscription fails. The second value is a topic which may be passed
 to `unsubscribe()` to stop receiving messages. Note that messages
 may arrive before the subscription is acknowledged.
 """
ifnotrequest.job_id:
raiseValueError("request.job_id is required")
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

ifnotcallable(callback):
raiseValueError("callback is required")

returnself._subscribe_operation(
topic='$aws/things/{0.thing_name}/jobs/{0.job_id}/get/accepted'.format(request),
qos=qos,
callback=callback,
payload_to_class_fn=DescribeJobExecutionResponse.from_payload)

defsubscribe_to_describe_job_execution_rejected(self, request, qos, callback):
# type: (DescribeJobExecutionSubscriptionRequest, int, typing.Callable[[RejectedError], None]) -> typing.Tuple[concurrent.futures.Future, str]
"""

 Subscribes to the rejected topic for the DescribeJobExecution operation

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-describejobexecution

 Args:
 request: `DescribeJobExecutionSubscriptionRequest` instance.
 qos: The Quality of Service guarantee of this message
 callback: Callback to invoke each time the event is received.
 The callback should take 1 argument of type `RejectedError`.
 The callback is not expected to return anything.

 Returns:
 Tuple with two values. The first is a `Future` whose result will be the
 `awscrt.mqtt.QoS` granted by the server, or an exception if the
 subscription fails. The second value is a topic which may be passed
 to `unsubscribe()` to stop receiving messages. Note that messages
 may arrive before the subscription is acknowledged.
 """
ifnotrequest.job_id:
raiseValueError("request.job_id is required")
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

ifnotcallable(callback):
raiseValueError("callback is required")

returnself._subscribe_operation(
topic='$aws/things/{0.thing_name}/jobs/{0.job_id}/get/rejected'.format(request),
qos=qos,
callback=callback,
payload_to_class_fn=RejectedError.from_payload)

defsubscribe_to_get_pending_job_executions_accepted(self, request, qos, callback):
# type: (GetPendingJobExecutionsSubscriptionRequest, int, typing.Callable[[GetPendingJobExecutionsResponse], None]) -> typing.Tuple[concurrent.futures.Future, str]
"""

 Subscribes to the accepted topic for the GetPendingJobsExecutions operation

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-getpendingjobexecutions

 Args:
 request: `GetPendingJobExecutionsSubscriptionRequest` instance.
 qos: The Quality of Service guarantee of this message
 callback: Callback to invoke each time the event is received.
 The callback should take 1 argument of type `GetPendingJobExecutionsResponse`.
 The callback is not expected to return anything.

 Returns:
 Tuple with two values. The first is a `Future` whose result will be the
 `awscrt.mqtt.QoS` granted by the server, or an exception if the
 subscription fails. The second value is a topic which may be passed
 to `unsubscribe()` to stop receiving messages. Note that messages
 may arrive before the subscription is acknowledged.
 """
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

ifnotcallable(callback):
raiseValueError("callback is required")

returnself._subscribe_operation(
topic='$aws/things/{0.thing_name}/jobs/get/accepted'.format(request),
qos=qos,
callback=callback,
payload_to_class_fn=GetPendingJobExecutionsResponse.from_payload)

defsubscribe_to_get_pending_job_executions_rejected(self, request, qos, callback):
# type: (GetPendingJobExecutionsSubscriptionRequest, int, typing.Callable[[RejectedError], None]) -> typing.Tuple[concurrent.futures.Future, str]
"""

 Subscribes to the rejected topic for the GetPendingJobsExecutions operation

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-getpendingjobexecutions

 Args:
 request: `GetPendingJobExecutionsSubscriptionRequest` instance.
 qos: The Quality of Service guarantee of this message
 callback: Callback to invoke each time the event is received.
 The callback should take 1 argument of type `RejectedError`.
 The callback is not expected to return anything.

 Returns:
 Tuple with two values. The first is a `Future` whose result will be the
 `awscrt.mqtt.QoS` granted by the server, or an exception if the
 subscription fails. The second value is a topic which may be passed
 to `unsubscribe()` to stop receiving messages. Note that messages
 may arrive before the subscription is acknowledged.
 """
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

ifnotcallable(callback):
raiseValueError("callback is required")

returnself._subscribe_operation(
topic='$aws/things/{0.thing_name}/jobs/get/rejected'.format(request),
qos=qos,
callback=callback,
payload_to_class_fn=RejectedError.from_payload)

defsubscribe_to_job_executions_changed_events(self, request, qos, callback):
# type: (JobExecutionsChangedSubscriptionRequest, int, typing.Callable[[JobExecutionsChangedEvent], None]) -> typing.Tuple[concurrent.futures.Future, str]
"""

 Subscribes to JobExecutionsChanged notifications for a given IoT thing.

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-jobexecutionschanged

 Args:
 request: `JobExecutionsChangedSubscriptionRequest` instance.
 qos: The Quality of Service guarantee of this message
 callback: Callback to invoke each time the event is received.
 The callback should take 1 argument of type `JobExecutionsChangedEvent`.
 The callback is not expected to return anything.

 Returns:
 Tuple with two values. The first is a `Future` whose result will be the
 `awscrt.mqtt.QoS` granted by the server, or an exception if the
 subscription fails. The second value is a topic which may be passed
 to `unsubscribe()` to stop receiving messages. Note that messages
 may arrive before the subscription is acknowledged.
 """
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

ifnotcallable(callback):
raiseValueError("callback is required")

returnself._subscribe_operation(
topic='$aws/things/{0.thing_name}/jobs/notify'.format(request),
qos=qos,
callback=callback,
payload_to_class_fn=JobExecutionsChangedEvent.from_payload)

defsubscribe_to_next_job_execution_changed_events(self, request, qos, callback):
# type: (NextJobExecutionChangedSubscriptionRequest, int, typing.Callable[[NextJobExecutionChangedEvent], None]) -> typing.Tuple[concurrent.futures.Future, str]
"""

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-nextjobexecutionchanged

 Args:
 request: `NextJobExecutionChangedSubscriptionRequest` instance.
 qos: The Quality of Service guarantee of this message
 callback: Callback to invoke each time the event is received.
 The callback should take 1 argument of type `NextJobExecutionChangedEvent`.
 The callback is not expected to return anything.

 Returns:
 Tuple with two values. The first is a `Future` whose result will be the
 `awscrt.mqtt.QoS` granted by the server, or an exception if the
 subscription fails. The second value is a topic which may be passed
 to `unsubscribe()` to stop receiving messages. Note that messages
 may arrive before the subscription is acknowledged.
 """
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

ifnotcallable(callback):
raiseValueError("callback is required")

returnself._subscribe_operation(
topic='$aws/things/{0.thing_name}/jobs/notify-next'.format(request),
qos=qos,
callback=callback,
payload_to_class_fn=NextJobExecutionChangedEvent.from_payload)

defsubscribe_to_start_next_pending_job_execution_accepted(self, request, qos, callback):
# type: (StartNextPendingJobExecutionSubscriptionRequest, int, typing.Callable[[StartNextJobExecutionResponse], None]) -> typing.Tuple[concurrent.futures.Future, str]
"""

 Subscribes to the accepted topic for the StartNextPendingJobExecution operation

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-startnextpendingjobexecution

 Args:
 request: `StartNextPendingJobExecutionSubscriptionRequest` instance.
 qos: The Quality of Service guarantee of this message
 callback: Callback to invoke each time the event is received.
 The callback should take 1 argument of type `StartNextJobExecutionResponse`.
 The callback is not expected to return anything.

 Returns:
 Tuple with two values. The first is a `Future` whose result will be the
 `awscrt.mqtt.QoS` granted by the server, or an exception if the
 subscription fails. The second value is a topic which may be passed
 to `unsubscribe()` to stop receiving messages. Note that messages
 may arrive before the subscription is acknowledged.
 """
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

ifnotcallable(callback):
raiseValueError("callback is required")

returnself._subscribe_operation(
topic='$aws/things/{0.thing_name}/jobs/start-next/accepted'.format(request),
qos=qos,
callback=callback,
payload_to_class_fn=StartNextJobExecutionResponse.from_payload)

defsubscribe_to_start_next_pending_job_execution_rejected(self, request, qos, callback):
# type: (StartNextPendingJobExecutionSubscriptionRequest, int, typing.Callable[[RejectedError], None]) -> typing.Tuple[concurrent.futures.Future, str]
"""

 Subscribes to the rejected topic for the StartNextPendingJobExecution operation

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-startnextpendingjobexecution

 Args:
 request: `StartNextPendingJobExecutionSubscriptionRequest` instance.
 qos: The Quality of Service guarantee of this message
 callback: Callback to invoke each time the event is received.
 The callback should take 1 argument of type `RejectedError`.
 The callback is not expected to return anything.

 Returns:
 Tuple with two values. The first is a `Future` whose result will be the
 `awscrt.mqtt.QoS` granted by the server, or an exception if the
 subscription fails. The second value is a topic which may be passed
 to `unsubscribe()` to stop receiving messages. Note that messages
 may arrive before the subscription is acknowledged.
 """
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

ifnotcallable(callback):
raiseValueError("callback is required")

returnself._subscribe_operation(
topic='$aws/things/{0.thing_name}/jobs/start-next/rejected'.format(request),
qos=qos,
callback=callback,
payload_to_class_fn=RejectedError.from_payload)

defsubscribe_to_update_job_execution_accepted(self, request, qos, callback):
# type: (UpdateJobExecutionSubscriptionRequest, int, typing.Callable[[UpdateJobExecutionResponse], None]) -> typing.Tuple[concurrent.futures.Future, str]
"""

 Subscribes to the accepted topic for the UpdateJobExecution operation

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-updatejobexecution

 Args:
 request: `UpdateJobExecutionSubscriptionRequest` instance.
 qos: The Quality of Service guarantee of this message
 callback: Callback to invoke each time the event is received.
 The callback should take 1 argument of type `UpdateJobExecutionResponse`.
 The callback is not expected to return anything.

 Returns:
 Tuple with two values. The first is a `Future` whose result will be the
 `awscrt.mqtt.QoS` granted by the server, or an exception if the
 subscription fails. The second value is a topic which may be passed
 to `unsubscribe()` to stop receiving messages. Note that messages
 may arrive before the subscription is acknowledged.
 """
ifnotrequest.job_id:
raiseValueError("request.job_id is required")
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

ifnotcallable(callback):
raiseValueError("callback is required")

returnself._subscribe_operation(
topic='$aws/things/{0.thing_name}/jobs/{0.job_id}/update/accepted'.format(request),
qos=qos,
callback=callback,
payload_to_class_fn=UpdateJobExecutionResponse.from_payload)

defsubscribe_to_update_job_execution_rejected(self, request, qos, callback):
# type: (UpdateJobExecutionSubscriptionRequest, int, typing.Callable[[RejectedError], None]) -> typing.Tuple[concurrent.futures.Future, str]
"""

 Subscribes to the rejected topic for the UpdateJobExecution operation

 API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-updatejobexecution

 Args:
 request: `UpdateJobExecutionSubscriptionRequest` instance.
 qos: The Quality of Service guarantee of this message
 callback: Callback to invoke each time the event is received.
 The callback should take 1 argument of type `RejectedError`.
 The callback is not expected to return anything.

 Returns:
 Tuple with two values. The first is a `Future` whose result will be the
 `awscrt.mqtt.QoS` granted by the server, or an exception if the
 subscription fails. The second value is a topic which may be passed
 to `unsubscribe()` to stop receiving messages. Note that messages
 may arrive before the subscription is acknowledged.
 """
ifnotrequest.job_id:
raiseValueError("request.job_id is required")
ifnotrequest.thing_name:
raiseValueError("request.thing_name is required")

ifnotcallable(callback):
raiseValueError("callback is required")

returnself._subscribe_operation(
topic='$aws/things/{0.thing_name}/jobs/{0.job_id}/update/rejected'.format(request),
qos=qos,
callback=callback,
payload_to_class_fn=RejectedError.from_payload)

classDescribeJobExecutionRequest(awsiot.ModeledClass):
"""

 Data needed to make a DescribeJobExecution request.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 client_token (str): An opaque string used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.
 execution_number (int): Optional. A number that identifies a job execution on a device. If not specified, the latest job execution is returned.
 include_job_document (bool): Optional. Unless set to false, the response contains the job document. The default is true.
 job_id (str): The unique identifier assigned to this job when it was created. Or use $next to return the next pending job execution for a thing (status IN_PROGRESS or QUEUED). In this case, any job executions with status IN_PROGRESS are returned first. Job executions are returned in the order in which they were created.
 thing_name (str): The name of the thing associated with the device.

 Attributes:
 client_token (str): An opaque string used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.
 execution_number (int): Optional. A number that identifies a job execution on a device. If not specified, the latest job execution is returned.
 include_job_document (bool): Optional. Unless set to false, the response contains the job document. The default is true.
 job_id (str): The unique identifier assigned to this job when it was created. Or use $next to return the next pending job execution for a thing (status IN_PROGRESS or QUEUED). In this case, any job executions with status IN_PROGRESS are returned first. Job executions are returned in the order in which they were created.
 thing_name (str): The name of the thing associated with the device.
 """

__slots__= ['client_token', 'execution_number', 'include_job_document', 'job_id', 'thing_name']

def__init__(self, *args, **kwargs):
self.client_token=kwargs.get('client_token')
self.execution_number=kwargs.get('execution_number')
self.include_job_document=kwargs.get('include_job_document')
self.job_id=kwargs.get('job_id')
self.thing_name=kwargs.get('thing_name')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['client_token', 'execution_number', 'include_job_document', 'job_id', 'thing_name'], args):
setattr(self, key, val)

defto_payload(self):
# type: () -> typing.Dict[str, typing.Any]
payload= {} # type: typing.Dict[str, typing.Any]
ifself.client_tokenisnotNone:
payload['clientToken'] =self.client_token
ifself.execution_numberisnotNone:
payload['executionNumber'] =self.execution_number
ifself.include_job_documentisnotNone:
payload['includeJobDocument'] =self.include_job_document
returnpayload

classDescribeJobExecutionResponse(awsiot.ModeledClass):
"""

 Response payload to a DescribeJobExecution request.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 client_token (str): A client token used to correlate requests and responses.
 execution (JobExecutionData): Contains data about a job execution.
 timestamp (datetime.datetime): The time when the message was sent.

 Attributes:
 client_token (str): A client token used to correlate requests and responses.
 execution (JobExecutionData): Contains data about a job execution.
 timestamp (datetime.datetime): The time when the message was sent.
 """

__slots__= ['client_token', 'execution', 'timestamp']

def__init__(self, *args, **kwargs):
self.client_token=kwargs.get('client_token')
self.execution=kwargs.get('execution')
self.timestamp=kwargs.get('timestamp')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['client_token', 'execution', 'timestamp'], args):
setattr(self, key, val)

@classmethod
deffrom_payload(cls, payload):
# type: (typing.Dict[str, typing.Any]) -> DescribeJobExecutionResponse
new=cls()
val=payload.get('clientToken')
ifvalisnotNone:
new.client_token=val
val=payload.get('execution')
ifvalisnotNone:
new.execution=JobExecutionData.from_payload(val)
val=payload.get('timestamp')
ifvalisnotNone:
new.timestamp=datetime.datetime.fromtimestamp(val)
returnnew

classDescribeJobExecutionSubscriptionRequest(awsiot.ModeledClass):
"""

 Data needed to subscribe to DescribeJobExecution responses.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 job_id (str): Job ID that you want to subscribe to DescribeJobExecution response events for.
 thing_name (str): Name of the IoT Thing that you want to subscribe to DescribeJobExecution response events for.

 Attributes:
 job_id (str): Job ID that you want to subscribe to DescribeJobExecution response events for.
 thing_name (str): Name of the IoT Thing that you want to subscribe to DescribeJobExecution response events for.
 """

__slots__= ['job_id', 'thing_name']

def__init__(self, *args, **kwargs):
self.job_id=kwargs.get('job_id')
self.thing_name=kwargs.get('thing_name')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['job_id', 'thing_name'], args):
setattr(self, key, val)

classGetPendingJobExecutionsRequest(awsiot.ModeledClass):
"""

 Data needed to make a GetPendingJobExecutions request.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 client_token (str): Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.
 thing_name (str): IoT Thing the request is relative to.

 Attributes:
 client_token (str): Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.
 thing_name (str): IoT Thing the request is relative to.
 """

__slots__= ['client_token', 'thing_name']

def__init__(self, *args, **kwargs):
self.client_token=kwargs.get('client_token')
self.thing_name=kwargs.get('thing_name')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['client_token', 'thing_name'], args):
setattr(self, key, val)

defto_payload(self):
# type: () -> typing.Dict[str, typing.Any]
payload= {} # type: typing.Dict[str, typing.Any]
ifself.client_tokenisnotNone:
payload['clientToken'] =self.client_token
returnpayload

classGetPendingJobExecutionsResponse(awsiot.ModeledClass):
"""

 Response payload to a GetPendingJobExecutions request.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 client_token (str): A client token used to correlate requests and responses.
 in_progress_jobs (typing.List[JobExecutionSummary]): A list of JobExecutionSummary objects with status IN_PROGRESS.
 queued_jobs (typing.List[JobExecutionSummary]): A list of JobExecutionSummary objects with status QUEUED.
 timestamp (datetime.datetime): The time when the message was sent.

 Attributes:
 client_token (str): A client token used to correlate requests and responses.
 in_progress_jobs (typing.List[JobExecutionSummary]): A list of JobExecutionSummary objects with status IN_PROGRESS.
 queued_jobs (typing.List[JobExecutionSummary]): A list of JobExecutionSummary objects with status QUEUED.
 timestamp (datetime.datetime): The time when the message was sent.
 """

__slots__= ['client_token', 'in_progress_jobs', 'queued_jobs', 'timestamp']

def__init__(self, *args, **kwargs):
self.client_token=kwargs.get('client_token')
self.in_progress_jobs=kwargs.get('in_progress_jobs')
self.queued_jobs=kwargs.get('queued_jobs')
self.timestamp=kwargs.get('timestamp')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['client_token', 'in_progress_jobs', 'queued_jobs', 'timestamp'], args):
setattr(self, key, val)

@classmethod
deffrom_payload(cls, payload):
# type: (typing.Dict[str, typing.Any]) -> GetPendingJobExecutionsResponse
new=cls()
val=payload.get('clientToken')
ifvalisnotNone:
new.client_token=val
val=payload.get('inProgressJobs')
ifvalisnotNone:
new.in_progress_jobs= [JobExecutionSummary.from_payload(i) foriinval]
val=payload.get('queuedJobs')
ifvalisnotNone:
new.queued_jobs= [JobExecutionSummary.from_payload(i) foriinval]
val=payload.get('timestamp')
ifvalisnotNone:
new.timestamp=datetime.datetime.fromtimestamp(val)
returnnew

classGetPendingJobExecutionsSubscriptionRequest(awsiot.ModeledClass):
"""

 Data needed to subscribe to GetPendingJobExecutions responses.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 thing_name (str): Name of the IoT Thing that you want to subscribe to GetPendingJobExecutions response events for.

 Attributes:
 thing_name (str): Name of the IoT Thing that you want to subscribe to GetPendingJobExecutions response events for.
 """

__slots__= ['thing_name']

def__init__(self, *args, **kwargs):
self.thing_name=kwargs.get('thing_name')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['thing_name'], args):
setattr(self, key, val)

classJobExecutionData(awsiot.ModeledClass):
"""

 Data about a job execution.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 execution_number (int): A number that identifies a job execution on a device. It can be used later in commands that return or update job execution information.
 job_document (typing.Dict[str, typing.Any]): The content of the job document.
 job_id (str): The unique identifier you assigned to this job when it was created.
 last_updated_at (datetime.datetime): The time when the job execution started.
 queued_at (datetime.datetime): The time when the job execution was enqueued.
 started_at (datetime.datetime): The time when the job execution started.
 status (str): The status of the job execution. Can be one of: QUEUED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELED, TIMED_OUT, REJECTED, or REMOVED.
 status_details (typing.Dict[str, str]): A collection of name-value pairs that describe the status of the job execution.
 thing_name (str): The name of the thing that is executing the job.
 version_number (int): The version of the job execution. Job execution versions are incremented each time they are updated by a device.

 Attributes:
 execution_number (int): A number that identifies a job execution on a device. It can be used later in commands that return or update job execution information.
 job_document (typing.Dict[str, typing.Any]): The content of the job document.
 job_id (str): The unique identifier you assigned to this job when it was created.
 last_updated_at (datetime.datetime): The time when the job execution started.
 queued_at (datetime.datetime): The time when the job execution was enqueued.
 started_at (datetime.datetime): The time when the job execution started.
 status (str): The status of the job execution. Can be one of: QUEUED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELED, TIMED_OUT, REJECTED, or REMOVED.
 status_details (typing.Dict[str, str]): A collection of name-value pairs that describe the status of the job execution.
 thing_name (str): The name of the thing that is executing the job.
 version_number (int): The version of the job execution. Job execution versions are incremented each time they are updated by a device.
 """

__slots__= ['execution_number', 'job_document', 'job_id', 'last_updated_at', 'queued_at', 'started_at', 'status', 'status_details', 'thing_name', 'version_number']

def__init__(self, *args, **kwargs):
self.execution_number=kwargs.get('execution_number')
self.job_document=kwargs.get('job_document')
self.job_id=kwargs.get('job_id')
self.last_updated_at=kwargs.get('last_updated_at')
self.queued_at=kwargs.get('queued_at')
self.started_at=kwargs.get('started_at')
self.status=kwargs.get('status')
self.status_details=kwargs.get('status_details')
self.thing_name=kwargs.get('thing_name')
self.version_number=kwargs.get('version_number')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['execution_number', 'job_document', 'job_id', 'last_updated_at', 'queued_at', 'started_at', 'status', 'status_details', 'thing_name', 'version_number'], args):
setattr(self, key, val)

@classmethod
deffrom_payload(cls, payload):
# type: (typing.Dict[str, typing.Any]) -> JobExecutionData
new=cls()
val=payload.get('executionNumber')
ifvalisnotNone:
new.execution_number=val
val=payload.get('jobDocument')
ifvalisnotNone:
new.job_document=val
val=payload.get('jobId')
ifvalisnotNone:
new.job_id=val
val=payload.get('lastUpdatedAt')
ifvalisnotNone:
new.last_updated_at=datetime.datetime.fromtimestamp(val)
val=payload.get('queuedAt')
ifvalisnotNone:
new.queued_at=datetime.datetime.fromtimestamp(val)
val=payload.get('startedAt')
ifvalisnotNone:
new.started_at=datetime.datetime.fromtimestamp(val)
val=payload.get('status')
ifvalisnotNone:
new.status=val
val=payload.get('statusDetails')
ifvalisnotNone:
new.status_details=val
val=payload.get('thingName')
ifvalisnotNone:
new.thing_name=val
val=payload.get('versionNumber')
ifvalisnotNone:
new.version_number=val
returnnew

classJobExecutionState(awsiot.ModeledClass):
"""

 Data about the state of a job execution.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 status (str): The status of the job execution. Can be one of: QUEUED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELED, TIMED_OUT, REJECTED, or REMOVED.
 status_details (typing.Dict[str, str]): A collection of name-value pairs that describe the status of the job execution.
 version_number (int): The version of the job execution. Job execution versions are incremented each time they are updated by a device.

 Attributes:
 status (str): The status of the job execution. Can be one of: QUEUED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELED, TIMED_OUT, REJECTED, or REMOVED.
 status_details (typing.Dict[str, str]): A collection of name-value pairs that describe the status of the job execution.
 version_number (int): The version of the job execution. Job execution versions are incremented each time they are updated by a device.
 """

__slots__= ['status', 'status_details', 'version_number']

def__init__(self, *args, **kwargs):
self.status=kwargs.get('status')
self.status_details=kwargs.get('status_details')
self.version_number=kwargs.get('version_number')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['status', 'status_details', 'version_number'], args):
setattr(self, key, val)

@classmethod
deffrom_payload(cls, payload):
# type: (typing.Dict[str, typing.Any]) -> JobExecutionState
new=cls()
val=payload.get('status')
ifvalisnotNone:
new.status=val
val=payload.get('statusDetails')
ifvalisnotNone:
new.status_details=val
val=payload.get('versionNumber')
ifvalisnotNone:
new.version_number=val
returnnew

classJobExecutionSummary(awsiot.ModeledClass):
"""

 Contains a subset of information about a job execution.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 execution_number (int): A number that identifies a job execution on a device.
 job_id (str): The unique identifier you assigned to this job when it was created.
 last_updated_at (datetime.datetime): The time when the job execution was last updated.
 queued_at (datetime.datetime): The time when the job execution was enqueued.
 started_at (datetime.datetime): The time when the job execution started.
 version_number (int): The version of the job execution. Job execution versions are incremented each time the AWS IoT Jobs service receives an update from a device.

 Attributes:
 execution_number (int): A number that identifies a job execution on a device.
 job_id (str): The unique identifier you assigned to this job when it was created.
 last_updated_at (datetime.datetime): The time when the job execution was last updated.
 queued_at (datetime.datetime): The time when the job execution was enqueued.
 started_at (datetime.datetime): The time when the job execution started.
 version_number (int): The version of the job execution. Job execution versions are incremented each time the AWS IoT Jobs service receives an update from a device.
 """

__slots__= ['execution_number', 'job_id', 'last_updated_at', 'queued_at', 'started_at', 'version_number']

def__init__(self, *args, **kwargs):
self.execution_number=kwargs.get('execution_number')
self.job_id=kwargs.get('job_id')
self.last_updated_at=kwargs.get('last_updated_at')
self.queued_at=kwargs.get('queued_at')
self.started_at=kwargs.get('started_at')
self.version_number=kwargs.get('version_number')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['execution_number', 'job_id', 'last_updated_at', 'queued_at', 'started_at', 'version_number'], args):
setattr(self, key, val)

@classmethod
deffrom_payload(cls, payload):
# type: (typing.Dict[str, typing.Any]) -> JobExecutionSummary
new=cls()
val=payload.get('executionNumber')
ifvalisnotNone:
new.execution_number=val
val=payload.get('jobId')
ifvalisnotNone:
new.job_id=val
val=payload.get('lastUpdatedAt')
ifvalisnotNone:
new.last_updated_at=datetime.datetime.fromtimestamp(val)
val=payload.get('queuedAt')
ifvalisnotNone:
new.queued_at=datetime.datetime.fromtimestamp(val)
val=payload.get('startedAt')
ifvalisnotNone:
new.started_at=datetime.datetime.fromtimestamp(val)
val=payload.get('versionNumber')
ifvalisnotNone:
new.version_number=val
returnnew

classJobExecutionsChangedEvent(awsiot.ModeledClass):
"""

 Sent whenever a job execution is added to or removed from the list of pending job executions for a thing.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 jobs (typing.Dict[str, typing.List[JobExecutionSummary]]): Map from JobStatus to a list of Jobs transitioning to that status.
 timestamp (datetime.datetime): The time when the message was sent.

 Attributes:
 jobs (typing.Dict[str, typing.List[JobExecutionSummary]]): Map from JobStatus to a list of Jobs transitioning to that status.
 timestamp (datetime.datetime): The time when the message was sent.
 """

__slots__= ['jobs', 'timestamp']

def__init__(self, *args, **kwargs):
self.jobs=kwargs.get('jobs')
self.timestamp=kwargs.get('timestamp')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['jobs', 'timestamp'], args):
setattr(self, key, val)

@classmethod
deffrom_payload(cls, payload):
# type: (typing.Dict[str, typing.Any]) -> JobExecutionsChangedEvent
new=cls()
val=payload.get('jobs')
ifvalisnotNone:
new.jobs= {k: [JobExecutionSummary.from_payload(i) foriinv] fork,vinval.items()}
val=payload.get('timestamp')
ifvalisnotNone:
new.timestamp=datetime.datetime.fromtimestamp(val)
returnnew

classJobExecutionsChangedSubscriptionRequest(awsiot.ModeledClass):
"""

 Data needed to subscribe to JobExecutionsChanged events.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 thing_name (str): Name of the IoT Thing that you want to subscribe to JobExecutionsChanged events for.

 Attributes:
 thing_name (str): Name of the IoT Thing that you want to subscribe to JobExecutionsChanged events for.
 """

__slots__= ['thing_name']

def__init__(self, *args, **kwargs):
self.thing_name=kwargs.get('thing_name')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['thing_name'], args):
setattr(self, key, val)

classNextJobExecutionChangedEvent(awsiot.ModeledClass):
"""

 Sent whenever there is a change to which job execution is next on the list of pending job executions for a thing, as defined for DescribeJobExecution with jobId $next. This message is not sent when the next job's execution details change, only when the next job that would be returned by DescribeJobExecution with jobId $next has changed.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 execution (JobExecutionData): Contains data about a job execution.
 timestamp (datetime.datetime): The time when the message was sent.

 Attributes:
 execution (JobExecutionData): Contains data about a job execution.
 timestamp (datetime.datetime): The time when the message was sent.
 """

__slots__= ['execution', 'timestamp']

def__init__(self, *args, **kwargs):
self.execution=kwargs.get('execution')
self.timestamp=kwargs.get('timestamp')

# for backwards compatibility, read any arguments that used to be accepted by position
forkey, valinzip(['execution', 'timestamp'], args):
setattr(self, key, val)

@classmethod
deffrom_payload(cls, payload):
# type: (typing.Dict[str, typing.Any]) -> NextJobExecutionChangedEvent
new=cls()
val=payload.get('execution')
ifvalisnotNone:
new.execution=JobExecutionData.from_payload(val)
val=payload.get('timestamp')
ifvalisnotNone:
new.timestamp=datetime.datetime.fromtimestamp(val)
returnnew

classNextJobExecutionChangedSubscriptionRequest(awsiot.ModeledClass):
"""

 Data needed to subscribe to NextJobExecutionChanged events.

 All attributes are None by default, and may be set by keyword in the constructor.

 Keyword Args:
 thing_name (str): Name of the IoT Thing that you want to subscribe to NextJobExecutionChanged events for.

 Attributes:
 thing_name (str): Name of the IoT Thing that you want to subscribe to NextJobExecutionChanged events for.
 """

__slots__= ['thing_name']

def__init__(self, *args, **kwargs):
self.thing_name=kwargs.get('thing_name')