diff --git a/awsiot/iotidentity.py b/awsiot/iotidentity.py index 406bae2b..3b79b7a3 100644 --- a/awsiot/iotidentity.py +++ b/awsiot/iotidentity.py @@ -8,10 +8,20 @@ import typing class IotIdentityClient(awsiot.MqttServiceClient): + """ + + An AWS IoT service that assists with provisioning a device and installing unique client certificates on it + + AWS Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html + + """ def publish_create_certificate_from_csr(self, request, qos): # type: (CreateCertificateFromCsrRequest, int) -> concurrent.futures.Future """ + + Creates a certificate from a certificate signing request (CSR). AWS IoT provides client certificates that are signed by the Amazon Root certificate authority (CA). The new certificate has a PENDING_ACTIVATION status. When you call RegisterThing to provision a thing with this certificate, the certificate status changes to ACTIVE or INACTIVE as described in the template. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Args: @@ -32,6 +42,9 @@ def publish_create_certificate_from_csr(self, request, qos): def publish_create_keys_and_certificate(self, request, qos): # type: (CreateKeysAndCertificateRequest, int) -> concurrent.futures.Future """ + + Creates new keys and a certificate. AWS IoT provides client certificates that are signed by the Amazon Root certificate authority (CA). The new certificate has a PENDING_ACTIVATION status. When you call RegisterThing to provision a thing with this certificate, the certificate status changes to ACTIVE or INACTIVE as described in the template. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Args: @@ -52,6 +65,9 @@ def publish_create_keys_and_certificate(self, request, qos): def publish_register_thing(self, request, qos): # type: (RegisterThingRequest, int) -> concurrent.futures.Future """ + + Provisions an AWS IoT thing using a pre-defined template. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Args: @@ -74,6 +90,9 @@ def publish_register_thing(self, request, qos): def subscribe_to_create_certificate_from_csr_accepted(self, request, qos, callback): # type: (CreateCertificateFromCsrSubscriptionRequest, int, typing.Callable[[CreateCertificateFromCsrResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the accepted topic of the CreateCertificateFromCsr operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Args: @@ -84,12 +103,11 @@ def subscribe_to_create_certificate_from_csr_accepted(self, request, qos, callba The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not callable(callback): @@ -104,6 +122,9 @@ def subscribe_to_create_certificate_from_csr_accepted(self, request, qos, callba def subscribe_to_create_certificate_from_csr_rejected(self, request, qos, callback): # type: (CreateCertificateFromCsrSubscriptionRequest, int, typing.Callable[[ErrorResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the rejected topic of the CreateCertificateFromCsr operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Args: @@ -114,12 +135,11 @@ def subscribe_to_create_certificate_from_csr_rejected(self, request, qos, callba The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not callable(callback): @@ -134,6 +154,9 @@ def subscribe_to_create_certificate_from_csr_rejected(self, request, qos, callba def subscribe_to_create_keys_and_certificate_accepted(self, request, qos, callback): # type: (CreateKeysAndCertificateSubscriptionRequest, int, typing.Callable[[CreateKeysAndCertificateResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the accepted topic of the CreateKeysAndCertificate operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Args: @@ -144,12 +167,11 @@ def subscribe_to_create_keys_and_certificate_accepted(self, request, qos, callba The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not callable(callback): @@ -164,6 +186,9 @@ def subscribe_to_create_keys_and_certificate_accepted(self, request, qos, callba def subscribe_to_create_keys_and_certificate_rejected(self, request, qos, callback): # type: (CreateKeysAndCertificateSubscriptionRequest, int, typing.Callable[[ErrorResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the rejected topic of the CreateKeysAndCertificate operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Args: @@ -174,12 +199,11 @@ def subscribe_to_create_keys_and_certificate_rejected(self, request, qos, callba The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not callable(callback): @@ -194,6 +218,9 @@ def subscribe_to_create_keys_and_certificate_rejected(self, request, qos, callba def subscribe_to_register_thing_accepted(self, request, qos, callback): # type: (RegisterThingSubscriptionRequest, int, typing.Callable[[RegisterThingResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the accepted topic of the RegisterThing operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Args: @@ -204,12 +231,11 @@ def subscribe_to_register_thing_accepted(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.template_name: raise ValueError("request.template_name is required") @@ -226,6 +252,9 @@ def subscribe_to_register_thing_accepted(self, request, qos, callback): def subscribe_to_register_thing_rejected(self, request, qos, callback): # type: (RegisterThingSubscriptionRequest, int, typing.Callable[[ErrorResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the rejected topic of the RegisterThing operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Args: @@ -236,12 +265,11 @@ def subscribe_to_register_thing_rejected(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.template_name: raise ValueError("request.template_name is required") @@ -257,13 +285,16 @@ def subscribe_to_register_thing_rejected(self, request, qos, callback): class CreateCertificateFromCsrRequest(awsiot.ModeledClass): """ + + Data needed to perform a CreateCertificateFromCsr operation. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - certificate_signing_request (str) + certificate_signing_request (str): The CSR, in PEM format. Attributes: - certificate_signing_request (str) + certificate_signing_request (str): The CSR, in PEM format. """ __slots__ = ['certificate_signing_request'] @@ -284,17 +315,20 @@ def to_payload(self): class CreateCertificateFromCsrResponse(awsiot.ModeledClass): """ + + Response payload to a CreateCertificateFromCsr request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - certificate_id (str) - certificate_ownership_token (str) - certificate_pem (str) + certificate_id (str): The ID of the certificate. + certificate_ownership_token (str): The token to prove ownership of the certificate during provisioning. + certificate_pem (str): The certificate data, in PEM format. Attributes: - certificate_id (str) - certificate_ownership_token (str) - certificate_pem (str) + certificate_id (str): The ID of the certificate. + certificate_ownership_token (str): The token to prove ownership of the certificate during provisioning. + certificate_pem (str): The certificate data, in PEM format. """ __slots__ = ['certificate_id', 'certificate_ownership_token', 'certificate_pem'] @@ -325,6 +359,9 @@ def from_payload(cls, payload): class CreateCertificateFromCsrSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to the responses of the CreateCertificateFromCsr operation. + This class has no attributes. """ @@ -338,6 +375,9 @@ def __init__(self, *args, **kwargs): class CreateKeysAndCertificateRequest(awsiot.ModeledClass): """ + + Data needed to perform a CreateKeysAndCertificate operation. + This class has no attributes. """ @@ -351,19 +391,22 @@ def __init__(self, *args, **kwargs): class CreateKeysAndCertificateResponse(awsiot.ModeledClass): """ + + Response payload to a CreateKeysAndCertificate request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - certificate_id (str) - certificate_ownership_token (str) - certificate_pem (str) - private_key (str) + certificate_id (str): The certificate id. + certificate_ownership_token (str): The token to prove ownership of the certificate during provisioning. + certificate_pem (str): The certificate data, in PEM format. + private_key (str): The private key. Attributes: - certificate_id (str) - certificate_ownership_token (str) - certificate_pem (str) - private_key (str) + certificate_id (str): The certificate id. + certificate_ownership_token (str): The token to prove ownership of the certificate during provisioning. + certificate_pem (str): The certificate data, in PEM format. + private_key (str): The private key. """ __slots__ = ['certificate_id', 'certificate_ownership_token', 'certificate_pem', 'private_key'] @@ -398,6 +441,9 @@ def from_payload(cls, payload): class CreateKeysAndCertificateSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to the responses of the CreateKeysAndCertificate operation. + This class has no attributes. """ @@ -411,17 +457,20 @@ def __init__(self, *args, **kwargs): class ErrorResponse(awsiot.ModeledClass): """ + + Response document containing details about a failed request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - error_code (str) - error_message (str) - status_code (int) + error_code (str): Response error code + error_message (str): Response error message + status_code (int): Response status code Attributes: - error_code (str) - error_message (str) - status_code (int) + error_code (str): Response error code + error_message (str): Response error message + status_code (int): Response status code """ __slots__ = ['error_code', 'error_message', 'status_code'] @@ -452,17 +501,20 @@ def from_payload(cls, payload): class RegisterThingRequest(awsiot.ModeledClass): """ + + Data needed to perform a RegisterThing operation. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - certificate_ownership_token (str) - parameters (typing.Dict[str, str]) - template_name (str) + certificate_ownership_token (str): The token to prove ownership of the certificate. The token is generated by AWS IoT when you create a certificate over MQTT. + parameters (typing.Dict[str, str]): Optional. Key-value pairs from the device that are used by the pre-provisioning hooks to evaluate the registration request. + template_name (str): The provisioning template name. Attributes: - certificate_ownership_token (str) - parameters (typing.Dict[str, str]) - template_name (str) + certificate_ownership_token (str): The token to prove ownership of the certificate. The token is generated by AWS IoT when you create a certificate over MQTT. + parameters (typing.Dict[str, str]): Optional. Key-value pairs from the device that are used by the pre-provisioning hooks to evaluate the registration request. + template_name (str): The provisioning template name. """ __slots__ = ['certificate_ownership_token', 'parameters', 'template_name'] @@ -487,15 +539,18 @@ def to_payload(self): class RegisterThingResponse(awsiot.ModeledClass): """ + + Response payload to a RegisterThing request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - device_configuration (typing.Dict[str, str]) - thing_name (str) + device_configuration (typing.Dict[str, str]): The device configuration defined in the template. + thing_name (str): The name of the IoT thing created during provisioning. Attributes: - device_configuration (typing.Dict[str, str]) - thing_name (str) + device_configuration (typing.Dict[str, str]): The device configuration defined in the template. + thing_name (str): The name of the IoT thing created during provisioning. """ __slots__ = ['device_configuration', 'thing_name'] @@ -522,13 +577,16 @@ def from_payload(cls, payload): class RegisterThingSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to the responses of the RegisterThing operation. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - template_name (str) + template_name (str): Name of the provisioning template to listen for RegisterThing responses for. Attributes: - template_name (str) + template_name (str): Name of the provisioning template to listen for RegisterThing responses for. """ __slots__ = ['template_name'] diff --git a/awsiot/iotjobs.py b/awsiot/iotjobs.py index cfae4438..018c3da3 100644 --- a/awsiot/iotjobs.py +++ b/awsiot/iotjobs.py @@ -9,10 +9,20 @@ import typing class IotJobsClient(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 + + """ def publish_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: @@ -37,6 +47,9 @@ def publish_describe_job_execution(self, request, qos): def publish_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: @@ -59,6 +72,9 @@ def publish_get_pending_job_executions(self, request, qos): def publish_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: @@ -81,6 +97,9 @@ def publish_start_next_pending_job_execution(self, request, qos): def publish_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: @@ -105,6 +124,9 @@ def publish_update_job_execution(self, request, qos): def subscribe_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: @@ -115,12 +137,11 @@ def subscribe_to_describe_job_execution_accepted(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -139,6 +160,9 @@ def subscribe_to_describe_job_execution_accepted(self, request, qos, callback): def subscribe_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: @@ -149,12 +173,11 @@ def subscribe_to_describe_job_execution_rejected(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -173,6 +196,9 @@ def subscribe_to_describe_job_execution_rejected(self, request, qos, callback): def subscribe_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: @@ -183,12 +209,11 @@ def subscribe_to_get_pending_job_executions_accepted(self, request, qos, callbac The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -205,6 +230,9 @@ def subscribe_to_get_pending_job_executions_accepted(self, request, qos, callbac def subscribe_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: @@ -215,12 +243,11 @@ def subscribe_to_get_pending_job_executions_rejected(self, request, qos, callbac The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -237,6 +264,9 @@ def subscribe_to_get_pending_job_executions_rejected(self, request, qos, callbac def subscribe_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: @@ -247,12 +277,11 @@ def subscribe_to_job_executions_changed_events(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -269,6 +298,7 @@ def subscribe_to_job_executions_changed_events(self, request, qos, callback): def subscribe_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: @@ -279,12 +309,11 @@ def subscribe_to_next_job_execution_changed_events(self, request, qos, callback) The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -301,6 +330,9 @@ def subscribe_to_next_job_execution_changed_events(self, request, qos, callback) def subscribe_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: @@ -311,12 +343,11 @@ def subscribe_to_start_next_pending_job_execution_accepted(self, request, qos, c The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -333,6 +364,9 @@ def subscribe_to_start_next_pending_job_execution_accepted(self, request, qos, c def subscribe_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: @@ -343,12 +377,11 @@ def subscribe_to_start_next_pending_job_execution_rejected(self, request, qos, c The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -365,6 +398,9 @@ def subscribe_to_start_next_pending_job_execution_rejected(self, request, qos, c def subscribe_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: @@ -375,12 +411,11 @@ def subscribe_to_update_job_execution_accepted(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.job_id: raise ValueError("request.job_id is required") @@ -399,6 +434,9 @@ def subscribe_to_update_job_execution_accepted(self, request, qos, callback): def subscribe_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: @@ -409,12 +447,11 @@ def subscribe_to_update_job_execution_rejected(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.job_id: raise ValueError("request.job_id is required") @@ -432,21 +469,24 @@ def subscribe_to_update_job_execution_rejected(self, request, qos, callback): class DescribeJobExecutionRequest(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) - execution_number (int) - include_job_document (bool) - job_id (str) - thing_name (str) + 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) - execution_number (int) - include_job_document (bool) - job_id (str) - thing_name (str) + 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'] @@ -475,17 +515,20 @@ def to_payload(self): class DescribeJobExecutionResponse(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) - execution (JobExecutionData) - timestamp (datetime.datetime) + 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) - execution (JobExecutionData) - timestamp (datetime.datetime) + 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'] @@ -516,15 +559,18 @@ def from_payload(cls, payload): class DescribeJobExecutionSubscriptionRequest(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) - thing_name (str) + 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) - thing_name (str) + 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'] @@ -539,15 +585,18 @@ def __init__(self, *args, **kwargs): class GetPendingJobExecutionsRequest(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) - thing_name (str) + 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) - thing_name (str) + 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'] @@ -569,19 +618,22 @@ def to_payload(self): class GetPendingJobExecutionsResponse(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) - in_progress_jobs (typing.List[JobExecutionSummary]) - queued_jobs (typing.List[JobExecutionSummary]) - timestamp (datetime.datetime) + 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) - in_progress_jobs (typing.List[JobExecutionSummary]) - queued_jobs (typing.List[JobExecutionSummary]) - timestamp (datetime.datetime) + 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'] @@ -616,13 +668,16 @@ def from_payload(cls, payload): class GetPendingJobExecutionsSubscriptionRequest(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) + thing_name (str): Name of the IoT Thing that you want to subscribe to GetPendingJobExecutions response events for. Attributes: - thing_name (str) + thing_name (str): Name of the IoT Thing that you want to subscribe to GetPendingJobExecutions response events for. """ __slots__ = ['thing_name'] @@ -636,31 +691,34 @@ def __init__(self, *args, **kwargs): class JobExecutionData(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) - job_document (typing.Dict[str, typing.Any]) - job_id (str) - last_updated_at (datetime.datetime) - queued_at (datetime.datetime) - started_at (datetime.datetime) - status (str) - status_details (typing.Dict[str, str]) - thing_name (str) - version_number (int) + 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) - job_document (typing.Dict[str, typing.Any]) - job_id (str) - last_updated_at (datetime.datetime) - queued_at (datetime.datetime) - started_at (datetime.datetime) - status (str) - status_details (typing.Dict[str, str]) - thing_name (str) - version_number (int) + 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'] @@ -719,17 +777,20 @@ def from_payload(cls, payload): class JobExecutionState(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) - status_details (typing.Dict[str, str]) - version_number (int) + 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) - status_details (typing.Dict[str, str]) - version_number (int) + 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'] @@ -760,23 +821,26 @@ def from_payload(cls, payload): class JobExecutionSummary(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) - job_id (str) - last_updated_at (datetime.datetime) - queued_at (datetime.datetime) - started_at (datetime.datetime) - version_number (int) + 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) - job_id (str) - last_updated_at (datetime.datetime) - queued_at (datetime.datetime) - started_at (datetime.datetime) - version_number (int) + 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'] @@ -819,15 +883,18 @@ def from_payload(cls, payload): class JobExecutionsChangedEvent(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]]) - timestamp (datetime.datetime) + 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]]) - timestamp (datetime.datetime) + 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'] @@ -854,13 +921,16 @@ def from_payload(cls, payload): class JobExecutionsChangedSubscriptionRequest(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) + thing_name (str): Name of the IoT Thing that you want to subscribe to JobExecutionsChanged events for. Attributes: - thing_name (str) + thing_name (str): Name of the IoT Thing that you want to subscribe to JobExecutionsChanged events for. """ __slots__ = ['thing_name'] @@ -872,27 +942,20 @@ def __init__(self, *args, **kwargs): for key, val in zip(['thing_name'], args): setattr(self, key, val) -class JobStatus: - CANCELED = 'CANCELED' - FAILED = 'FAILED' - QUEUED = 'QUEUED' - IN_PROGRESS = 'IN_PROGRESS' - SUCCEEDED = 'SUCCEEDED' - TIMED_OUT = 'TIMED_OUT' - REJECTED = 'REJECTED' - REMOVED = 'REMOVED' - class NextJobExecutionChangedEvent(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) - timestamp (datetime.datetime) + execution (JobExecutionData): Contains data about a job execution. + timestamp (datetime.datetime): The time when the message was sent. Attributes: - execution (JobExecutionData) - timestamp (datetime.datetime) + execution (JobExecutionData): Contains data about a job execution. + timestamp (datetime.datetime): The time when the message was sent. """ __slots__ = ['execution', 'timestamp'] @@ -919,13 +982,16 @@ def from_payload(cls, payload): class NextJobExecutionChangedSubscriptionRequest(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) + thing_name (str): Name of the IoT Thing that you want to subscribe to NextJobExecutionChanged events for. Attributes: - thing_name (str) + thing_name (str): Name of the IoT Thing that you want to subscribe to NextJobExecutionChanged events for. """ __slots__ = ['thing_name'] @@ -939,21 +1005,24 @@ def __init__(self, *args, **kwargs): class RejectedError(awsiot.ModeledClass): """ + + Response document containing details about a failed request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - code (str) - execution_state (JobExecutionState) - message (str) - timestamp (datetime.datetime) + client_token (str): Opaque token that can correlate this response to the original request. + code (str): Indicates the type of error. + execution_state (JobExecutionState): A JobExecutionState object. This field is included only when the code field has the value InvalidStateTransition or VersionMismatch. + message (str): A text message that provides additional information. + timestamp (datetime.datetime): The date and time the response was generated by AWS IoT. Attributes: - client_token (str) - code (str) - execution_state (JobExecutionState) - message (str) - timestamp (datetime.datetime) + client_token (str): Opaque token that can correlate this response to the original request. + code (str): Indicates the type of error. + execution_state (JobExecutionState): A JobExecutionState object. This field is included only when the code field has the value InvalidStateTransition or VersionMismatch. + message (str): A text message that provides additional information. + timestamp (datetime.datetime): The date and time the response was generated by AWS IoT. """ __slots__ = ['client_token', 'code', 'execution_state', 'message', 'timestamp'] @@ -990,30 +1059,22 @@ def from_payload(cls, payload): new.timestamp = datetime.datetime.fromtimestamp(val) return new -class RejectedErrorCode: - INTERNAL_ERROR = 'InternalError' - INVALID_JSON = 'InvalidJson' - INVALID_REQUEST = 'InvalidRequest' - INVALID_STATE_TRANSITION = 'InvalidStateTransition' - RESOURCE_NOT_FOUND = 'ResourceNotFound' - VERSION_MISMATCH = 'VersionMismatch' - INVALID_TOPIC = 'InvalidTopic' - REQUEST_THROTTLED = 'RequestThrottled' - TERMINAL_STATE_REACHED = 'TerminalStateReached' - class StartNextJobExecutionResponse(awsiot.ModeledClass): """ + + Response payload to a StartNextJobExecution request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - execution (JobExecutionData) - timestamp (datetime.datetime) + 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 to the device. Attributes: - client_token (str) - execution (JobExecutionData) - timestamp (datetime.datetime) + 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 to the device. """ __slots__ = ['client_token', 'execution', 'timestamp'] @@ -1044,19 +1105,22 @@ def from_payload(cls, payload): class StartNextPendingJobExecutionRequest(awsiot.ModeledClass): """ + + Data needed to make a StartNextPendingJobExecution request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - status_details (typing.Dict[str, str]) - step_timeout_in_minutes (int) - thing_name (str) + 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. + status_details (typing.Dict[str, str]): A collection of name-value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. + step_timeout_in_minutes (int): Specifies the amount of time this device has to finish execution of this job. + thing_name (str): IoT Thing the request is relative to. Attributes: - client_token (str) - status_details (typing.Dict[str, str]) - step_timeout_in_minutes (int) - thing_name (str) + 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. + status_details (typing.Dict[str, str]): A collection of name-value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. + step_timeout_in_minutes (int): Specifies the amount of time this device has to finish execution of this job. + thing_name (str): IoT Thing the request is relative to. """ __slots__ = ['client_token', 'status_details', 'step_timeout_in_minutes', 'thing_name'] @@ -1084,13 +1148,16 @@ def to_payload(self): class StartNextPendingJobExecutionSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to StartNextPendingJobExecution responses. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - thing_name (str) + thing_name (str): Name of the IoT Thing that you want to subscribe to StartNextPendingJobExecution response events for. Attributes: - thing_name (str) + thing_name (str): Name of the IoT Thing that you want to subscribe to StartNextPendingJobExecution response events for. """ __slots__ = ['thing_name'] @@ -1104,31 +1171,34 @@ def __init__(self, *args, **kwargs): class UpdateJobExecutionRequest(awsiot.ModeledClass): """ + + Data needed to make an UpdateJobExecution request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - execution_number (int) - expected_version (int) - include_job_document (bool) - include_job_execution_state (bool) - job_id (str) - status (str) - status_details (typing.Dict[str, str]) - step_timeout_in_minutes (int) - thing_name (str) + client_token (str): A client token 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 used. + expected_version (int): 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 the AWS IoT Jobs service does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. + include_job_document (bool): Optional. When included and set to true, the response contains the JobDocument. The default is false. + include_job_execution_state (bool): Optional. When included and set to true, the response contains the JobExecutionState field. The default is false. + job_id (str): The unique identifier assigned to this job when it was created. + status (str): The new status for the job execution (IN_PROGRESS, FAILED, SUCCEEDED, or REJECTED). This must be specified on every update. + status_details (typing.Dict[str, str]): A collection of name-value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. + step_timeout_in_minutes (int): 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 is set to TIMED_OUT. Setting or resetting this timeout has no effect on the job execution timeout that might have been specified when the job was created (by using CreateJob with the timeoutConfig). + thing_name (str): The name of the thing associated with the device. Attributes: - client_token (str) - execution_number (int) - expected_version (int) - include_job_document (bool) - include_job_execution_state (bool) - job_id (str) - status (str) - status_details (typing.Dict[str, str]) - step_timeout_in_minutes (int) - thing_name (str) + client_token (str): A client token 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 used. + expected_version (int): 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 the AWS IoT Jobs service does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. + include_job_document (bool): Optional. When included and set to true, the response contains the JobDocument. The default is false. + include_job_execution_state (bool): Optional. When included and set to true, the response contains the JobExecutionState field. The default is false. + job_id (str): The unique identifier assigned to this job when it was created. + status (str): The new status for the job execution (IN_PROGRESS, FAILED, SUCCEEDED, or REJECTED). This must be specified on every update. + status_details (typing.Dict[str, str]): A collection of name-value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. + step_timeout_in_minutes (int): 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 is set to TIMED_OUT. Setting or resetting this timeout has no effect on the job execution timeout that might have been specified when the job was created (by using CreateJob with the timeoutConfig). + thing_name (str): The name of the thing associated with the device. """ __slots__ = ['client_token', 'execution_number', 'expected_version', 'include_job_document', 'include_job_execution_state', 'job_id', 'status', 'status_details', 'step_timeout_in_minutes', 'thing_name'] @@ -1172,19 +1242,22 @@ def to_payload(self): class UpdateJobExecutionResponse(awsiot.ModeledClass): """ + + Response payload to an UpdateJobExecution request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - execution_state (JobExecutionState) - job_document (typing.Dict[str, typing.Any]) - timestamp (datetime.datetime) + client_token (str): A client token used to correlate requests and responses. + execution_state (JobExecutionState): Contains data about the state of a job execution. + job_document (typing.Dict[str, typing.Any]): A UTF-8 encoded JSON document that contains information that your devices need to perform the job. + timestamp (datetime.datetime): The time when the message was sent. Attributes: - client_token (str) - execution_state (JobExecutionState) - job_document (typing.Dict[str, typing.Any]) - timestamp (datetime.datetime) + client_token (str): A client token used to correlate requests and responses. + execution_state (JobExecutionState): Contains data about the state of a job execution. + job_document (typing.Dict[str, typing.Any]): A UTF-8 encoded JSON document that contains information that your devices need to perform the job. + timestamp (datetime.datetime): The time when the message was sent. """ __slots__ = ['client_token', 'execution_state', 'job_document', 'timestamp'] @@ -1219,15 +1292,18 @@ def from_payload(cls, payload): class UpdateJobExecutionSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to UpdateJobExecution responses. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - job_id (str) - thing_name (str) + job_id (str): Job ID that you want to subscribe to UpdateJobExecution response events for. + thing_name (str): Name of the IoT Thing that you want to subscribe to UpdateJobExecution response events for. Attributes: - job_id (str) - thing_name (str) + job_id (str): Job ID that you want to subscribe to UpdateJobExecution response events for. + thing_name (str): Name of the IoT Thing that you want to subscribe to UpdateJobExecution response events for. """ __slots__ = ['job_id', 'thing_name'] @@ -1240,3 +1316,94 @@ def __init__(self, *args, **kwargs): for key, val in zip(['job_id', 'thing_name'], args): setattr(self, key, val) +class JobStatus: + """ + + The status of the job execution. + + """ + + CANCELED = 'CANCELED' + """ + """ + + FAILED = 'FAILED' + """ + """ + + QUEUED = 'QUEUED' + """ + """ + + IN_PROGRESS = 'IN_PROGRESS' + """ + """ + + SUCCEEDED = 'SUCCEEDED' + """ + """ + + TIMED_OUT = 'TIMED_OUT' + """ + """ + + REJECTED = 'REJECTED' + """ + """ + + REMOVED = 'REMOVED' + """ + """ + +class RejectedErrorCode: + """ + + A value indicating the kind of error encountered while processing an AWS IoT Jobs request + + """ + + INTERNAL_ERROR = 'InternalError' + """ + There was an internal error during the processing of the request. + """ + + INVALID_JSON = 'InvalidJson' + """ + The contents of the request could not be interpreted as valid UTF-8-encoded JSON. + """ + + INVALID_REQUEST = 'InvalidRequest' + """ + The contents of the request were invalid. The message contains details about the error. + """ + + INVALID_STATE_TRANSITION = 'InvalidStateTransition' + """ + An update attempted to change the job execution to a state that is invalid because of the job execution's current state. In this case, the body of the error message also contains the executionState field. + """ + + RESOURCE_NOT_FOUND = 'ResourceNotFound' + """ + The JobExecution specified by the request topic does not exist. + """ + + VERSION_MISMATCH = 'VersionMismatch' + """ + The expected version specified in the request does not match the version of the job execution in the AWS IoT Jobs service. In this case, the body of the error message also contains the executionState field. + """ + + INVALID_TOPIC = 'InvalidTopic' + """ + The request was sent to a topic in the AWS IoT Jobs namespace that does not map to any API. + """ + + REQUEST_THROTTLED = 'RequestThrottled' + """ + The request was throttled. + """ + + TERMINAL_STATE_REACHED = 'TerminalStateReached' + """ + Occurs when a command to describe a job is performed on a job that is in a terminal state. + """ + diff --git a/awsiot/iotshadow.py b/awsiot/iotshadow.py index 587bc039..eddc8bd0 100644 --- a/awsiot/iotshadow.py +++ b/awsiot/iotshadow.py @@ -9,10 +9,20 @@ import typing class IotShadowClient(awsiot.MqttServiceClient): + """ + + The AWS IoT Device Shadow service adds shadows to AWS IoT thing objects. Shadows are a simple data store for device properties and state. Shadows can make a device’s state available to apps and other services whether the device is connected to AWS IoT or not. + + AWS Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html + + """ def publish_delete_named_shadow(self, request, qos): # type: (DeleteNamedShadowRequest, int) -> concurrent.futures.Future """ + + Deletes a named shadow for an AWS IoT thing. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic Args: @@ -37,6 +47,9 @@ def publish_delete_named_shadow(self, request, qos): def publish_delete_shadow(self, request, qos): # type: (DeleteShadowRequest, int) -> concurrent.futures.Future """ + + Deletes the (classic) shadow for an AWS IoT thing. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic Args: @@ -59,6 +72,9 @@ def publish_delete_shadow(self, request, qos): def publish_get_named_shadow(self, request, qos): # type: (GetNamedShadowRequest, int) -> concurrent.futures.Future """ + + Gets a named shadow for an AWS IoT thing. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic Args: @@ -83,6 +99,9 @@ def publish_get_named_shadow(self, request, qos): def publish_get_shadow(self, request, qos): # type: (GetShadowRequest, int) -> concurrent.futures.Future """ + + Gets the (classic) shadow for an AWS IoT thing. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic Args: @@ -105,6 +124,9 @@ def publish_get_shadow(self, request, qos): def publish_update_named_shadow(self, request, qos): # type: (UpdateNamedShadowRequest, int) -> concurrent.futures.Future """ + + Update a named shadow for a device. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic Args: @@ -129,6 +151,9 @@ def publish_update_named_shadow(self, request, qos): def publish_update_shadow(self, request, qos): # type: (UpdateShadowRequest, int) -> concurrent.futures.Future """ + + Update a device's (classic) shadow. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic Args: @@ -151,6 +176,9 @@ def publish_update_shadow(self, request, qos): def subscribe_to_delete_named_shadow_accepted(self, request, qos, callback): # type: (DeleteNamedShadowSubscriptionRequest, int, typing.Callable[[DeleteShadowResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the accepted topic for the DeleteNamedShadow operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-accepted-pub-sub-topic Args: @@ -161,12 +189,11 @@ def subscribe_to_delete_named_shadow_accepted(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -185,6 +212,9 @@ def subscribe_to_delete_named_shadow_accepted(self, request, qos, callback): def subscribe_to_delete_named_shadow_rejected(self, request, qos, callback): # type: (DeleteNamedShadowSubscriptionRequest, int, typing.Callable[[ErrorResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the rejected topic for the DeleteNamedShadow operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-rejected-pub-sub-topic Args: @@ -195,12 +225,11 @@ def subscribe_to_delete_named_shadow_rejected(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -219,6 +248,9 @@ def subscribe_to_delete_named_shadow_rejected(self, request, qos, callback): def subscribe_to_delete_shadow_accepted(self, request, qos, callback): # type: (DeleteShadowSubscriptionRequest, int, typing.Callable[[DeleteShadowResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the accepted topic for the DeleteShadow operation + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-accepted-pub-sub-topic Args: @@ -229,12 +261,11 @@ def subscribe_to_delete_shadow_accepted(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -251,6 +282,9 @@ def subscribe_to_delete_shadow_accepted(self, request, qos, callback): def subscribe_to_delete_shadow_rejected(self, request, qos, callback): # type: (DeleteShadowSubscriptionRequest, int, typing.Callable[[ErrorResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the rejected topic for the DeleteShadow operation + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-rejected-pub-sub-topic Args: @@ -261,12 +295,11 @@ def subscribe_to_delete_shadow_rejected(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -283,6 +316,9 @@ def subscribe_to_delete_shadow_rejected(self, request, qos, callback): def subscribe_to_get_named_shadow_accepted(self, request, qos, callback): # type: (GetNamedShadowSubscriptionRequest, int, typing.Callable[[GetShadowResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the accepted topic for the GetNamedShadow operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-accepted-pub-sub-topic Args: @@ -293,12 +329,11 @@ def subscribe_to_get_named_shadow_accepted(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -317,6 +352,9 @@ def subscribe_to_get_named_shadow_accepted(self, request, qos, callback): def subscribe_to_get_named_shadow_rejected(self, request, qos, callback): # type: (GetNamedShadowSubscriptionRequest, int, typing.Callable[[ErrorResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the rejected topic for the GetNamedShadow operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-rejected-pub-sub-topic Args: @@ -327,12 +365,11 @@ def subscribe_to_get_named_shadow_rejected(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -351,6 +388,9 @@ def subscribe_to_get_named_shadow_rejected(self, request, qos, callback): def subscribe_to_get_shadow_accepted(self, request, qos, callback): # type: (GetShadowSubscriptionRequest, int, typing.Callable[[GetShadowResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the accepted topic for the GetShadow operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-accepted-pub-sub-topic Args: @@ -361,12 +401,11 @@ def subscribe_to_get_shadow_accepted(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -383,6 +422,9 @@ def subscribe_to_get_shadow_accepted(self, request, qos, callback): def subscribe_to_get_shadow_rejected(self, request, qos, callback): # type: (GetShadowSubscriptionRequest, int, typing.Callable[[ErrorResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the rejected topic for the GetShadow operation. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-rejected-pub-sub-topic Args: @@ -393,12 +435,11 @@ def subscribe_to_get_shadow_rejected(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -415,6 +456,9 @@ def subscribe_to_get_shadow_rejected(self, request, qos, callback): def subscribe_to_named_shadow_delta_updated_events(self, request, qos, callback): # type: (NamedShadowDeltaUpdatedSubscriptionRequest, int, typing.Callable[[ShadowDeltaUpdatedEvent], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribe to NamedShadowDelta events for a named shadow of an AWS IoT thing. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic Args: @@ -425,12 +469,11 @@ def subscribe_to_named_shadow_delta_updated_events(self, request, qos, callback) The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -449,6 +492,9 @@ def subscribe_to_named_shadow_delta_updated_events(self, request, qos, callback) def subscribe_to_named_shadow_updated_events(self, request, qos, callback): # type: (NamedShadowUpdatedSubscriptionRequest, int, typing.Callable[[ShadowUpdatedEvent], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribe to ShadowUpdated events for a named shadow of an AWS IoT thing. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic Args: @@ -459,12 +505,11 @@ def subscribe_to_named_shadow_updated_events(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.shadow_name: raise ValueError("request.shadow_name is required") @@ -483,6 +528,9 @@ def subscribe_to_named_shadow_updated_events(self, request, qos, callback): def subscribe_to_shadow_delta_updated_events(self, request, qos, callback): # type: (ShadowDeltaUpdatedSubscriptionRequest, int, typing.Callable[[ShadowDeltaUpdatedEvent], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribe to ShadowDelta events for the (classic) shadow of an AWS IoT thing. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic Args: @@ -493,12 +541,11 @@ def subscribe_to_shadow_delta_updated_events(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -515,6 +562,9 @@ def subscribe_to_shadow_delta_updated_events(self, request, qos, callback): def subscribe_to_shadow_updated_events(self, request, qos, callback): # type: (ShadowUpdatedSubscriptionRequest, int, typing.Callable[[ShadowUpdatedEvent], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribe to ShadowUpdated events for the (classic) shadow of an AWS IoT thing. + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic Args: @@ -525,12 +575,11 @@ def subscribe_to_shadow_updated_events(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -547,6 +596,9 @@ def subscribe_to_shadow_updated_events(self, request, qos, callback): def subscribe_to_update_named_shadow_accepted(self, request, qos, callback): # type: (UpdateNamedShadowSubscriptionRequest, int, typing.Callable[[UpdateShadowResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the accepted topic for the UpdateNamedShadow operation + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-accepted-pub-sub-topic Args: @@ -557,12 +609,11 @@ def subscribe_to_update_named_shadow_accepted(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -581,6 +632,9 @@ def subscribe_to_update_named_shadow_accepted(self, request, qos, callback): def subscribe_to_update_named_shadow_rejected(self, request, qos, callback): # type: (UpdateNamedShadowSubscriptionRequest, int, typing.Callable[[ErrorResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the rejected topic for the UpdateNamedShadow operation + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-rejected-pub-sub-topic Args: @@ -591,12 +645,11 @@ def subscribe_to_update_named_shadow_rejected(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -615,6 +668,9 @@ def subscribe_to_update_named_shadow_rejected(self, request, qos, callback): def subscribe_to_update_shadow_accepted(self, request, qos, callback): # type: (UpdateShadowSubscriptionRequest, int, typing.Callable[[UpdateShadowResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the accepted topic for the UpdateShadow operation + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-accepted-pub-sub-topic Args: @@ -625,12 +681,11 @@ def subscribe_to_update_shadow_accepted(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -647,6 +702,9 @@ def subscribe_to_update_shadow_accepted(self, request, qos, callback): def subscribe_to_update_shadow_rejected(self, request, qos, callback): # type: (UpdateShadowSubscriptionRequest, int, typing.Callable[[ErrorResponse], None]) -> typing.Tuple[concurrent.futures.Future, str] """ + + Subscribes to the rejected topic for the UpdateShadow operation + API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-rejected-pub-sub-topic Args: @@ -657,12 +715,11 @@ def subscribe_to_update_shadow_rejected(self, request, qos, callback): The callback is not expected to return anything. Returns: - Tuple with two values. The first is a Future - which will contain a result of `None` when the server has acknowledged - the subscription, 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. + 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. """ if not request.thing_name: raise ValueError("request.thing_name is required") @@ -678,17 +735,20 @@ def subscribe_to_update_shadow_rejected(self, request, qos, callback): class DeleteNamedShadowRequest(awsiot.ModeledClass): """ + + Data needed to make a DeleteNamedShadow request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - shadow_name (str) - thing_name (str) + 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. + shadow_name (str): Name of the shadow to delete. + thing_name (str): AWS IoT thing to delete a named shadow from. Attributes: - client_token (str) - shadow_name (str) - thing_name (str) + 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. + shadow_name (str): Name of the shadow to delete. + thing_name (str): AWS IoT thing to delete a named shadow from. """ __slots__ = ['client_token', 'shadow_name', 'thing_name'] @@ -711,15 +771,18 @@ def to_payload(self): class DeleteNamedShadowSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to DeleteNamedShadow responses for an AWS IoT thing. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - shadow_name (str) - thing_name (str) + shadow_name (str): Name of the shadow to subscribe to DeleteNamedShadow operations for. + thing_name (str): AWS IoT thing to subscribe to DeleteNamedShadow operations for. Attributes: - shadow_name (str) - thing_name (str) + shadow_name (str): Name of the shadow to subscribe to DeleteNamedShadow operations for. + thing_name (str): AWS IoT thing to subscribe to DeleteNamedShadow operations for. """ __slots__ = ['shadow_name', 'thing_name'] @@ -734,15 +797,18 @@ def __init__(self, *args, **kwargs): class DeleteShadowRequest(awsiot.ModeledClass): """ + + Data needed to make a DeleteShadow request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - thing_name (str) + 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): AWS IoT thing to delete the (classic) shadow of. Attributes: - client_token (str) - thing_name (str) + 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): AWS IoT thing to delete the (classic) shadow of. """ __slots__ = ['client_token', 'thing_name'] @@ -764,17 +830,20 @@ def to_payload(self): class DeleteShadowResponse(awsiot.ModeledClass): """ + + Response payload to a DeleteShadow request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - timestamp (datetime.datetime) - version (int) + client_token (str): A client token used to correlate requests and responses. + timestamp (datetime.datetime): The time the response was generated by AWS IoT. + version (int): The current version of the document for the device's shadow. Attributes: - client_token (str) - timestamp (datetime.datetime) - version (int) + client_token (str): A client token used to correlate requests and responses. + timestamp (datetime.datetime): The time the response was generated by AWS IoT. + version (int): The current version of the document for the device's shadow. """ __slots__ = ['client_token', 'timestamp', 'version'] @@ -805,13 +874,16 @@ def from_payload(cls, payload): class DeleteShadowSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to DeleteShadow responses for an AWS IoT thing. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - thing_name (str) + thing_name (str): AWS IoT thing to subscribe to DeleteShadow operations for. Attributes: - thing_name (str) + thing_name (str): AWS IoT thing to subscribe to DeleteShadow operations for. """ __slots__ = ['thing_name'] @@ -825,19 +897,22 @@ def __init__(self, *args, **kwargs): class ErrorResponse(awsiot.ModeledClass): """ + + Response document containing details about a failed request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - code (int) - message (str) - timestamp (datetime.datetime) + client_token (str): Opaque request-response correlation data. Present only if a client token was used in the request. + code (int): An HTTP response code that indicates the type of error. + message (str): A text message that provides additional information. + timestamp (datetime.datetime): The date and time the response was generated by AWS IoT. This property is not present in all error response documents. Attributes: - client_token (str) - code (int) - message (str) - timestamp (datetime.datetime) + client_token (str): Opaque request-response correlation data. Present only if a client token was used in the request. + code (int): An HTTP response code that indicates the type of error. + message (str): A text message that provides additional information. + timestamp (datetime.datetime): The date and time the response was generated by AWS IoT. This property is not present in all error response documents. """ __slots__ = ['client_token', 'code', 'message', 'timestamp'] @@ -872,17 +947,20 @@ def from_payload(cls, payload): class GetNamedShadowRequest(awsiot.ModeledClass): """ + + Data needed to make a GetNamedShadow request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - shadow_name (str) - thing_name (str) + 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. + shadow_name (str): Name of the shadow to get. + thing_name (str): AWS IoT thing to get the named shadow for. Attributes: - client_token (str) - shadow_name (str) - thing_name (str) + 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. + shadow_name (str): Name of the shadow to get. + thing_name (str): AWS IoT thing to get the named shadow for. """ __slots__ = ['client_token', 'shadow_name', 'thing_name'] @@ -905,15 +983,18 @@ def to_payload(self): class GetNamedShadowSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to GetNamedShadow responses. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - shadow_name (str) - thing_name (str) + shadow_name (str): Name of the shadow to subscribe to GetNamedShadow responses for. + thing_name (str): AWS IoT thing subscribe to GetNamedShadow responses for. Attributes: - shadow_name (str) - thing_name (str) + shadow_name (str): Name of the shadow to subscribe to GetNamedShadow responses for. + thing_name (str): AWS IoT thing subscribe to GetNamedShadow responses for. """ __slots__ = ['shadow_name', 'thing_name'] @@ -928,15 +1009,18 @@ def __init__(self, *args, **kwargs): class GetShadowRequest(awsiot.ModeledClass): """ + + Data needed to make a GetShadow request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - thing_name (str) + 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): AWS IoT thing to get the (classic) shadow for. Attributes: - client_token (str) - thing_name (str) + 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): AWS IoT thing to get the (classic) shadow for. """ __slots__ = ['client_token', 'thing_name'] @@ -958,21 +1042,24 @@ def to_payload(self): class GetShadowResponse(awsiot.ModeledClass): """ + + Response payload to a GetShadow request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - metadata (ShadowMetadata) - state (ShadowStateWithDelta) - timestamp (datetime.datetime) - version (int) + client_token (str): An opaque token used to correlate requests and responses. + metadata (ShadowMetadata): Contains the timestamps for each attribute in the desired and reported sections of the state. + state (ShadowStateWithDelta): The (classic) shadow state of the AWS IoT thing. + timestamp (datetime.datetime): The time the response was generated by AWS IoT. + version (int): The current version of the document for the device's shadow shared in AWS IoT. It is increased by one over the previous version of the document. Attributes: - client_token (str) - metadata (ShadowMetadata) - state (ShadowStateWithDelta) - timestamp (datetime.datetime) - version (int) + client_token (str): An opaque token used to correlate requests and responses. + metadata (ShadowMetadata): Contains the timestamps for each attribute in the desired and reported sections of the state. + state (ShadowStateWithDelta): The (classic) shadow state of the AWS IoT thing. + timestamp (datetime.datetime): The time the response was generated by AWS IoT. + version (int): The current version of the document for the device's shadow shared in AWS IoT. It is increased by one over the previous version of the document. """ __slots__ = ['client_token', 'metadata', 'state', 'timestamp', 'version'] @@ -1011,13 +1098,16 @@ def from_payload(cls, payload): class GetShadowSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to GetShadow responses. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - thing_name (str) + thing_name (str): AWS IoT thing subscribe to GetShadow responses for. Attributes: - thing_name (str) + thing_name (str): AWS IoT thing subscribe to GetShadow responses for. """ __slots__ = ['thing_name'] @@ -1031,15 +1121,18 @@ def __init__(self, *args, **kwargs): class NamedShadowDeltaUpdatedSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to a device's NamedShadowDelta events. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - shadow_name (str) - thing_name (str) + shadow_name (str): Name of the shadow to get ShadowDelta events for. + thing_name (str): Name of the AWS IoT thing to get NamedShadowDelta events for. Attributes: - shadow_name (str) - thing_name (str) + shadow_name (str): Name of the shadow to get ShadowDelta events for. + thing_name (str): Name of the AWS IoT thing to get NamedShadowDelta events for. """ __slots__ = ['shadow_name', 'thing_name'] @@ -1054,15 +1147,18 @@ def __init__(self, *args, **kwargs): class NamedShadowUpdatedSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to a device's NamedShadowUpdated events. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - shadow_name (str) - thing_name (str) + shadow_name (str): Name of the shadow to get NamedShadowUpdated events for. + thing_name (str): Name of the AWS IoT thing to get NamedShadowUpdated events for. Attributes: - shadow_name (str) - thing_name (str) + shadow_name (str): Name of the shadow to get NamedShadowUpdated events for. + thing_name (str): Name of the AWS IoT thing to get NamedShadowUpdated events for. """ __slots__ = ['shadow_name', 'thing_name'] @@ -1077,19 +1173,22 @@ def __init__(self, *args, **kwargs): class ShadowDeltaUpdatedEvent(awsiot.ModeledClass): """ + + An event generated when a shadow document was updated by a request to AWS IoT. The event payload contains only the changes requested. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - metadata (typing.Dict[str, typing.Any]) - state (typing.Dict[str, typing.Any]) - timestamp (datetime.datetime) - version (int) + metadata (typing.Dict[str, typing.Any]): Timestamps for the shadow properties that were updated. + state (typing.Dict[str, typing.Any]): Shadow properties that were updated. + timestamp (datetime.datetime): The time the event was generated by AWS IoT. + version (int): The current version of the document for the device's shadow. Attributes: - metadata (typing.Dict[str, typing.Any]) - state (typing.Dict[str, typing.Any]) - timestamp (datetime.datetime) - version (int) + metadata (typing.Dict[str, typing.Any]): Timestamps for the shadow properties that were updated. + state (typing.Dict[str, typing.Any]): Shadow properties that were updated. + timestamp (datetime.datetime): The time the event was generated by AWS IoT. + version (int): The current version of the document for the device's shadow. """ __slots__ = ['metadata', 'state', 'timestamp', 'version'] @@ -1124,13 +1223,16 @@ def from_payload(cls, payload): class ShadowDeltaUpdatedSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to a device's ShadowDelta events. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - thing_name (str) + thing_name (str): Name of the AWS IoT thing to get ShadowDelta events for. Attributes: - thing_name (str) + thing_name (str): Name of the AWS IoT thing to get ShadowDelta events for. """ __slots__ = ['thing_name'] @@ -1144,15 +1246,18 @@ def __init__(self, *args, **kwargs): class ShadowMetadata(awsiot.ModeledClass): """ + + Contains the last-updated timestamps for each attribute in the desired and reported sections of the shadow state. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - desired (typing.Dict[str, typing.Any]) - reported (typing.Dict[str, typing.Any]) + desired (typing.Dict[str, typing.Any]): Contains the timestamps for each attribute in the desired section of a shadow's state. + reported (typing.Dict[str, typing.Any]): Contains the timestamps for each attribute in the reported section of a shadow's state. Attributes: - desired (typing.Dict[str, typing.Any]) - reported (typing.Dict[str, typing.Any]) + desired (typing.Dict[str, typing.Any]): Contains the timestamps for each attribute in the desired section of a shadow's state. + reported (typing.Dict[str, typing.Any]): Contains the timestamps for each attribute in the reported section of a shadow's state. """ __slots__ = ['desired', 'reported'] @@ -1179,15 +1284,18 @@ def from_payload(cls, payload): class ShadowState(awsiot.ModeledClass): """ + + (Potentially partial) state of an AWS IoT thing's shadow. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - desired (typing.Dict[str, typing.Any]) - reported (typing.Dict[str, typing.Any]) + desired (typing.Dict[str, typing.Any]): The desired shadow state (from external services and devices). + reported (typing.Dict[str, typing.Any]): The (last) reported shadow state from the device. Attributes: - desired (typing.Dict[str, typing.Any]) - reported (typing.Dict[str, typing.Any]) + desired (typing.Dict[str, typing.Any]): The desired shadow state (from external services and devices). + reported (typing.Dict[str, typing.Any]): The (last) reported shadow state from the device. """ __slots__ = ['desired', 'reported'] @@ -1223,17 +1331,20 @@ def to_payload(self): class ShadowStateWithDelta(awsiot.ModeledClass): """ + + (Potentially partial) state of an AWS IoT thing's shadow. Includes the delta between the reported and desired states. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - delta (typing.Dict[str, typing.Any]) - desired (typing.Dict[str, typing.Any]) - reported (typing.Dict[str, typing.Any]) + delta (typing.Dict[str, typing.Any]): The delta between the reported and desired states. + desired (typing.Dict[str, typing.Any]): The desired shadow state (from external services and devices). + reported (typing.Dict[str, typing.Any]): The (last) reported shadow state from the device. Attributes: - delta (typing.Dict[str, typing.Any]) - desired (typing.Dict[str, typing.Any]) - reported (typing.Dict[str, typing.Any]) + delta (typing.Dict[str, typing.Any]): The delta between the reported and desired states. + desired (typing.Dict[str, typing.Any]): The desired shadow state (from external services and devices). + reported (typing.Dict[str, typing.Any]): The (last) reported shadow state from the device. """ __slots__ = ['delta', 'desired', 'reported'] @@ -1264,17 +1375,20 @@ def from_payload(cls, payload): class ShadowUpdatedEvent(awsiot.ModeledClass): """ + + A description of the before and after states of a device shadow. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - current (ShadowUpdatedSnapshot) - previous (ShadowUpdatedSnapshot) - timestamp (datetime.datetime) + current (ShadowUpdatedSnapshot): Contains the state of the object after the update. + previous (ShadowUpdatedSnapshot): Contains the state of the object before the update. + timestamp (datetime.datetime): The time the event was generated by AWS IoT. Attributes: - current (ShadowUpdatedSnapshot) - previous (ShadowUpdatedSnapshot) - timestamp (datetime.datetime) + current (ShadowUpdatedSnapshot): Contains the state of the object after the update. + previous (ShadowUpdatedSnapshot): Contains the state of the object before the update. + timestamp (datetime.datetime): The time the event was generated by AWS IoT. """ __slots__ = ['current', 'previous', 'timestamp'] @@ -1305,17 +1419,20 @@ def from_payload(cls, payload): class ShadowUpdatedSnapshot(awsiot.ModeledClass): """ + + Complete state of the (classic) shadow of an AWS IoT Thing. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - metadata (ShadowMetadata) - state (ShadowState) - version (int) + metadata (ShadowMetadata): Contains the timestamps for each attribute in the desired and reported sections of the state. + state (ShadowState): Current shadow state. + version (int): The current version of the document for the device's shadow. Attributes: - metadata (ShadowMetadata) - state (ShadowState) - version (int) + metadata (ShadowMetadata): Contains the timestamps for each attribute in the desired and reported sections of the state. + state (ShadowState): Current shadow state. + version (int): The current version of the document for the device's shadow. """ __slots__ = ['metadata', 'state', 'version'] @@ -1346,13 +1463,16 @@ def from_payload(cls, payload): class ShadowUpdatedSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to a device's ShadowUpdated events. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - thing_name (str) + thing_name (str): Name of the AWS IoT thing to get ShadowUpdated events for. Attributes: - thing_name (str) + thing_name (str): Name of the AWS IoT thing to get ShadowUpdated events for. """ __slots__ = ['thing_name'] @@ -1366,21 +1486,24 @@ def __init__(self, *args, **kwargs): class UpdateNamedShadowRequest(awsiot.ModeledClass): """ + + Data needed to make an UpdateNamedShadow request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - shadow_name (str) - state (ShadowState) - thing_name (str) - version (int) + 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. + shadow_name (str): Name of the shadow to update. + state (ShadowState): Requested changes to shadow state. Updates affect only the fields specified. + thing_name (str): Aws IoT thing to update a named shadow of. + version (int): (Optional) The Device Shadow service applies the update only if the specified version matches the latest version. Attributes: - client_token (str) - shadow_name (str) - state (ShadowState) - thing_name (str) - version (int) + 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. + shadow_name (str): Name of the shadow to update. + state (ShadowState): Requested changes to shadow state. Updates affect only the fields specified. + thing_name (str): Aws IoT thing to update a named shadow of. + version (int): (Optional) The Device Shadow service applies the update only if the specified version matches the latest version. """ __slots__ = ['client_token', 'shadow_name', 'state', 'thing_name', 'version'] @@ -1409,15 +1532,18 @@ def to_payload(self): class UpdateNamedShadowSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to UpdateNamedShadow responses. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - shadow_name (str) - thing_name (str) + shadow_name (str): Name of the shadow to listen to UpdateNamedShadow responses for. + thing_name (str): Name of the AWS IoT thing to listen to UpdateNamedShadow responses for. Attributes: - shadow_name (str) - thing_name (str) + shadow_name (str): Name of the shadow to listen to UpdateNamedShadow responses for. + thing_name (str): Name of the AWS IoT thing to listen to UpdateNamedShadow responses for. """ __slots__ = ['shadow_name', 'thing_name'] @@ -1432,19 +1558,22 @@ def __init__(self, *args, **kwargs): class UpdateShadowRequest(awsiot.ModeledClass): """ + + Data needed to make an UpdateShadow request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - state (ShadowState) - thing_name (str) - version (int) + 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. + state (ShadowState): Requested changes to the shadow state. Updates affect only the fields specified. + thing_name (str): Aws IoT thing to update the (classic) shadow of. + version (int): (Optional) The Device Shadow service processes the update only if the specified version matches the latest version. Attributes: - client_token (str) - state (ShadowState) - thing_name (str) - version (int) + 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. + state (ShadowState): Requested changes to the shadow state. Updates affect only the fields specified. + thing_name (str): Aws IoT thing to update the (classic) shadow of. + version (int): (Optional) The Device Shadow service processes the update only if the specified version matches the latest version. """ __slots__ = ['client_token', 'state', 'thing_name', 'version'] @@ -1472,21 +1601,24 @@ def to_payload(self): class UpdateShadowResponse(awsiot.ModeledClass): """ + + Response payload to an UpdateShadow request. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - client_token (str) - metadata (ShadowMetadata) - state (ShadowState) - timestamp (datetime.datetime) - version (int) + client_token (str): An opaque token used to correlate requests and responses. Present only if a client token was used in the request. + metadata (ShadowMetadata): Contains the timestamps for each attribute in the desired and reported sections so that you can determine when the state was updated. + state (ShadowState): Updated device shadow state. + timestamp (datetime.datetime): The time the response was generated by AWS IoT. + version (int): The current version of the document for the device's shadow shared in AWS IoT. It is increased by one over the previous version of the document. Attributes: - client_token (str) - metadata (ShadowMetadata) - state (ShadowState) - timestamp (datetime.datetime) - version (int) + client_token (str): An opaque token used to correlate requests and responses. Present only if a client token was used in the request. + metadata (ShadowMetadata): Contains the timestamps for each attribute in the desired and reported sections so that you can determine when the state was updated. + state (ShadowState): Updated device shadow state. + timestamp (datetime.datetime): The time the response was generated by AWS IoT. + version (int): The current version of the document for the device's shadow shared in AWS IoT. It is increased by one over the previous version of the document. """ __slots__ = ['client_token', 'metadata', 'state', 'timestamp', 'version'] @@ -1525,13 +1657,16 @@ def from_payload(cls, payload): class UpdateShadowSubscriptionRequest(awsiot.ModeledClass): """ + + Data needed to subscribe to UpdateShadow responses. + All attributes are None by default, and may be set by keyword in the constructor. Keyword Args: - thing_name (str) + thing_name (str): Name of the AWS IoT thing to listen to UpdateShadow responses for. Attributes: - thing_name (str) + thing_name (str): Name of the AWS IoT thing to listen to UpdateShadow responses for. """ __slots__ = ['thing_name'] diff --git a/docs/_static/basic.css b/docs/_static/basic.css index a5e2bb9a..7fbe7a18 100644 --- a/docs/_static/basic.css +++ b/docs/_static/basic.css @@ -731,8 +731,9 @@ dl.glossary dt { .classifier:before { font-style: normal; - margin: 0.5em; + margin: 0 0.5em; content: ":"; + display: inline-block; } abbr, acronym { @@ -819,7 +820,7 @@ div.code-block-caption code { table.highlighttable td.linenos, span.linenos, -div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ +div.highlight span.gp { /* gp: Generic.Prompt */ user-select: none; -webkit-user-select: text; /* Safari fallback only */ -webkit-user-select: none; /* Chrome/Safari */ diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js index 61ac9d26..8cbf1b16 100644 --- a/docs/_static/doctools.js +++ b/docs/_static/doctools.js @@ -301,12 +301,14 @@ var Documentation = { window.location.href = prevHref; return false; } + break; case 39: // right var nextHref = $('link[rel="next"]').prop('href'); if (nextHref) { window.location.href = nextHref; return false; } + break; } } }); diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js index e09f9263..002e9c4a 100644 --- a/docs/_static/searchtools.js +++ b/docs/_static/searchtools.js @@ -282,7 +282,10 @@ var Search = { complete: function(jqxhr, textstatus) { var data = jqxhr.responseText; if (data !== '' && data !== undefined) { - listItem.append(Search.makeSearchSummary(data, searchterms, hlterms)); + var summary = Search.makeSearchSummary(data, searchterms, hlterms); + if (summary) { + listItem.append(summary); + } } Search.output.append(listItem); setTimeout(function() { @@ -325,7 +328,9 @@ var Search = { var results = []; for (var prefix in objects) { - for (var name in objects[prefix]) { + for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) { + var match = objects[prefix][iMatch]; + var name = match[4]; var fullname = (prefix ? prefix + '.' : '') + name; var fullnameLower = fullname.toLowerCase() if (fullnameLower.indexOf(object) > -1) { @@ -339,7 +344,6 @@ var Search = { } else if (parts[parts.length - 1].indexOf(object) > -1) { score += Scorer.objPartialMatch; } - var match = objects[prefix][name]; var objname = objnames[match[1]][2]; var title = titles[match[0]]; // If more than one term searched for, we require other words to be @@ -498,6 +502,9 @@ var Search = { */ makeSearchSummary : function(htmlText, keywords, hlwords) { var text = Search.htmlToText(htmlText); + if (text == "") { + return null; + } var textLower = text.toLowerCase(); var start = 0; $.each(keywords, function() { diff --git a/docs/_static/underscore-1.12.0.js b/docs/_static/underscore-1.13.1.js similarity index 94% rename from docs/_static/underscore-1.12.0.js rename to docs/_static/underscore-1.13.1.js index 3af6352e..ffd77af9 100644 --- a/docs/_static/underscore-1.12.0.js +++ b/docs/_static/underscore-1.13.1.js @@ -1,19 +1,19 @@ (function (global, factory) { typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() : typeof define === 'function' && define.amd ? define('underscore', factory) : - (global = global || self, (function () { + (global = typeof globalThis !== 'undefined' ? globalThis : global || self, (function () { var current = global._; var exports = global._ = factory(); exports.noConflict = function () { global._ = current; return exports; }; }())); }(this, (function () { - // Underscore.js 1.12.0 + // Underscore.js 1.13.1 // https://underscorejs.org - // (c) 2009-2020 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors + // (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors // Underscore may be freely distributed under the MIT license. // Current version. - var VERSION = '1.12.0'; + var VERSION = '1.13.1'; // Establish the root object, `window` (`self`) in the browser, `global` // on the server, or `this` in some virtual machines. We use `self` @@ -170,7 +170,7 @@ var isArray = nativeIsArray || tagTester('Array'); // Internal function to check whether `key` is an own property name of `obj`. - function has(obj, key) { + function has$1(obj, key) { return obj != null && hasOwnProperty.call(obj, key); } @@ -181,7 +181,7 @@ (function() { if (!isArguments(arguments)) { isArguments = function(obj) { - return has(obj, 'callee'); + return has$1(obj, 'callee'); }; } }()); @@ -268,7 +268,7 @@ // Constructor is a special case. var prop = 'constructor'; - if (has(obj, prop) && !keys.contains(prop)) keys.push(prop); + if (has$1(obj, prop) && !keys.contains(prop)) keys.push(prop); while (nonEnumIdx--) { prop = nonEnumerableProps[nonEnumIdx]; @@ -284,7 +284,7 @@ if (!isObject(obj)) return []; if (nativeKeys) return nativeKeys(obj); var keys = []; - for (var key in obj) if (has(obj, key)) keys.push(key); + for (var key in obj) if (has$1(obj, key)) keys.push(key); // Ahem, IE < 9. if (hasEnumBug) collectNonEnumProps(obj, keys); return keys; @@ -318,24 +318,24 @@ // If Underscore is called as a function, it returns a wrapped object that can // be used OO-style. This wrapper holds altered versions of all functions added // through `_.mixin`. Wrapped objects may be chained. - function _(obj) { - if (obj instanceof _) return obj; - if (!(this instanceof _)) return new _(obj); + function _$1(obj) { + if (obj instanceof _$1) return obj; + if (!(this instanceof _$1)) return new _$1(obj); this._wrapped = obj; } - _.VERSION = VERSION; + _$1.VERSION = VERSION; // Extracts the result from a wrapped and chained object. - _.prototype.value = function() { + _$1.prototype.value = function() { return this._wrapped; }; // Provide unwrapping proxies for some methods used in engine operations // such as arithmetic and JSON stringification. - _.prototype.valueOf = _.prototype.toJSON = _.prototype.value; + _$1.prototype.valueOf = _$1.prototype.toJSON = _$1.prototype.value; - _.prototype.toString = function() { + _$1.prototype.toString = function() { return String(this._wrapped); }; @@ -370,8 +370,8 @@ // Internal recursive comparison function for `_.isEqual`. function deepEq(a, b, aStack, bStack) { // Unwrap any wrapped objects. - if (a instanceof _) a = a._wrapped; - if (b instanceof _) b = b._wrapped; + if (a instanceof _$1) a = a._wrapped; + if (b instanceof _$1) b = b._wrapped; // Compare `[[Class]]` names. var className = toString.call(a); if (className !== toString.call(b)) return false; @@ -463,7 +463,7 @@ while (length--) { // Deep compare each member key = _keys[length]; - if (!(has(b, key) && eq(a[key], b[key], aStack, bStack))) return false; + if (!(has$1(b, key) && eq(a[key], b[key], aStack, bStack))) return false; } } // Remove the first object from the stack of traversed objects. @@ -642,15 +642,15 @@ // Normalize a (deep) property `path` to array. // Like `_.iteratee`, this function can be customized. - function toPath(path) { + function toPath$1(path) { return isArray(path) ? path : [path]; } - _.toPath = toPath; + _$1.toPath = toPath$1; // Internal wrapper for `_.toPath` to enable minification. // Similar to `cb` for `_.iteratee`. - function toPath$1(path) { - return _.toPath(path); + function toPath(path) { + return _$1.toPath(path); } // Internal function to obtain a nested property in `obj` along `path`. @@ -668,19 +668,19 @@ // `undefined`, return `defaultValue` instead. // The `path` is normalized through `_.toPath`. function get(object, path, defaultValue) { - var value = deepGet(object, toPath$1(path)); + var value = deepGet(object, toPath(path)); return isUndefined(value) ? defaultValue : value; } // Shortcut function for checking if an object has a given property directly on // itself (in other words, not on a prototype). Unlike the internal `has` // function, this public version can also traverse nested properties. - function has$1(obj, path) { - path = toPath$1(path); + function has(obj, path) { + path = toPath(path); var length = path.length; for (var i = 0; i < length; i++) { var key = path[i]; - if (!has(obj, key)) return false; + if (!has$1(obj, key)) return false; obj = obj[key]; } return !!length; @@ -703,7 +703,7 @@ // Creates a function that, when passed an object, will traverse that object’s // properties down the given `path`, specified as an array of keys or indices. function property(path) { - path = toPath$1(path); + path = toPath(path); return function(obj) { return deepGet(obj, path); }; @@ -747,12 +747,12 @@ function iteratee(value, context) { return baseIteratee(value, context, Infinity); } - _.iteratee = iteratee; + _$1.iteratee = iteratee; // The function we call internally to generate a callback. It invokes // `_.iteratee` if overridden, otherwise `baseIteratee`. function cb(value, context, argCount) { - if (_.iteratee !== iteratee) return _.iteratee(value, context); + if (_$1.iteratee !== iteratee) return _$1.iteratee(value, context); return baseIteratee(value, context, argCount); } @@ -840,7 +840,7 @@ // By default, Underscore uses ERB-style template delimiters. Change the // following template settings to use alternative delimiters. - var templateSettings = _.templateSettings = { + var templateSettings = _$1.templateSettings = { evaluate: /<%([\s\S]+?)%>/g, interpolate: /<%=([\s\S]+?)%>/g, escape: /<%-([\s\S]+?)%>/g @@ -868,13 +868,20 @@ return '\\' + escapes[match]; } + // In order to prevent third-party code injection through + // `_.templateSettings.variable`, we test it against the following regular + // expression. It is intentionally a bit more liberal than just matching valid + // identifiers, but still prevents possible loopholes through defaults or + // destructuring assignment. + var bareIdentifier = /^\s*(\w|\$)+\s*$/; + // JavaScript micro-templating, similar to John Resig's implementation. // Underscore templating handles arbitrary delimiters, preserves whitespace, // and correctly escapes quotes within interpolated code. // NB: `oldSettings` only exists for backwards compatibility. function template(text, settings, oldSettings) { if (!settings && oldSettings) settings = oldSettings; - settings = defaults({}, settings, _.templateSettings); + settings = defaults({}, settings, _$1.templateSettings); // Combine delimiters into one regular expression via alternation. var matcher = RegExp([ @@ -903,8 +910,17 @@ }); source += "';\n"; - // If a variable is not specified, place data values in local scope. - if (!settings.variable) source = 'with(obj||{}){\n' + source + '}\n'; + var argument = settings.variable; + if (argument) { + // Insure against third-party code injection. (CVE-2021-23358) + if (!bareIdentifier.test(argument)) throw new Error( + 'variable is not a bare identifier: ' + argument + ); + } else { + // If a variable is not specified, place data values in local scope. + source = 'with(obj||{}){\n' + source + '}\n'; + argument = 'obj'; + } source = "var __t,__p='',__j=Array.prototype.join," + "print=function(){__p+=__j.call(arguments,'');};\n" + @@ -912,18 +928,17 @@ var render; try { - render = new Function(settings.variable || 'obj', '_', source); + render = new Function(argument, '_', source); } catch (e) { e.source = source; throw e; } var template = function(data) { - return render.call(this, data, _); + return render.call(this, data, _$1); }; // Provide the compiled source as a convenience for precompilation. - var argument = settings.variable || 'obj'; template.source = 'function(' + argument + '){\n' + source + '}'; return template; @@ -933,7 +948,7 @@ // is invoked with its parent as context. Returns the value of the final // child, or `fallback` if any child is undefined. function result(obj, path, fallback) { - path = toPath$1(path); + path = toPath(path); var length = path.length; if (!length) { return isFunction$1(fallback) ? fallback.call(obj) : fallback; @@ -959,7 +974,7 @@ // Start chaining a wrapped Underscore object. function chain(obj) { - var instance = _(obj); + var instance = _$1(obj); instance._chain = true; return instance; } @@ -993,7 +1008,7 @@ return bound; }); - partial.placeholder = _; + partial.placeholder = _$1; // Create a function bound to a given object (assigning `this`, and arguments, // optionally). @@ -1012,7 +1027,7 @@ var isArrayLike = createSizePropertyCheck(getLength); // Internal implementation of a recursive `flatten` function. - function flatten(input, depth, strict, output) { + function flatten$1(input, depth, strict, output) { output = output || []; if (!depth && depth !== 0) { depth = Infinity; @@ -1025,7 +1040,7 @@ if (isArrayLike(value) && (isArray(value) || isArguments$1(value))) { // Flatten current level of array or arguments object. if (depth > 1) { - flatten(value, depth - 1, strict, output); + flatten$1(value, depth - 1, strict, output); idx = output.length; } else { var j = 0, len = value.length; @@ -1042,7 +1057,7 @@ // are the method names to be bound. Useful for ensuring that all callbacks // defined on an object belong to it. var bindAll = restArguments(function(obj, keys) { - keys = flatten(keys, false, false); + keys = flatten$1(keys, false, false); var index = keys.length; if (index < 1) throw new Error('bindAll must be passed function names'); while (index--) { @@ -1057,7 +1072,7 @@ var memoize = function(key) { var cache = memoize.cache; var address = '' + (hasher ? hasher.apply(this, arguments) : key); - if (!has(cache, address)) cache[address] = func.apply(this, arguments); + if (!has$1(cache, address)) cache[address] = func.apply(this, arguments); return cache[address]; }; memoize.cache = {}; @@ -1074,7 +1089,7 @@ // Defers a function, scheduling it to run after the current call stack has // cleared. - var defer = partial(delay, _, 1); + var defer = partial(delay, _$1, 1); // Returns a function, that, when invoked, will only be triggered at most once // during a given window of time. Normally, the throttled function will run @@ -1420,7 +1435,7 @@ if (isFunction$1(path)) { func = path; } else { - path = toPath$1(path); + path = toPath(path); contextPath = path.slice(0, -1); path = path[path.length - 1]; } @@ -1562,7 +1577,7 @@ // Groups the object's values by a criterion. Pass either a string attribute // to group by, or a function that returns the criterion. var groupBy = group(function(result, value, key) { - if (has(result, key)) result[key].push(value); else result[key] = [value]; + if (has$1(result, key)) result[key].push(value); else result[key] = [value]; }); // Indexes the object's values by a criterion, similar to `_.groupBy`, but for @@ -1575,7 +1590,7 @@ // either a string attribute to count by, or a function that returns the // criterion. var countBy = group(function(result, value, key) { - if (has(result, key)) result[key]++; else result[key] = 1; + if (has$1(result, key)) result[key]++; else result[key] = 1; }); // Split a collection into two arrays: one whose elements all pass the given @@ -1618,7 +1633,7 @@ keys = allKeys(obj); } else { iteratee = keyInObj; - keys = flatten(keys, false, false); + keys = flatten$1(keys, false, false); obj = Object(obj); } for (var i = 0, length = keys.length; i < length; i++) { @@ -1636,7 +1651,7 @@ iteratee = negate(iteratee); if (keys.length > 1) context = keys[1]; } else { - keys = map(flatten(keys, false, false), String); + keys = map(flatten$1(keys, false, false), String); iteratee = function(value, key) { return !contains(keys, key); }; @@ -1681,14 +1696,14 @@ // Flatten out an array, either recursively (by default), or up to `depth`. // Passing `true` or `false` as `depth` means `1` or `Infinity`, respectively. - function flatten$1(array, depth) { - return flatten(array, depth, false); + function flatten(array, depth) { + return flatten$1(array, depth, false); } // Take the difference between one array and a number of other arrays. // Only the elements present in just the first array will remain. var difference = restArguments(function(array, rest) { - rest = flatten(rest, true, true); + rest = flatten$1(rest, true, true); return filter(array, function(value){ return !contains(rest, value); }); @@ -1734,7 +1749,7 @@ // Produce an array that contains the union: each distinct element from all of // the passed-in arrays. var union = restArguments(function(arrays) { - return uniq(flatten(arrays, true, true)); + return uniq(flatten$1(arrays, true, true)); }); // Produce an array that contains every item shared between all the @@ -1821,26 +1836,26 @@ // Helper function to continue chaining intermediate results. function chainResult(instance, obj) { - return instance._chain ? _(obj).chain() : obj; + return instance._chain ? _$1(obj).chain() : obj; } // Add your own custom functions to the Underscore object. function mixin(obj) { each(functions(obj), function(name) { - var func = _[name] = obj[name]; - _.prototype[name] = function() { + var func = _$1[name] = obj[name]; + _$1.prototype[name] = function() { var args = [this._wrapped]; push.apply(args, arguments); - return chainResult(this, func.apply(_, args)); + return chainResult(this, func.apply(_$1, args)); }; }); - return _; + return _$1; } // Add all mutator `Array` functions to the wrapper. each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) { var method = ArrayProto[name]; - _.prototype[name] = function() { + _$1.prototype[name] = function() { var obj = this._wrapped; if (obj != null) { method.apply(obj, arguments); @@ -1855,7 +1870,7 @@ // Add all accessor `Array` functions to the wrapper. each(['concat', 'join', 'slice'], function(name) { var method = ArrayProto[name]; - _.prototype[name] = function() { + _$1.prototype[name] = function() { var obj = this._wrapped; if (obj != null) obj = method.apply(obj, arguments); return chainResult(this, obj); @@ -1909,12 +1924,12 @@ clone: clone, tap: tap, get: get, - has: has$1, + has: has, mapObject: mapObject, identity: identity, constant: constant, noop: noop, - toPath: toPath, + toPath: toPath$1, property: property, propertyOf: propertyOf, matcher: matcher, @@ -1997,7 +2012,7 @@ tail: rest, drop: rest, compact: compact, - flatten: flatten$1, + flatten: flatten, without: without, uniq: uniq, unique: uniq, @@ -2011,17 +2026,17 @@ range: range, chunk: chunk, mixin: mixin, - 'default': _ + 'default': _$1 }; // Default Export // Add all of the Underscore functions to the wrapper object. - var _$1 = mixin(allExports); + var _ = mixin(allExports); // Legacy Node.js API. - _$1._ = _$1; + _._ = _; - return _$1; + return _; }))); -//# sourceMappingURL=underscore.js.map +//# sourceMappingURL=underscore-umd.js.map diff --git a/docs/_static/underscore.js b/docs/_static/underscore.js index 166240ef..cf177d42 100644 --- a/docs/_static/underscore.js +++ b/docs/_static/underscore.js @@ -1,6 +1,6 @@ -!function(n,r){"object"==typeof exports&&"undefined"!=typeof module?module.exports=r():"function"==typeof define&&define.amd?define("underscore",r):(n=n||self,function(){var t=n._,e=n._=r();e.noConflict=function(){return n._=t,e}}())}(this,(function(){ -// Underscore.js 1.12.0 +!function(n,r){"object"==typeof exports&&"undefined"!=typeof module?module.exports=r():"function"==typeof define&&define.amd?define("underscore",r):(n="undefined"!=typeof globalThis?globalThis:n||self,function(){var t=n._,e=n._=r();e.noConflict=function(){return n._=t,e}}())}(this,(function(){ +// Underscore.js 1.13.1 // https://underscorejs.org -// (c) 2009-2020 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors +// (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors // Underscore may be freely distributed under the MIT license. -var n="1.12.0",r="object"==typeof self&&self.self===self&&self||"object"==typeof global&&global.global===global&&global||Function("return this")()||{},t=Array.prototype,e=Object.prototype,u="undefined"!=typeof Symbol?Symbol.prototype:null,o=t.push,i=t.slice,a=e.toString,f=e.hasOwnProperty,c="undefined"!=typeof ArrayBuffer,l="undefined"!=typeof DataView,s=Array.isArray,p=Object.keys,v=Object.create,h=c&&ArrayBuffer.isView,y=isNaN,g=isFinite,d=!{toString:null}.propertyIsEnumerable("toString"),b=["valueOf","isPrototypeOf","toString","propertyIsEnumerable","hasOwnProperty","toLocaleString"],m=Math.pow(2,53)-1;function j(n,r){return r=null==r?n.length-1:+r,function(){for(var t=Math.max(arguments.length-r,0),e=Array(t),u=0;u=0&&t<=m}}function $(n){return function(r){return null==r?void 0:r[n]}}var G=$("byteLength"),H=J(G),Q=/\[object ((I|Ui)nt(8|16|32)|Float(32|64)|Uint8Clamped|Big(I|Ui)nt64)Array\]/;var X=c?function(n){return h?h(n)&&!q(n):H(n)&&Q.test(a.call(n))}:K(!1),Y=$("length");function Z(n,r){r=function(n){for(var r={},t=n.length,e=0;e":">",'"':""","'":"'","`":"`"},Kn=Ln(Cn),Jn=Ln(_n(Cn)),$n=tn.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g},Gn=/(.)^/,Hn={"'":"'","\\":"\\","\r":"r","\n":"n","\u2028":"u2028","\u2029":"u2029"},Qn=/\\|'|\r|\n|\u2028|\u2029/g;function Xn(n){return"\\"+Hn[n]}var Yn=0;function Zn(n,r,t,e,u){if(!(e instanceof r))return n.apply(t,u);var o=Mn(n.prototype),i=n.apply(o,u);return _(i)?i:o}var nr=j((function(n,r){var t=nr.placeholder,e=function(){for(var u=0,o=r.length,i=Array(o),a=0;a1)er(a,r-1,t,e),u=e.length;else for(var f=0,c=a.length;f0&&(t=r.apply(this,arguments)),n<=1&&(r=null),t}}var cr=nr(fr,2);function lr(n,r,t){r=qn(r,t);for(var e,u=nn(n),o=0,i=u.length;o0?0:u-1;o>=0&&o0?a=o>=0?o:Math.max(o+f,a):f=o>=0?Math.min(o+1,f):o+f+1;else if(t&&o&&f)return e[o=t(e,u)]===u?o:-1;if(u!=u)return(o=r(i.call(e,a,f),C))>=0?o+a:-1;for(o=n>0?a:f-1;o>=0&&o0?0:i-1;for(u||(e=r[o?o[a]:a],a+=n);a>=0&&a=3;return r(n,Fn(t,u,4),e,o)}}var wr=_r(1),Ar=_r(-1);function xr(n,r,t){var e=[];return r=qn(r,t),mr(n,(function(n,t,u){r(n,t,u)&&e.push(n)})),e}function Sr(n,r,t){r=qn(r,t);for(var e=!tr(n)&&nn(n),u=(e||n).length,o=0;o=0}var Er=j((function(n,r,t){var e,u;return D(r)?u=r:(r=Nn(r),e=r.slice(0,-1),r=r[r.length-1]),jr(n,(function(n){var o=u;if(!o){if(e&&e.length&&(n=In(n,e)),null==n)return;o=n[r]}return null==o?o:o.apply(n,t)}))}));function Br(n,r){return jr(n,Rn(r))}function Nr(n,r,t){var e,u,o=-1/0,i=-1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=tr(n)?n:jn(n)).length;ao&&(o=e);else r=qn(r,t),mr(n,(function(n,t,e){((u=r(n,t,e))>i||u===-1/0&&o===-1/0)&&(o=n,i=u)}));return o}function Ir(n,r,t){if(null==r||t)return tr(n)||(n=jn(n)),n[Wn(n.length-1)];var e=tr(n)?En(n):jn(n),u=Y(e);r=Math.max(Math.min(r,u),0);for(var o=u-1,i=0;i1&&(e=Fn(e,r[1])),r=an(n)):(e=Pr,r=er(r,!1,!1),n=Object(n));for(var u=0,o=r.length;u1&&(t=r[1])):(r=jr(er(r,!1,!1),String),e=function(n,t){return!Mr(r,t)}),qr(n,e,t)}));function Wr(n,r,t){return i.call(n,0,Math.max(0,n.length-(null==r||t?1:r)))}function zr(n,r,t){return null==n||n.length<1?null==r||t?void 0:[]:null==r||t?n[0]:Wr(n,n.length-r)}function Lr(n,r,t){return i.call(n,null==r||t?1:r)}var Cr=j((function(n,r){return r=er(r,!0,!0),xr(n,(function(n){return!Mr(r,n)}))})),Kr=j((function(n,r){return Cr(n,r)}));function Jr(n,r,t,e){A(r)||(e=t,t=r,r=!1),null!=t&&(t=qn(t,e));for(var u=[],o=[],i=0,a=Y(n);ir?(e&&(clearTimeout(e),e=null),a=c,i=n.apply(u,o),e||(u=o=null)):e||!1===t.trailing||(e=setTimeout(f,l)),i};return c.cancel=function(){clearTimeout(e),a=0,e=u=o=null},c},debounce:function(n,r,t){var e,u,o=function(r,t){e=null,t&&(u=n.apply(r,t))},i=j((function(i){if(e&&clearTimeout(e),t){var a=!e;e=setTimeout(o,r),a&&(u=n.apply(this,i))}else e=or(o,r,this,i);return u}));return i.cancel=function(){clearTimeout(e),e=null},i},wrap:function(n,r){return nr(r,n)},negate:ar,compose:function(){var n=arguments,r=n.length-1;return function(){for(var t=r,e=n[r].apply(this,arguments);t--;)e=n[t].call(this,e);return e}},after:function(n,r){return function(){if(--n<1)return r.apply(this,arguments)}},before:fr,once:cr,findKey:lr,findIndex:pr,findLastIndex:vr,sortedIndex:hr,indexOf:gr,lastIndexOf:dr,find:br,detect:br,findWhere:function(n,r){return br(n,Dn(r))},each:mr,forEach:mr,map:jr,collect:jr,reduce:wr,foldl:wr,inject:wr,reduceRight:Ar,foldr:Ar,filter:xr,select:xr,reject:function(n,r,t){return xr(n,ar(qn(r)),t)},every:Sr,all:Sr,some:Or,any:Or,contains:Mr,includes:Mr,include:Mr,invoke:Er,pluck:Br,where:function(n,r){return xr(n,Dn(r))},max:Nr,min:function(n,r,t){var e,u,o=1/0,i=1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=tr(n)?n:jn(n)).length;ae||void 0===t)return 1;if(t=0&&t<=m}}function J(n){return function(r){return null==r?void 0:r[n]}}var G=J("byteLength"),H=K(G),Q=/\[object ((I|Ui)nt(8|16|32)|Float(32|64)|Uint8Clamped|Big(I|Ui)nt64)Array\]/;var X=c?function(n){return h?h(n)&&!q(n):H(n)&&Q.test(a.call(n))}:C(!1),Y=J("length");function Z(n,r){r=function(n){for(var r={},t=n.length,e=0;e":">",'"':""","'":"'","`":"`"},Cn=Ln($n),Kn=Ln(_n($n)),Jn=tn.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g},Gn=/(.)^/,Hn={"'":"'","\\":"\\","\r":"r","\n":"n","\u2028":"u2028","\u2029":"u2029"},Qn=/\\|'|\r|\n|\u2028|\u2029/g;function Xn(n){return"\\"+Hn[n]}var Yn=/^\s*(\w|\$)+\s*$/;var Zn=0;function nr(n,r,t,e,u){if(!(e instanceof r))return n.apply(t,u);var o=Mn(n.prototype),i=n.apply(o,u);return _(i)?i:o}var rr=j((function(n,r){var t=rr.placeholder,e=function(){for(var u=0,o=r.length,i=Array(o),a=0;a1)ur(a,r-1,t,e),u=e.length;else for(var f=0,c=a.length;f0&&(t=r.apply(this,arguments)),n<=1&&(r=null),t}}var lr=rr(cr,2);function sr(n,r,t){r=qn(r,t);for(var e,u=nn(n),o=0,i=u.length;o0?0:u-1;o>=0&&o0?a=o>=0?o:Math.max(o+f,a):f=o>=0?Math.min(o+1,f):o+f+1;else if(t&&o&&f)return e[o=t(e,u)]===u?o:-1;if(u!=u)return(o=r(i.call(e,a,f),$))>=0?o+a:-1;for(o=n>0?a:f-1;o>=0&&o0?0:i-1;for(u||(e=r[o?o[a]:a],a+=n);a>=0&&a=3;return r(n,Fn(t,u,4),e,o)}}var Ar=wr(1),xr=wr(-1);function Sr(n,r,t){var e=[];return r=qn(r,t),jr(n,(function(n,t,u){r(n,t,u)&&e.push(n)})),e}function Or(n,r,t){r=qn(r,t);for(var e=!er(n)&&nn(n),u=(e||n).length,o=0;o=0}var Br=j((function(n,r,t){var e,u;return D(r)?u=r:(r=Nn(r),e=r.slice(0,-1),r=r[r.length-1]),_r(n,(function(n){var o=u;if(!o){if(e&&e.length&&(n=In(n,e)),null==n)return;o=n[r]}return null==o?o:o.apply(n,t)}))}));function Nr(n,r){return _r(n,Rn(r))}function Ir(n,r,t){var e,u,o=-1/0,i=-1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=er(n)?n:jn(n)).length;ao&&(o=e);else r=qn(r,t),jr(n,(function(n,t,e){((u=r(n,t,e))>i||u===-1/0&&o===-1/0)&&(o=n,i=u)}));return o}function Tr(n,r,t){if(null==r||t)return er(n)||(n=jn(n)),n[Wn(n.length-1)];var e=er(n)?En(n):jn(n),u=Y(e);r=Math.max(Math.min(r,u),0);for(var o=u-1,i=0;i1&&(e=Fn(e,r[1])),r=an(n)):(e=qr,r=ur(r,!1,!1),n=Object(n));for(var u=0,o=r.length;u1&&(t=r[1])):(r=_r(ur(r,!1,!1),String),e=function(n,t){return!Er(r,t)}),Ur(n,e,t)}));function zr(n,r,t){return i.call(n,0,Math.max(0,n.length-(null==r||t?1:r)))}function Lr(n,r,t){return null==n||n.length<1?null==r||t?void 0:[]:null==r||t?n[0]:zr(n,n.length-r)}function $r(n,r,t){return i.call(n,null==r||t?1:r)}var Cr=j((function(n,r){return r=ur(r,!0,!0),Sr(n,(function(n){return!Er(r,n)}))})),Kr=j((function(n,r){return Cr(n,r)}));function Jr(n,r,t,e){A(r)||(e=t,t=r,r=!1),null!=t&&(t=qn(t,e));for(var u=[],o=[],i=0,a=Y(n);ir?(e&&(clearTimeout(e),e=null),a=c,i=n.apply(u,o),e||(u=o=null)):e||!1===t.trailing||(e=setTimeout(f,l)),i};return c.cancel=function(){clearTimeout(e),a=0,e=u=o=null},c},debounce:function(n,r,t){var e,u,o,i,a,f=function(){var c=zn()-u;r>c?e=setTimeout(f,r-c):(e=null,t||(i=n.apply(a,o)),e||(o=a=null))},c=j((function(c){return a=this,o=c,u=zn(),e||(e=setTimeout(f,r),t&&(i=n.apply(a,o))),i}));return c.cancel=function(){clearTimeout(e),e=o=a=null},c},wrap:function(n,r){return rr(r,n)},negate:fr,compose:function(){var n=arguments,r=n.length-1;return function(){for(var t=r,e=n[r].apply(this,arguments);t--;)e=n[t].call(this,e);return e}},after:function(n,r){return function(){if(--n<1)return r.apply(this,arguments)}},before:cr,once:lr,findKey:sr,findIndex:vr,findLastIndex:hr,sortedIndex:yr,indexOf:gr,lastIndexOf:br,find:mr,detect:mr,findWhere:function(n,r){return mr(n,Dn(r))},each:jr,forEach:jr,map:_r,collect:_r,reduce:Ar,foldl:Ar,inject:Ar,reduceRight:xr,foldr:xr,filter:Sr,select:Sr,reject:function(n,r,t){return Sr(n,fr(qn(r)),t)},every:Or,all:Or,some:Mr,any:Mr,contains:Er,includes:Er,include:Er,invoke:Br,pluck:Nr,where:function(n,r){return Sr(n,Dn(r))},max:Ir,min:function(n,r,t){var e,u,o=1/0,i=1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=er(n)?n:jn(n)).length;ae||void 0===t)return 1;if(tNavigation

awsiot

-class awsiot.MqttServiceClient(mqtt_connection)
-

Bases: object

+class awsiot.MqttServiceClient(mqtt_connection) +

Bases: object

Base class for an AWS MQTT Service Client

Parameters
@@ -64,7 +64,7 @@

Navigation

-property mqtt_connection: awscrt.mqtt.Connection
+property mqtt_connection: awscrt.mqtt.Connection

MQTT connection used by this client

@@ -74,7 +74,7 @@

Navigation

Tell the MQTT server to stop sending messages to this topic.

Parameters
-

topic (str) – Topic to unsubscribe from

+

topic (str) – Topic to unsubscribe from

Returns

Future whose result will be None when the server @@ -90,8 +90,8 @@

Navigation

-class awsiot.ModeledClass
-

Bases: object

+class awsiot.ModeledClass +

Bases: object

Base for input/output classes generated from an AWS service model.

@@ -121,7 +121,7 @@

This Page

Quick search

- +
@@ -152,7 +152,7 @@

Navigation

\ No newline at end of file diff --git a/docs/awsiot/eventstreamrpc.html b/docs/awsiot/eventstreamrpc.html index bbef6f56..8a419624 100644 --- a/docs/awsiot/eventstreamrpc.html +++ b/docs/awsiot/eventstreamrpc.html @@ -55,65 +55,65 @@

Navigation

Classes for building a service that uses the event-stream RPC protocol.

-exception awsiot.eventstreamrpc.ConnectionClosedError
-

Bases: RuntimeError

+exception awsiot.eventstreamrpc.ConnectionClosedError +

Bases: RuntimeError

Connection is closed

-exception awsiot.eventstreamrpc.StreamClosedError
-

Bases: RuntimeError

+exception awsiot.eventstreamrpc.StreamClosedError +

Bases: RuntimeError

Stream is closed

-exception awsiot.eventstreamrpc.EventStreamError
-

Bases: RuntimeError

+exception awsiot.eventstreamrpc.EventStreamError +

Bases: RuntimeError

For connection-level errors.

-exception awsiot.eventstreamrpc.EventStreamOperationError
-

Bases: RuntimeError

+exception awsiot.eventstreamrpc.EventStreamOperationError +

Bases: RuntimeError

Base for all errors that come across the wire.

These are not necessarily modeled shapes.

-exception awsiot.eventstreamrpc.AccessDeniedError(*args)
+exception awsiot.eventstreamrpc.AccessDeniedError(*args)

Bases: awsiot.eventstreamrpc.EventStreamOperationError

Access Denied

-exception awsiot.eventstreamrpc.UnmappedDataError
-

Bases: RuntimeError

+exception awsiot.eventstreamrpc.UnmappedDataError +

Bases: RuntimeError

Received data that does not map to a known model type.

-exception awsiot.eventstreamrpc.SerializeError
-

Bases: RuntimeError

+exception awsiot.eventstreamrpc.SerializeError +

Bases: RuntimeError

Error serializing data to send.

-exception awsiot.eventstreamrpc.DeserializeError
-

Bases: RuntimeError

+exception awsiot.eventstreamrpc.DeserializeError +

Bases: RuntimeError

Error deserializing received data.

-class awsiot.eventstreamrpc.LifecycleHandler
-

Bases: object

+class awsiot.eventstreamrpc.LifecycleHandler +

Bases: object

Base class for handling connection events.

Inherit from this class and override methods to handle connection events. All callbacks for this connection will be invoked on the same thread. @@ -138,7 +138,7 @@

Navigation

This will not be invoked if the connection attempt failed.

Parameters
-

reason (Optional[Exception]) – Reason will be None if the user initiated the shutdown, +

reason (Optional[Exception]) – Reason will be None if the user initiated the shutdown, otherwise the reason will be an Exception.

@@ -152,7 +152,7 @@

Navigation

Parameters

  • reason – An Exception explaining the error

    • -

  • error (Exception) –

    • +

  • error (Exception) –

Returns
@@ -160,7 +160,7 @@

Navigation

or False if the connection should continute.

Return type
-

bool

+

bool

@@ -173,7 +173,7 @@

Navigation

Parameters
@@ -183,36 +183,36 @@

Navigation

-class awsiot.eventstreamrpc.MessageAmendment(*, headers=None, payload=None)
-

Bases: object

+class awsiot.eventstreamrpc.MessageAmendment(*, headers=None, payload=None) +

Bases: object

Data to add to an event-stream message.

Parameters

  • headers (Optional[Sequence[awscrt.eventstream.Header]]) – Headers to add (optional)

    • -

  • payload (Optional[bytes]) – Binary payload data (optional)

    • +

  • payload (Optional[bytes]) – Binary payload data (optional)

-headers: Optional[Sequence[awscrt.eventstream.Header]]
+headers: Optional[Sequence[awscrt.eventstream.Header]]

Headers to add

-payload: Optional[bytes]
+payload: Optional[bytes]

Binary payload data

-static create_static_authtoken_amender(authtoken)
+static create_static_authtoken_amender(authtoken)

Create function that amends payload: b’{“authToken”: “…”}’

Parameters
-

authtoken (str) – value of “authToken” in the payload. +

authtoken (str) – value of “authToken” in the payload. The same value is always used, even if the amender is called multiple times over the life of the application.

@@ -230,8 +230,8 @@

Navigation

-class awsiot.eventstreamrpc.Connection(*, host_name, port, bootstrap, socket_options=None, tls_connection_options=None, connect_message_amender=None)
-

Bases: object

+class awsiot.eventstreamrpc.Connection(*, host_name, port, bootstrap, socket_options=None, tls_connection_options=None, connect_message_amender=None) +

Bases: object

A client connection to event-stream RPC service.

connect() must be called to open the network connection before interacting with the service.

@@ -242,8 +242,8 @@

Navigation

Parameters
    -

  • host_name (str) – Remote host name.

    • -

  • port (int) – Remote port.

    • +

  • host_name (str) – Remote host name.

    • +

  • port (int) – Remote port.

  • bootstrap (awscrt.io.ClientBootstrap) – ClientBootstrap to use when initiating socket connection.

  • socket_options (Optional[awscrt.io.SocketOptions]) – Optional socket options. If None is provided, the default options are used.

    • @@ -292,7 +292,7 @@

    Navigation

    is already closed or closing.

    Parameters
    -

    reason (Optional[Exception]) – If set, the connection will +

    reason (Optional[Exception]) – If set, the connection will close with this error as the reason (unless it was already closing for another reason).

    @@ -312,26 +312,26 @@

    Navigation

    -class awsiot.eventstreamrpc.Shape
    -

    Bases: object

    +class awsiot.eventstreamrpc.Shape +

    Bases: object

    Base class for shapes serialized by a service

    -exception awsiot.eventstreamrpc.ErrorShape
    +exception awsiot.eventstreamrpc.ErrorShape

    Bases: awsiot.eventstreamrpc.Shape, awsiot.eventstreamrpc.EventStreamOperationError

    Base class for all error shapes serialized by a service

    -class awsiot.eventstreamrpc.ShapeIndex(shape_types)
    -

    Bases: object

    +class awsiot.eventstreamrpc.ShapeIndex(shape_types) +

    Bases: object

    Catalog of all shapes serialized by this service

    Parameters
    -

    shape_types (Sequence[type]) –

    +

    shape_types (Sequence[type]) –

    @@ -340,10 +340,10 @@

    Navigation

    Returns Shape type with given model_name, or None

    Parameters
    -

    model_name (str) –

    +

    model_name (str) –

    Return type
    -

    type

    +

    type

    @@ -352,8 +352,8 @@

    Navigation

    -class awsiot.eventstreamrpc.StreamResponseHandler
    -

    Bases: object

    +class awsiot.eventstreamrpc.StreamResponseHandler +

    Bases: object

    Base class for all operation stream handlers.

    For operations with a streaming response (0+ messages that may arrive after the initial response).

    @@ -361,14 +361,14 @@

    Navigation

    -class awsiot.eventstreamrpc.Operation
    -

    Bases: object

    +class awsiot.eventstreamrpc.Operation +

    Bases: object

    Base class for an operation.

    -class awsiot.eventstreamrpc.ClientOperation(stream_handler, shape_index, connection)
    +class awsiot.eventstreamrpc.ClientOperation(stream_handler, shape_index, connection)

    Bases: awsiot.eventstreamrpc.Operation

    Base class for a client operation.

    Nearly all functions are private/protected. Child classes should @@ -386,8 +386,8 @@

    Navigation

    -class awsiot.eventstreamrpc.Client(connection, shape_index)
    -

    Bases: object

    +class awsiot.eventstreamrpc.Client(connection, shape_index) +

    Bases: object

    Base class for a service client.

    Child class should add public API functions for each operation.

    @@ -426,7 +426,7 @@

    This Page

    Quick search

    - +
    @@ -457,7 +457,7 @@

    Navigation

    \ No newline at end of file diff --git a/docs/awsiot/greengrass_discovery.html b/docs/awsiot/greengrass_discovery.html index 929ba0d6..b49ff432 100644 --- a/docs/awsiot/greengrass_discovery.html +++ b/docs/awsiot/greengrass_discovery.html @@ -54,8 +54,8 @@

    Navigation

    awsiot.greengrass_discovery

    -class awsiot.greengrass_discovery.DiscoveryClient(bootstrap, socket_options, tls_context, region)
    -

    Bases: object

    +class awsiot.greengrass_discovery.DiscoveryClient(bootstrap, socket_options, tls_context, region) +

    Bases: object

    Client which performs Greengrass discovery.

    Parameters
    @@ -63,7 +63,7 @@

    Navigation

  • bootstrap (awscrt.io.ClientBootstrap) – Client bootstrap

  • socket_options (awscrt.io.SocketOptions) – Socket options

  • tls_context (awscrt.io.ClientTlsContext) – Client TLS context

    • -

  • region (str) – AWS region

    • +

  • region (str) – AWS region

@@ -78,7 +78,7 @@

Navigation

on success, or an exception on failure.

Parameters
-

thing_name (str) –

+

thing_name (str) –

Return type

concurrent.futures._base.Future

@@ -90,26 +90,26 @@

Navigation

-exception awsiot.greengrass_discovery.DiscoveryException(message, response_code)
-

Bases: Exception

+exception awsiot.greengrass_discovery.DiscoveryException(message, response_code) +

Bases: Exception

Discovery response was an error.

Parameters
    -

  • message (str) –

    • -

  • response_code (int) –

    • +

  • message (str) –

    • +

  • response_code (int) –

-http_response_code: int
+http_response_code: int

HTTP response code

-message: str
+message: str

Message

@@ -117,7 +117,7 @@

Navigation

-class awsiot.greengrass_discovery.ConnectivityInfo
+class awsiot.greengrass_discovery.ConnectivityInfo

Bases: awsiot.ModeledClass

Connectivity info

@@ -148,7 +148,7 @@

Navigation

-class awsiot.greengrass_discovery.GGCore
+class awsiot.greengrass_discovery.GGCore

Bases: awsiot.ModeledClass

Greengrass Core

@@ -167,7 +167,7 @@

Navigation

-class awsiot.greengrass_discovery.GGGroup
+class awsiot.greengrass_discovery.GGGroup

Bases: awsiot.ModeledClass

Greengrass group

@@ -192,12 +192,12 @@

Navigation

-class awsiot.greengrass_discovery.DiscoverResponse
+class awsiot.greengrass_discovery.DiscoverResponse

Bases: awsiot.ModeledClass

Discovery response

-gg_groups
+gg_groups: Optional[List[awsiot.greengrass_discovery.GGGroup]]

List of GGGroup

@@ -229,7 +229,7 @@

This Page

Quick search

- +
@@ -260,7 +260,7 @@

Navigation

\ No newline at end of file diff --git a/docs/awsiot/greengrasscoreipc.html b/docs/awsiot/greengrasscoreipc.html index cdd68afc..a953da70 100644 --- a/docs/awsiot/greengrasscoreipc.html +++ b/docs/awsiot/greengrasscoreipc.html @@ -59,14 +59,14 @@

Navigation

Parameters
    -

  • ipc_socket (Optional[str]) – Path to the Unix domain socket of Greengrass Nucleus, defaults to +

  • ipc_socket (Optional[str]) – Path to the Unix domain socket of Greengrass Nucleus, defaults to environment variable AWS_GG_NUCLEUS_DOMAIN_SOCKET_FILEPATH_FOR_COMPONENT

    • -

  • authtoken (Optional[str]) – Authentication token, defaults to environment variable SVCUID

    • +

  • authtoken (Optional[str]) – Authentication token, defaults to environment variable SVCUID

  • lifecycle_handler (Optional[awsiot.eventstreamrpc.LifecycleHandler]) – Handler for events over the course of this network connection. See LifecycleHandler for more info. Handler methods will only be invoked if the connect attempt succeeds.

    • -

  • timeout (float) – The number of seconds to wait for establishing the connection.

    • +

  • timeout (float) – The number of seconds to wait for establishing the connection.

Returns
@@ -80,7 +80,7 @@

Navigation

-class awsiot.greengrasscoreipc.client.SubscribeToIoTCoreStreamHandler
+class awsiot.greengrasscoreipc.client.SubscribeToIoTCoreStreamHandler

Bases: awsiot.eventstreamrpc.StreamResponseHandler

Event handler for SubscribeToIoTCoreOperation

Inherit from this class and override methods to handle @@ -94,7 +94,7 @@

Navigation

event (awsiot.greengrasscoreipc.model.IoTCoreMessage) –

Return type
-

None

+

None

@@ -106,10 +106,10 @@

Navigation

Return True if operation should close as a result of this error,

Parameters
-

error (Exception) –

+

error (Exception) –

Return type
-

bool

+

bool

@@ -120,7 +120,7 @@

Navigation

Invoked when the stream for this operation is closed.

Return type
-

None

+

None

@@ -129,7 +129,7 @@

Navigation

-class awsiot.greengrasscoreipc.client.SubscribeToIoTCoreOperation(stream_handler, shape_index, connection)
+class awsiot.greengrasscoreipc.client.SubscribeToIoTCoreOperation(stream_handler, shape_index, connection)

Bases: awsiot.greengrasscoreipc.model._SubscribeToIoTCoreOperation

Create with GreengrassCoreIPCClient.new_subscribe_to_iot_core()

@@ -186,10 +186,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.PublishToTopicOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._PublishToTopicOperation

-

Create with GreengrassCoreIPCClient.new_publish_to_topic()

+
+class awsiot.greengrasscoreipc.client.ResumeComponentOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._ResumeComponentOperation

+

Create with GreengrassCoreIPCClient.new_resume_component()

Parameters
    @@ -200,15 +200,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial PublishToTopicRequest message.

+
+activate(request)
+

Activate this operation by sending the initial ResumeComponentRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.PublishToTopicRequest) –

+

request (awsiot.greengrasscoreipc.model.ResumeComponentRequest) –

Return type

concurrent.futures._base.Future

@@ -217,9 +217,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of PublishToTopicResponse, +

+get_response()
+

Returns a Future which completes with a result of ResumeComponentResponse, when the initial response is received, or an exception.

Return type
@@ -229,8 +229,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -245,7 +245,7 @@

Navigation

-class awsiot.greengrasscoreipc.client.PublishToIoTCoreOperation(stream_handler, shape_index, connection)
+class awsiot.greengrasscoreipc.client.PublishToIoTCoreOperation(stream_handler, shape_index, connection)

Bases: awsiot.greengrasscoreipc.model._PublishToIoTCoreOperation

Create with GreengrassCoreIPCClient.new_publish_to_iot_core()

@@ -303,7 +303,7 @@

Navigation

-class awsiot.greengrasscoreipc.client.SubscribeToConfigurationUpdateStreamHandler
+class awsiot.greengrasscoreipc.client.SubscribeToConfigurationUpdateStreamHandler

Bases: awsiot.eventstreamrpc.StreamResponseHandler

Event handler for SubscribeToConfigurationUpdateOperation

Inherit from this class and override methods to handle @@ -317,7 +317,7 @@

Navigation

event (awsiot.greengrasscoreipc.model.ConfigurationUpdateEvents) –

Return type
-

None

+

None

@@ -329,10 +329,10 @@

Navigation

Return True if operation should close as a result of this error,

Parameters
-

error (Exception) –

+

error (Exception) –

Return type
-

bool

+

bool

@@ -343,7 +343,7 @@

Navigation

Invoked when the stream for this operation is closed.

Return type
-

None

+

None

@@ -352,7 +352,7 @@

Navigation

-class awsiot.greengrasscoreipc.client.SubscribeToConfigurationUpdateOperation(stream_handler, shape_index, connection)
+class awsiot.greengrasscoreipc.client.SubscribeToConfigurationUpdateOperation(stream_handler, shape_index, connection)

Bases: awsiot.greengrasscoreipc.model._SubscribeToConfigurationUpdateOperation

Create with GreengrassCoreIPCClient.new_subscribe_to_configuration_update()

@@ -409,10 +409,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.ListComponentsOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._ListComponentsOperation

-

Create with GreengrassCoreIPCClient.new_list_components()

+
+class awsiot.greengrasscoreipc.client.DeleteThingShadowOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._DeleteThingShadowOperation

+

Create with GreengrassCoreIPCClient.new_delete_thing_shadow()

Parameters
    @@ -423,15 +423,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial ListComponentsRequest message.

+
+activate(request)
+

Activate this operation by sending the initial DeleteThingShadowRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.ListComponentsRequest) –

+

request (awsiot.greengrasscoreipc.model.DeleteThingShadowRequest) –

Return type

concurrent.futures._base.Future

@@ -440,9 +440,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of ListComponentsResponse, +

+get_response()
+

Returns a Future which completes with a result of DeleteThingShadowResponse, when the initial response is received, or an exception.

Return type
@@ -452,8 +452,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -467,10 +467,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.CreateDebugPasswordOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._CreateDebugPasswordOperation

-

Create with GreengrassCoreIPCClient.new_create_debug_password()

+
+class awsiot.greengrasscoreipc.client.DeferComponentUpdateOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._DeferComponentUpdateOperation

+

Create with GreengrassCoreIPCClient.new_defer_component_update()

Parameters
    @@ -481,15 +481,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial CreateDebugPasswordRequest message.

+
+activate(request)
+

Activate this operation by sending the initial DeferComponentUpdateRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.CreateDebugPasswordRequest) –

+

request (awsiot.greengrasscoreipc.model.DeferComponentUpdateRequest) –

Return type

concurrent.futures._base.Future

@@ -498,9 +498,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of CreateDebugPasswordResponse, +

+get_response()
+

Returns a Future which completes with a result of DeferComponentUpdateResponse, when the initial response is received, or an exception.

Return type
@@ -510,8 +510,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -525,57 +525,48 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.DeferComponentUpdateOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._DeferComponentUpdateOperation

-

Create with GreengrassCoreIPCClient.new_defer_component_update()

-
-
Parameters
-
-
-
+
+class awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesStreamHandler
+

Bases: awsiot.eventstreamrpc.StreamResponseHandler

+

Event handler for SubscribeToValidateConfigurationUpdatesOperation

+

Inherit from this class and override methods to handle +stream events during a SubscribeToValidateConfigurationUpdatesOperation.

-
-activate(request)
-

Activate this operation by sending the initial DeferComponentUpdateRequest message.

-

Returns a Future which completes with a result of None if the -request is successfully written to the wire, or an exception if -the request fails to send.

+
+on_stream_event(event)
+

Invoked when a ValidateConfigurationUpdateEvents is received.

Parameters
-

request (awsiot.greengrasscoreipc.model.DeferComponentUpdateRequest) –

+

event (awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvents) –

Return type
-

concurrent.futures._base.Future

+

None

-
-get_response()
-

Returns a Future which completes with a result of DeferComponentUpdateResponse, -when the initial response is received, or an exception.

+
+on_stream_error(error)
+

Invoked when an error occurs on the operation stream.

+

Return True if operation should close as a result of this error,

-
Return type
-

concurrent.futures._base.Future

+
Parameters
+

error (Exception) –

+
+
Return type
+

bool

-
-close()
-

Close the operation, whether or not it has completed.

-

Returns a Future which completes with a result of None -when the operation has closed.

+
+on_stream_closed()
+

Invoked when the stream for this operation is closed.

Return type
-

concurrent.futures._base.Future

+

None

@@ -583,10 +574,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.SendConfigurationValidityReportOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._SendConfigurationValidityReportOperation

-

Create with GreengrassCoreIPCClient.new_send_configuration_validity_report()

+
+class awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._SubscribeToValidateConfigurationUpdatesOperation

+

Create with GreengrassCoreIPCClient.new_subscribe_to_validate_configuration_updates()

Parameters
    @@ -597,15 +588,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial SendConfigurationValidityReportRequest message.

+
+activate(request)
+

Activate this operation by sending the initial SubscribeToValidateConfigurationUpdatesRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.SendConfigurationValidityReportRequest) –

+

request (awsiot.greengrasscoreipc.model.SubscribeToValidateConfigurationUpdatesRequest) –

Return type

concurrent.futures._base.Future

@@ -614,9 +605,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of SendConfigurationValidityReportResponse, +

+get_response()
+

Returns a Future which completes with a result of SubscribeToValidateConfigurationUpdatesResponse, when the initial response is received, or an exception.

Return type
@@ -626,8 +617,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -641,10 +632,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.UpdateConfigurationOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._UpdateConfigurationOperation

-

Create with GreengrassCoreIPCClient.new_update_configuration()

+
+class awsiot.greengrasscoreipc.client.GetConfigurationOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._GetConfigurationOperation

+

Create with GreengrassCoreIPCClient.new_get_configuration()

Parameters
    @@ -655,15 +646,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial UpdateConfigurationRequest message.

+
+activate(request)
+

Activate this operation by sending the initial GetConfigurationRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.UpdateConfigurationRequest) –

+

request (awsiot.greengrasscoreipc.model.GetConfigurationRequest) –

Return type

concurrent.futures._base.Future

@@ -672,9 +663,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of UpdateConfigurationResponse, +

+get_response()
+

Returns a Future which completes with a result of GetConfigurationResponse, when the initial response is received, or an exception.

Return type
@@ -684,8 +675,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -699,48 +690,48 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesStreamHandler
+
+class awsiot.greengrasscoreipc.client.SubscribeToTopicStreamHandler

Bases: awsiot.eventstreamrpc.StreamResponseHandler

-

Event handler for SubscribeToValidateConfigurationUpdatesOperation

+

Event handler for SubscribeToTopicOperation

Inherit from this class and override methods to handle -stream events during a SubscribeToValidateConfigurationUpdatesOperation.

+stream events during a SubscribeToTopicOperation.

-
-on_stream_event(event)
-

Invoked when a ValidateConfigurationUpdateEvents is received.

+
+on_stream_event(event)
+

Invoked when a SubscriptionResponseMessage is received.

Parameters
-

event (awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvents) –

+

event (awsiot.greengrasscoreipc.model.SubscriptionResponseMessage) –

Return type
-

None

+

None

-
-on_stream_error(error)
+
+on_stream_error(error)

Invoked when an error occurs on the operation stream.

Return True if operation should close as a result of this error,

Parameters
-

error (Exception) –

+

error (Exception) –

Return type
-

bool

+

bool

-
-on_stream_closed()
+
+on_stream_closed()

Invoked when the stream for this operation is closed.

Return type
-

None

+

None

@@ -748,10 +739,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._SubscribeToValidateConfigurationUpdatesOperation

-

Create with GreengrassCoreIPCClient.new_subscribe_to_validate_configuration_updates()

+
+class awsiot.greengrasscoreipc.client.SubscribeToTopicOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._SubscribeToTopicOperation

+

Create with GreengrassCoreIPCClient.new_subscribe_to_topic()

Parameters
    @@ -762,15 +753,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial SubscribeToValidateConfigurationUpdatesRequest message.

+
+activate(request)
+

Activate this operation by sending the initial SubscribeToTopicRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.SubscribeToValidateConfigurationUpdatesRequest) –

+

request (awsiot.greengrasscoreipc.model.SubscribeToTopicRequest) –

Return type

concurrent.futures._base.Future

@@ -779,9 +770,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of SubscribeToValidateConfigurationUpdatesResponse, +

+get_response()
+

Returns a Future which completes with a result of SubscribeToTopicResponse, when the initial response is received, or an exception.

Return type
@@ -791,8 +782,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -806,10 +797,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.ValidateAuthorizationTokenOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._ValidateAuthorizationTokenOperation

-

Create with GreengrassCoreIPCClient.new_validate_authorization_token()

+
+class awsiot.greengrasscoreipc.client.GetComponentDetailsOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._GetComponentDetailsOperation

+

Create with GreengrassCoreIPCClient.new_get_component_details()

Parameters
    @@ -820,15 +811,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial ValidateAuthorizationTokenRequest message.

+
+activate(request)
+

Activate this operation by sending the initial GetComponentDetailsRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenRequest) –

+

request (awsiot.greengrasscoreipc.model.GetComponentDetailsRequest) –

Return type

concurrent.futures._base.Future

@@ -837,9 +828,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of ValidateAuthorizationTokenResponse, +

+get_response()
+

Returns a Future which completes with a result of GetComponentDetailsResponse, when the initial response is received, or an exception.

Return type
@@ -849,8 +840,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -864,10 +855,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.RestartComponentOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._RestartComponentOperation

-

Create with GreengrassCoreIPCClient.new_restart_component()

+
+class awsiot.greengrasscoreipc.client.PublishToTopicOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._PublishToTopicOperation

+

Create with GreengrassCoreIPCClient.new_publish_to_topic()

Parameters
    @@ -878,15 +869,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial RestartComponentRequest message.

+
+activate(request)
+

Activate this operation by sending the initial PublishToTopicRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.RestartComponentRequest) –

+

request (awsiot.greengrasscoreipc.model.PublishToTopicRequest) –

Return type

concurrent.futures._base.Future

@@ -895,9 +886,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of RestartComponentResponse, +

+get_response()
+

Returns a Future which completes with a result of PublishToTopicResponse, when the initial response is received, or an exception.

Return type
@@ -907,8 +898,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -922,10 +913,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.GetLocalDeploymentStatusOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._GetLocalDeploymentStatusOperation

-

Create with GreengrassCoreIPCClient.new_get_local_deployment_status()

+
+class awsiot.greengrasscoreipc.client.ListComponentsOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._ListComponentsOperation

+

Create with GreengrassCoreIPCClient.new_list_components()

Parameters
    @@ -936,15 +927,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial GetLocalDeploymentStatusRequest message.

+
+activate(request)
+

Activate this operation by sending the initial ListComponentsRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusRequest) –

+

request (awsiot.greengrasscoreipc.model.ListComponentsRequest) –

Return type

concurrent.futures._base.Future

@@ -953,9 +944,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of GetLocalDeploymentStatusResponse, +

+get_response()
+

Returns a Future which completes with a result of ListComponentsResponse, when the initial response is received, or an exception.

Return type
@@ -965,8 +956,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -980,10 +971,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.GetSecretValueOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._GetSecretValueOperation

-

Create with GreengrassCoreIPCClient.new_get_secret_value()

+
+class awsiot.greengrasscoreipc.client.CreateDebugPasswordOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._CreateDebugPasswordOperation

+

Create with GreengrassCoreIPCClient.new_create_debug_password()

Parameters
    @@ -994,15 +985,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial GetSecretValueRequest message.

+
+activate(request)
+

Activate this operation by sending the initial CreateDebugPasswordRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.GetSecretValueRequest) –

+

request (awsiot.greengrasscoreipc.model.CreateDebugPasswordRequest) –

Return type

concurrent.futures._base.Future

@@ -1011,9 +1002,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of GetSecretValueResponse, +

+get_response()
+

Returns a Future which completes with a result of CreateDebugPasswordResponse, when the initial response is received, or an exception.

Return type
@@ -1023,8 +1014,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -1038,10 +1029,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.UpdateStateOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._UpdateStateOperation

-

Create with GreengrassCoreIPCClient.new_update_state()

+
+class awsiot.greengrasscoreipc.client.GetThingShadowOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._GetThingShadowOperation

+

Create with GreengrassCoreIPCClient.new_get_thing_shadow()

Parameters
    @@ -1052,15 +1043,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial UpdateStateRequest message.

+
+activate(request)
+

Activate this operation by sending the initial GetThingShadowRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.UpdateStateRequest) –

+

request (awsiot.greengrasscoreipc.model.GetThingShadowRequest) –

Return type

concurrent.futures._base.Future

@@ -1069,9 +1060,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of UpdateStateResponse, +

+get_response()
+

Returns a Future which completes with a result of GetThingShadowResponse, when the initial response is received, or an exception.

Return type
@@ -1081,8 +1072,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -1096,10 +1087,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.GetConfigurationOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._GetConfigurationOperation

-

Create with GreengrassCoreIPCClient.new_get_configuration()

+
+class awsiot.greengrasscoreipc.client.SendConfigurationValidityReportOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._SendConfigurationValidityReportOperation

+

Create with GreengrassCoreIPCClient.new_send_configuration_validity_report()

Parameters
    @@ -1110,15 +1101,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial GetConfigurationRequest message.

+
+activate(request)
+

Activate this operation by sending the initial SendConfigurationValidityReportRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.GetConfigurationRequest) –

+

request (awsiot.greengrasscoreipc.model.SendConfigurationValidityReportRequest) –

Return type

concurrent.futures._base.Future

@@ -1127,9 +1118,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of GetConfigurationResponse, +

+get_response()
+

Returns a Future which completes with a result of SendConfigurationValidityReportResponse, when the initial response is received, or an exception.

Return type
@@ -1139,8 +1130,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -1154,48 +1145,57 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.SubscribeToTopicStreamHandler
-

Bases: awsiot.eventstreamrpc.StreamResponseHandler

-

Event handler for SubscribeToTopicOperation

-

Inherit from this class and override methods to handle -stream events during a SubscribeToTopicOperation.

+
+class awsiot.greengrasscoreipc.client.UpdateThingShadowOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._UpdateThingShadowOperation

+

Create with GreengrassCoreIPCClient.new_update_thing_shadow()

+
+
Parameters
+
+
+
-
-on_stream_event(event)
-

Invoked when a SubscriptionResponseMessage is received.

+
+activate(request)
+

Activate this operation by sending the initial UpdateThingShadowRequest message.

+

Returns a Future which completes with a result of None if the +request is successfully written to the wire, or an exception if +the request fails to send.

Parameters
-

event (awsiot.greengrasscoreipc.model.SubscriptionResponseMessage) –

+

request (awsiot.greengrasscoreipc.model.UpdateThingShadowRequest) –

Return type
-

None

+

concurrent.futures._base.Future

-
-on_stream_error(error)
-

Invoked when an error occurs on the operation stream.

-

Return True if operation should close as a result of this error,

+
+get_response()
+

Returns a Future which completes with a result of UpdateThingShadowResponse, +when the initial response is received, or an exception.

-
Parameters
-

error (Exception) –

-
-
Return type
-

bool

+
Return type
+

concurrent.futures._base.Future

-
-on_stream_closed()
-

Invoked when the stream for this operation is closed.

+
+close()
+

Close the operation, whether or not it has completed.

+

Returns a Future which completes with a result of None +when the operation has closed.

Return type
-

None

+

concurrent.futures._base.Future

@@ -1203,10 +1203,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.SubscribeToTopicOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._SubscribeToTopicOperation

-

Create with GreengrassCoreIPCClient.new_subscribe_to_topic()

+
+class awsiot.greengrasscoreipc.client.UpdateConfigurationOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._UpdateConfigurationOperation

+

Create with GreengrassCoreIPCClient.new_update_configuration()

Parameters
    @@ -1217,15 +1217,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial SubscribeToTopicRequest message.

+
+activate(request)
+

Activate this operation by sending the initial UpdateConfigurationRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.SubscribeToTopicRequest) –

+

request (awsiot.greengrasscoreipc.model.UpdateConfigurationRequest) –

Return type

concurrent.futures._base.Future

@@ -1234,9 +1234,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of SubscribeToTopicResponse, +

+get_response()
+

Returns a Future which completes with a result of UpdateConfigurationResponse, when the initial response is received, or an exception.

Return type
@@ -1246,8 +1246,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -1261,10 +1261,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.GetComponentDetailsOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._GetComponentDetailsOperation

-

Create with GreengrassCoreIPCClient.new_get_component_details()

+
+class awsiot.greengrasscoreipc.client.ValidateAuthorizationTokenOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._ValidateAuthorizationTokenOperation

+

Create with GreengrassCoreIPCClient.new_validate_authorization_token()

Parameters
    @@ -1275,15 +1275,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial GetComponentDetailsRequest message.

+
+activate(request)
+

Activate this operation by sending the initial ValidateAuthorizationTokenRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.GetComponentDetailsRequest) –

+

request (awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenRequest) –

Return type

concurrent.futures._base.Future

@@ -1292,9 +1292,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of GetComponentDetailsResponse, +

+get_response()
+

Returns a Future which completes with a result of ValidateAuthorizationTokenResponse, when the initial response is received, or an exception.

Return type
@@ -1304,8 +1304,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -1319,48 +1319,57 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.SubscribeToComponentUpdatesStreamHandler
-

Bases: awsiot.eventstreamrpc.StreamResponseHandler

-

Event handler for SubscribeToComponentUpdatesOperation

-

Inherit from this class and override methods to handle -stream events during a SubscribeToComponentUpdatesOperation.

+
+class awsiot.greengrasscoreipc.client.RestartComponentOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._RestartComponentOperation

+

Create with GreengrassCoreIPCClient.new_restart_component()

+
+
Parameters
+
+
+
-
-on_stream_event(event)
-

Invoked when a ComponentUpdatePolicyEvents is received.

+
+activate(request)
+

Activate this operation by sending the initial RestartComponentRequest message.

+

Returns a Future which completes with a result of None if the +request is successfully written to the wire, or an exception if +the request fails to send.

Parameters
-

event (awsiot.greengrasscoreipc.model.ComponentUpdatePolicyEvents) –

+

request (awsiot.greengrasscoreipc.model.RestartComponentRequest) –

Return type
-

None

+

concurrent.futures._base.Future

-
-on_stream_error(error)
-

Invoked when an error occurs on the operation stream.

-

Return True if operation should close as a result of this error,

+
+get_response()
+

Returns a Future which completes with a result of RestartComponentResponse, +when the initial response is received, or an exception.

-
Parameters
-

error (Exception) –

-
-
Return type
-

bool

+
Return type
+

concurrent.futures._base.Future

-
-on_stream_closed()
-

Invoked when the stream for this operation is closed.

+
+close()
+

Close the operation, whether or not it has completed.

+

Returns a Future which completes with a result of None +when the operation has closed.

Return type
-

None

+

concurrent.futures._base.Future

@@ -1368,10 +1377,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.SubscribeToComponentUpdatesOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._SubscribeToComponentUpdatesOperation

-

Create with GreengrassCoreIPCClient.new_subscribe_to_component_updates()

+
+class awsiot.greengrasscoreipc.client.GetLocalDeploymentStatusOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._GetLocalDeploymentStatusOperation

+

Create with GreengrassCoreIPCClient.new_get_local_deployment_status()

Parameters
    @@ -1382,15 +1391,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial SubscribeToComponentUpdatesRequest message.

+
+activate(request)
+

Activate this operation by sending the initial GetLocalDeploymentStatusRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.SubscribeToComponentUpdatesRequest) –

+

request (awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusRequest) –

Return type

concurrent.futures._base.Future

@@ -1399,9 +1408,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of SubscribeToComponentUpdatesResponse, +

+get_response()
+

Returns a Future which completes with a result of GetLocalDeploymentStatusResponse, when the initial response is received, or an exception.

Return type
@@ -1411,8 +1420,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -1426,10 +1435,10 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.ListLocalDeploymentsOperation(stream_handler, shape_index, connection)
-

Bases: awsiot.greengrasscoreipc.model._ListLocalDeploymentsOperation

-

Create with GreengrassCoreIPCClient.new_list_local_deployments()

+
+class awsiot.greengrasscoreipc.client.GetSecretValueOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._GetSecretValueOperation

+

Create with GreengrassCoreIPCClient.new_get_secret_value()

Parameters
    @@ -1440,15 +1449,15 @@

    Navigation

-
-activate(request)
-

Activate this operation by sending the initial ListLocalDeploymentsRequest message.

+
+activate(request)
+

Activate this operation by sending the initial GetSecretValueRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.ListLocalDeploymentsRequest) –

+

request (awsiot.greengrasscoreipc.model.GetSecretValueRequest) –

Return type

concurrent.futures._base.Future

@@ -1457,9 +1466,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of ListLocalDeploymentsResponse, +

+get_response()
+

Returns a Future which completes with a result of GetSecretValueResponse, when the initial response is received, or an exception.

Return type
@@ -1469,8 +1478,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -1484,8 +1493,289 @@

Navigation

-
-class awsiot.greengrasscoreipc.client.StopComponentOperation(stream_handler, shape_index, connection)
+
+class awsiot.greengrasscoreipc.client.UpdateStateOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._UpdateStateOperation

+

Create with GreengrassCoreIPCClient.new_update_state()

+
+
Parameters
+
+
+
+
+
+activate(request)
+

Activate this operation by sending the initial UpdateStateRequest message.

+

Returns a Future which completes with a result of None if the +request is successfully written to the wire, or an exception if +the request fails to send.

+
+
Parameters
+

request (awsiot.greengrasscoreipc.model.UpdateStateRequest) –

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+
+get_response()
+

Returns a Future which completes with a result of UpdateStateResponse, +when the initial response is received, or an exception.

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+
+close()
+

Close the operation, whether or not it has completed.

+

Returns a Future which completes with a result of None +when the operation has closed.

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.client.ListNamedShadowsForThingOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._ListNamedShadowsForThingOperation

+

Create with GreengrassCoreIPCClient.new_list_named_shadows_for_thing()

+
+
Parameters
+
+
+
+
+
+activate(request)
+

Activate this operation by sending the initial ListNamedShadowsForThingRequest message.

+

Returns a Future which completes with a result of None if the +request is successfully written to the wire, or an exception if +the request fails to send.

+
+
Parameters
+

request (awsiot.greengrasscoreipc.model.ListNamedShadowsForThingRequest) –

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+
+get_response()
+

Returns a Future which completes with a result of ListNamedShadowsForThingResponse, +when the initial response is received, or an exception.

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+
+close()
+

Close the operation, whether or not it has completed.

+

Returns a Future which completes with a result of None +when the operation has closed.

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.client.SubscribeToComponentUpdatesStreamHandler
+

Bases: awsiot.eventstreamrpc.StreamResponseHandler

+

Event handler for SubscribeToComponentUpdatesOperation

+

Inherit from this class and override methods to handle +stream events during a SubscribeToComponentUpdatesOperation.

+
+
+on_stream_event(event)
+

Invoked when a ComponentUpdatePolicyEvents is received.

+
+
Parameters
+

event (awsiot.greengrasscoreipc.model.ComponentUpdatePolicyEvents) –

+
+
Return type
+

None

+
+
+
+ +
+
+on_stream_error(error)
+

Invoked when an error occurs on the operation stream.

+

Return True if operation should close as a result of this error,

+
+
Parameters
+

error (Exception) –

+
+
Return type
+

bool

+
+
+
+ +
+
+on_stream_closed()
+

Invoked when the stream for this operation is closed.

+
+
Return type
+

None

+
+
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.client.SubscribeToComponentUpdatesOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._SubscribeToComponentUpdatesOperation

+

Create with GreengrassCoreIPCClient.new_subscribe_to_component_updates()

+
+
Parameters
+
+
+
+
+
+activate(request)
+

Activate this operation by sending the initial SubscribeToComponentUpdatesRequest message.

+

Returns a Future which completes with a result of None if the +request is successfully written to the wire, or an exception if +the request fails to send.

+
+
Parameters
+

request (awsiot.greengrasscoreipc.model.SubscribeToComponentUpdatesRequest) –

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+
+get_response()
+

Returns a Future which completes with a result of SubscribeToComponentUpdatesResponse, +when the initial response is received, or an exception.

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+
+close()
+

Close the operation, whether or not it has completed.

+

Returns a Future which completes with a result of None +when the operation has closed.

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.client.ListLocalDeploymentsOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._ListLocalDeploymentsOperation

+

Create with GreengrassCoreIPCClient.new_list_local_deployments()

+
+
Parameters
+
+
+
+
+
+activate(request)
+

Activate this operation by sending the initial ListLocalDeploymentsRequest message.

+

Returns a Future which completes with a result of None if the +request is successfully written to the wire, or an exception if +the request fails to send.

+
+
Parameters
+

request (awsiot.greengrasscoreipc.model.ListLocalDeploymentsRequest) –

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+
+get_response()
+

Returns a Future which completes with a result of ListLocalDeploymentsResponse, +when the initial response is received, or an exception.

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+
+close()
+

Close the operation, whether or not it has completed.

+

Returns a Future which completes with a result of None +when the operation has closed.

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.client.StopComponentOperation(stream_handler, shape_index, connection)

Bases: awsiot.greengrasscoreipc.model._StopComponentOperation

Create with GreengrassCoreIPCClient.new_stop_component()

@@ -1498,15 +1788,73 @@

Navigation

-
-activate(request)
-

Activate this operation by sending the initial StopComponentRequest message.

+
+activate(request)
+

Activate this operation by sending the initial StopComponentRequest message.

+

Returns a Future which completes with a result of None if the +request is successfully written to the wire, or an exception if +the request fails to send.

+
+
Parameters
+

request (awsiot.greengrasscoreipc.model.StopComponentRequest) –

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+
+get_response()
+

Returns a Future which completes with a result of StopComponentResponse, +when the initial response is received, or an exception.

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+
+close()
+

Close the operation, whether or not it has completed.

+

Returns a Future which completes with a result of None +when the operation has closed.

+
+
Return type
+

concurrent.futures._base.Future

+
+
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.client.PauseComponentOperation(stream_handler, shape_index, connection)
+

Bases: awsiot.greengrasscoreipc.model._PauseComponentOperation

+

Create with GreengrassCoreIPCClient.new_pause_component()

+
+
Parameters
+
+
+
+
+
+activate(request)
+

Activate this operation by sending the initial PauseComponentRequest message.

Returns a Future which completes with a result of None if the request is successfully written to the wire, or an exception if the request fails to send.

Parameters
-

request (awsiot.greengrasscoreipc.model.StopComponentRequest) –

+

request (awsiot.greengrasscoreipc.model.PauseComponentRequest) –

Return type

concurrent.futures._base.Future

@@ -1515,9 +1863,9 @@

Navigation

-
-get_response()
-

Returns a Future which completes with a result of StopComponentResponse, +

+get_response()
+

Returns a Future which completes with a result of PauseComponentResponse, when the initial response is received, or an exception.

Return type
@@ -1527,8 +1875,8 @@

Navigation

-
-close()
+
+close()

Close the operation, whether or not it has completed.

Returns a Future which completes with a result of None when the operation has closed.

@@ -1543,7 +1891,7 @@

Navigation

-class awsiot.greengrasscoreipc.client.CreateLocalDeploymentOperation(stream_handler, shape_index, connection)
+class awsiot.greengrasscoreipc.client.CreateLocalDeploymentOperation(stream_handler, shape_index, connection)

Bases: awsiot.greengrasscoreipc.model._CreateLocalDeploymentOperation

Create with GreengrassCoreIPCClient.new_create_local_deployment()

@@ -1601,7 +1949,7 @@

Navigation

-class awsiot.greengrasscoreipc.client.GreengrassCoreIPCClient(connection)
+class awsiot.greengrasscoreipc.client.GreengrassCoreIPCClient(connection)

Bases: awsiot.eventstreamrpc.Client

Client for the GreengrassCoreIPC service.

@@ -1628,15 +1976,15 @@

Navigation

-
-new_publish_to_topic()
-

Create a new PublishToTopicOperation.

+
+new_resume_component()
+

Create a new ResumeComponentOperation.

This operation will not send or receive any data until activate() is called. Call activate() when you’re ready for callbacks and events to fire.

Return type
-

awsiot.greengrasscoreipc.client.PublishToTopicOperation

+

awsiot.greengrasscoreipc.client.ResumeComponentOperation

@@ -1673,6 +2021,112 @@

Navigation

+
+
+new_delete_thing_shadow()
+

Create a new DeleteThingShadowOperation.

+

This operation will not send or receive any data until activate() +is called. Call activate() when you’re ready for callbacks and +events to fire.

+
+
Return type
+

awsiot.greengrasscoreipc.client.DeleteThingShadowOperation

+
+
+
+ +
+
+new_defer_component_update()
+

Create a new DeferComponentUpdateOperation.

+

This operation will not send or receive any data until activate() +is called. Call activate() when you’re ready for callbacks and +events to fire.

+
+
Return type
+

awsiot.greengrasscoreipc.client.DeferComponentUpdateOperation

+
+
+
+ +
+
+new_subscribe_to_validate_configuration_updates(stream_handler)
+

Create a new SubscribeToValidateConfigurationUpdatesOperation.

+

This operation will not send or receive any data until activate() +is called. Call activate() when you’re ready for callbacks and +events to fire.

+
+
Parameters
+

stream_handler (awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesStreamHandler) – Methods on this object will be called as +stream events happen on this operation.

+
+
Return type
+

awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesOperation

+
+
+
+ +
+
+new_get_configuration()
+

Create a new GetConfigurationOperation.

+

This operation will not send or receive any data until activate() +is called. Call activate() when you’re ready for callbacks and +events to fire.

+
+
Return type
+

awsiot.greengrasscoreipc.client.GetConfigurationOperation

+
+
+
+ +
+
+new_subscribe_to_topic(stream_handler)
+

Create a new SubscribeToTopicOperation.

+

This operation will not send or receive any data until activate() +is called. Call activate() when you’re ready for callbacks and +events to fire.

+
+
Parameters
+

stream_handler (awsiot.greengrasscoreipc.client.SubscribeToTopicStreamHandler) – Methods on this object will be called as +stream events happen on this operation.

+
+
Return type
+

awsiot.greengrasscoreipc.client.SubscribeToTopicOperation

+
+
+
+ +
+
+new_get_component_details()
+

Create a new GetComponentDetailsOperation.

+

This operation will not send or receive any data until activate() +is called. Call activate() when you’re ready for callbacks and +events to fire.

+
+
Return type
+

awsiot.greengrasscoreipc.client.GetComponentDetailsOperation

+
+
+
+ +
+
+new_publish_to_topic()
+

Create a new PublishToTopicOperation.

+

This operation will not send or receive any data until activate() +is called. Call activate() when you’re ready for callbacks and +events to fire.

+
+
Return type
+

awsiot.greengrasscoreipc.client.PublishToTopicOperation

+
+
+
+
new_list_components()
@@ -1702,15 +2156,15 @@

Navigation

-
-new_defer_component_update()
-

Create a new DeferComponentUpdateOperation.

+
+new_get_thing_shadow()
+

Create a new GetThingShadowOperation.

This operation will not send or receive any data until activate() is called. Call activate() when you’re ready for callbacks and events to fire.

Return type
-

awsiot.greengrasscoreipc.client.DeferComponentUpdateOperation

+

awsiot.greengrasscoreipc.client.GetThingShadowOperation

@@ -1730,33 +2184,29 @@

Navigation

-
-new_update_configuration()
-

Create a new UpdateConfigurationOperation.

+
+new_update_thing_shadow()
+

Create a new UpdateThingShadowOperation.

This operation will not send or receive any data until activate() is called. Call activate() when you’re ready for callbacks and events to fire.

Return type
-

awsiot.greengrasscoreipc.client.UpdateConfigurationOperation

+

awsiot.greengrasscoreipc.client.UpdateThingShadowOperation

-
-new_subscribe_to_validate_configuration_updates(stream_handler)
-

Create a new SubscribeToValidateConfigurationUpdatesOperation.

+
+new_update_configuration()
+

Create a new UpdateConfigurationOperation.

This operation will not send or receive any data until activate() is called. Call activate() when you’re ready for callbacks and events to fire.

-
Parameters
-

stream_handler (awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesStreamHandler) – Methods on this object will be called as -stream events happen on this operation.

-
-
Return type
-

awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesOperation

+
Return type
+

awsiot.greengrasscoreipc.client.UpdateConfigurationOperation

@@ -1832,47 +2282,15 @@

Navigation

-
-new_get_configuration()
-

Create a new GetConfigurationOperation.

-

This operation will not send or receive any data until activate() -is called. Call activate() when you’re ready for callbacks and -events to fire.

-
-
Return type
-

awsiot.greengrasscoreipc.client.GetConfigurationOperation

-
-
-
- -
-
-new_subscribe_to_topic(stream_handler)
-

Create a new SubscribeToTopicOperation.

-

This operation will not send or receive any data until activate() -is called. Call activate() when you’re ready for callbacks and -events to fire.

-
-
Parameters
-

stream_handler (awsiot.greengrasscoreipc.client.SubscribeToTopicStreamHandler) – Methods on this object will be called as -stream events happen on this operation.

-
-
Return type
-

awsiot.greengrasscoreipc.client.SubscribeToTopicOperation

-
-
-
- -
-
-new_get_component_details()
-

Create a new GetComponentDetailsOperation.

+
+new_list_named_shadows_for_thing()
+

Create a new ListNamedShadowsForThingOperation.

This operation will not send or receive any data until activate() is called. Call activate() when you’re ready for callbacks and events to fire.

Return type
-

awsiot.greengrasscoreipc.client.GetComponentDetailsOperation

+

awsiot.greengrasscoreipc.client.ListNamedShadowsForThingOperation

@@ -1923,6 +2341,20 @@

Navigation

+
+
+new_pause_component()
+

Create a new PauseComponentOperation.

+

This operation will not send or receive any data until activate() +is called. Call activate() when you’re ready for callbacks and +events to fire.

+
+
Return type
+

awsiot.greengrasscoreipc.client.PauseComponentOperation

+
+
+
+
new_create_local_deployment()
@@ -1941,168 +2373,148 @@

Navigation

-exception awsiot.greengrasscoreipc.model.GreengrassCoreIPCError
+exception awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

Bases: awsiot.eventstreamrpc.ErrorShape

Base for all error messages sent by server.

-
-class awsiot.greengrasscoreipc.model.RunWithInfo(*, posix_user=None)
+
+class awsiot.greengrasscoreipc.model.SystemResourceLimits(*, memory=None, cpus=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

posix_user –

+
    +

  • memory –

    • +

  • cpus –

    • +
Parameters
-

posix_user (Optional[str]) –

+
    +

  • memory (Optional[int]) –

    • +

  • cpus (Optional[float]) –

    • +
-
-posix_user
+
+memory
-
- -
-
-class awsiot.greengrasscoreipc.model.PostComponentUpdateEvent(*, deployment_id=None)
-

Bases: awsiot.eventstreamrpc.Shape

-

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

-
-
Keyword Arguments
-

deployment_id –

-
-
Parameters
-

deployment_id (Optional[str]) –

-
-
-
-deployment_id
+
+cpus
-
-class awsiot.greengrasscoreipc.model.PreComponentUpdateEvent(*, deployment_id=None, is_ggc_restarting=None)
+
+class awsiot.greengrasscoreipc.model.RunWithInfo(*, posix_user=None, system_resource_limits=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
    -

  • deployment_id –

    • -

  • is_ggc_restarting –

    • +

  • posix_user –

    • +

  • system_resource_limits –

Parameters
-
-deployment_id
+
+posix_user
-
-is_ggc_restarting
+
+system_resource_limits
-
-class awsiot.greengrasscoreipc.model.LifecycleState
-

Bases: object

-

LifecycleState enum

-
- -
-
-class awsiot.greengrasscoreipc.model.DeploymentStatus
-

Bases: object

-

DeploymentStatus enum

-
- -
-
-class awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvent(*, configuration=None, deployment_id=None)
+
+class awsiot.greengrasscoreipc.model.PostComponentUpdateEvent(*, deployment_id=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-
    -

  • configuration –

    • -

  • deployment_id –

    • -
+

deployment_id –

Parameters
-
    -

  • configuration (Optional[Dict[str, Any]]) –

    • -

  • deployment_id (Optional[str]) –

    • -
+

deployment_id (Optional[str]) –

-
-configuration
-
- -
-
-deployment_id
+
+deployment_id
-
-class awsiot.greengrasscoreipc.model.ConfigurationValidityStatus
-

Bases: object

-

ConfigurationValidityStatus enum

-
- -
-
-class awsiot.greengrasscoreipc.model.ConfigurationUpdateEvent(*, component_name=None, key_path=None)
+
+class awsiot.greengrasscoreipc.model.PreComponentUpdateEvent(*, deployment_id=None, is_ggc_restarting=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
    -

  • component_name –

    • -

  • key_path –

    • +

  • deployment_id –

    • +

  • is_ggc_restarting –

Parameters
    -

  • component_name (Optional[str]) –

    • -

  • key_path (Optional[List[str]]) –

    • +

  • deployment_id (Optional[str]) –

    • +

  • is_ggc_restarting (Optional[bool]) –

-
-component_name
+
+deployment_id
-
-key_path
+
+is_ggc_restarting
+
+
+class awsiot.greengrasscoreipc.model.DeploymentStatus
+

Bases: object

+

DeploymentStatus enum

+
+ +
+
+class awsiot.greengrasscoreipc.model.ConfigurationValidityStatus
+

Bases: object

+

ConfigurationValidityStatus enum

+
+ +
+
+class awsiot.greengrasscoreipc.model.LifecycleState
+

Bases: object

+

LifecycleState enum

+
+
-class awsiot.greengrasscoreipc.model.BinaryMessage(*, message=None)
+class awsiot.greengrasscoreipc.model.BinaryMessage(*, message=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -2110,7 +2522,7 @@

Navigation

message –

Parameters
-

message (Optional[bytes]) –

+

message (Optional[bytes]) –

@@ -2122,7 +2534,7 @@

Navigation

-class awsiot.greengrasscoreipc.model.JsonMessage(*, message=None)
+class awsiot.greengrasscoreipc.model.JsonMessage(*, message=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -2130,7 +2542,7 @@

Navigation

message –

Parameters
-

message (Optional[Dict[str, Any]]) –

+

message (Optional[Dict[str, Any]]) –

@@ -2141,162 +2553,144 @@

Navigation

-
-class awsiot.greengrasscoreipc.model.MQTTMessage(*, topic_name=None, payload=None)
+
+class awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvent(*, configuration=None, deployment_id=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
    -

  • topic_name –

    • -

  • payload –

    • +

  • configuration –

    • +

  • deployment_id –

Parameters
    -

  • topic_name (Optional[str]) –

    • -

  • payload (Optional[bytes]) –

    • +

  • configuration (Optional[Dict[str, Any]]) –

    • +

  • deployment_id (Optional[str]) –

-
-topic_name
+
+configuration
-
-payload
+
+deployment_id
-
-class awsiot.greengrasscoreipc.model.ComponentUpdatePolicyEvents(*, pre_update_event=None, post_update_event=None)
+
+class awsiot.greengrasscoreipc.model.ConfigurationUpdateEvent(*, component_name=None, key_path=None)

Bases: awsiot.eventstreamrpc.Shape

-

MQTTMessage is a “tagged union” class.

-

When sending, only one of the attributes may be set. -When receiving, only one of the attributes will be set. -All other attributes will be None.

+

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

Keyword Arguments
    -

  • pre_update_event –

    • -

  • post_update_event –

    • +

  • component_name –

    • +

  • key_path –

Parameters
-
-pre_update_event
+
+component_name
-
-post_update_event
+
+key_path
-
-class awsiot.greengrasscoreipc.model.ComponentDetails(*, component_name=None, version=None, state=None, configuration=None)
+
+class awsiot.greengrasscoreipc.model.MQTTMessage(*, topic_name=None, payload=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
    -

  • component_name –

    • -

  • version –

    • -

  • state – LifecycleState enum value

    • -

  • configuration –

    • +

  • topic_name –

    • +

  • payload –

Parameters
    -

  • component_name (Optional[str]) –

    • -

  • version (Optional[str]) –

    • -

  • state (Optional[str]) –

    • -

  • configuration (Optional[Dict[str, Any]]) –

    • +

  • topic_name (Optional[str]) –

    • +

  • payload (Optional[bytes]) –

-
-component_name
-
- -
-
-version
+
+topic_name
-
-state
-

LifecycleState enum value

-
- -
-
-configuration
+
+payload
-
-class awsiot.greengrasscoreipc.model.SubscriptionResponseMessage(*, json_message=None, binary_message=None)
+
+class awsiot.greengrasscoreipc.model.ComponentUpdatePolicyEvents(*, pre_update_event=None, post_update_event=None)

Bases: awsiot.eventstreamrpc.Shape

-

ComponentDetails is a “tagged union” class.

+

MQTTMessage is a “tagged union” class.

When sending, only one of the attributes may be set. When receiving, only one of the attributes will be set. All other attributes will be None.

Keyword Arguments
    -

  • json_message –

    • -

  • binary_message –

    • +

  • pre_update_event –

    • +

  • post_update_event –

Parameters
-
-json_message
+
+pre_update_event
-
-binary_message
+
+post_update_event
-class awsiot.greengrasscoreipc.model.ReportedLifecycleState
-

Bases: object

+class awsiot.greengrasscoreipc.model.ReportedLifecycleState +

Bases: object

ReportedLifecycleState enum

-class awsiot.greengrasscoreipc.model.SecretValue(*, secret_string=None, secret_binary=None)
+class awsiot.greengrasscoreipc.model.SecretValue(*, secret_string=None, secret_binary=None)

Bases: awsiot.eventstreamrpc.Shape

-

ComponentDetails is a “tagged union” class.

+

MQTTMessage is a “tagged union” class.

When sending, only one of the attributes may be set. When receiving, only one of the attributes will be set. All other attributes will be None.

@@ -2309,8 +2703,8 @@

Navigation

Parameters
    -

  • secret_string (Optional[str]) –

    • -

  • secret_binary (Optional[bytes]) –

    • +

  • secret_string (Optional[str]) –

    • +

  • secret_binary (Optional[bytes]) –

@@ -2328,7 +2722,7 @@

Navigation

-class awsiot.greengrasscoreipc.model.LocalDeployment(*, deployment_id=None, status=None)
+class awsiot.greengrasscoreipc.model.LocalDeployment(*, deployment_id=None, status=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -2340,8 +2734,8 @@

Navigation

Parameters
    -

  • deployment_id (Optional[str]) –

    • -

  • status (Optional[str]) –

    • +

  • deployment_id (Optional[str]) –

    • +

  • status (Optional[str]) –

@@ -2360,37 +2754,14 @@

Navigation

-class awsiot.greengrasscoreipc.model.RequestStatus
-

Bases: object

+class awsiot.greengrasscoreipc.model.RequestStatus +

Bases: object

RequestStatus enum

-
-
-class awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvents(*, validate_configuration_update_event=None)
-

Bases: awsiot.eventstreamrpc.Shape

-

LocalDeployment is a “tagged union” class.

-

When sending, only one of the attributes may be set. -When receiving, only one of the attributes will be set. -All other attributes will be None.

-
-
Keyword Arguments
-

validate_configuration_update_event –

-
-
Parameters
-

validate_configuration_update_event (Optional[awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvent]) –

-
-
-
-
-validate_configuration_update_event
-
- -
-
-class awsiot.greengrasscoreipc.model.ConfigurationValidityReport(*, status=None, deployment_id=None, message=None)
+class awsiot.greengrasscoreipc.model.ConfigurationValidityReport(*, status=None, deployment_id=None, message=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -2403,9 +2774,9 @@

Navigation

Parameters
    -

  • status (Optional[str]) –

    • -

  • deployment_id (Optional[str]) –

    • -

  • message (Optional[str]) –

    • +

  • status (Optional[str]) –

    • +

  • deployment_id (Optional[str]) –

    • +

  • message (Optional[str]) –

@@ -2428,8 +2799,8 @@

Navigation

-
-class awsiot.greengrasscoreipc.model.ConfigurationUpdateEvents(*, configuration_update_event=None)
+
+class awsiot.greengrasscoreipc.model.PublishMessage(*, json_message=None, binary_message=None)

Bases: awsiot.eventstreamrpc.Shape

ConfigurationValidityReport is a “tagged union” class.

When sending, only one of the attributes may be set. @@ -2437,24 +2808,81 @@

Navigation

All other attributes will be None.

Keyword Arguments
-

configuration_update_event –

+
    +

  • json_message –

    • +

  • binary_message –

    • +
Parameters
-

configuration_update_event (Optional[awsiot.greengrasscoreipc.model.ConfigurationUpdateEvent]) –

+
-
-configuration_update_event
+
+json_message
+
+ +
+
+binary_message
-
-class awsiot.greengrasscoreipc.model.PublishMessage(*, json_message=None, binary_message=None)
+
+class awsiot.greengrasscoreipc.model.ComponentDetails(*, component_name=None, version=None, state=None, configuration=None)

Bases: awsiot.eventstreamrpc.Shape

-

ConfigurationValidityReport is a “tagged union” class.

+

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

+
+
Keyword Arguments
+
    +

  • component_name –

    • +

  • version –

    • +

  • state – LifecycleState enum value

    • +

  • configuration –

    • +
+
+
Parameters
+
    +

  • component_name (Optional[str]) –

    • +

  • version (Optional[str]) –

    • +

  • state (Optional[str]) –

    • +

  • configuration (Optional[Dict[str, Any]]) –

    • +
+
+
+
+
+component_name
+
+ +
+
+version
+
+ +
+
+state
+

LifecycleState enum value

+
+ +
+
+configuration
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.SubscriptionResponseMessage(*, json_message=None, binary_message=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

ComponentDetails is a “tagged union” class.

When sending, only one of the attributes may be set. When receiving, only one of the attributes will be set. All other attributes will be None.

@@ -2473,22 +2901,68 @@

Navigation

-
-json_message
+
+json_message
-
-binary_message
+
+binary_message
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvents(*, validate_configuration_update_event=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

ComponentDetails is a “tagged union” class.

+

When sending, only one of the attributes may be set. +When receiving, only one of the attributes will be set. +All other attributes will be None.

+
+
Keyword Arguments
+

validate_configuration_update_event –

+
+
Parameters
+

validate_configuration_update_event (Optional[awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvent]) –

+
+
+
+
+validate_configuration_update_event
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.ConfigurationUpdateEvents(*, configuration_update_event=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

ComponentDetails is a “tagged union” class.

+

When sending, only one of the attributes may be set. +When receiving, only one of the attributes will be set. +All other attributes will be None.

+
+
Keyword Arguments
+

configuration_update_event –

+
+
Parameters
+

configuration_update_event (Optional[awsiot.greengrasscoreipc.model.ConfigurationUpdateEvent]) –

+
+
+
+
+configuration_update_event
-class awsiot.greengrasscoreipc.model.IoTCoreMessage(*, message=None)
+class awsiot.greengrasscoreipc.model.IoTCoreMessage(*, message=None)

Bases: awsiot.eventstreamrpc.Shape

-

ConfigurationValidityReport is a “tagged union” class.

+

ComponentDetails is a “tagged union” class.

When sending, only one of the attributes may be set. When receiving, only one of the attributes will be set. All other attributes will be None.

@@ -2509,14 +2983,14 @@

Navigation

-class awsiot.greengrasscoreipc.model.QOS
-

Bases: object

+class awsiot.greengrasscoreipc.model.QOS +

Bases: object

QOS enum

-exception awsiot.greengrasscoreipc.model.InvalidArtifactsDirectoryPathError(*, message=None)
+exception awsiot.greengrasscoreipc.model.InvalidArtifactsDirectoryPathError(*, message=None)

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

@@ -2524,7 +2998,7 @@

Navigation

message –

Parameters
-

message (Optional[str]) –

+

message (Optional[str]) –

@@ -2536,7 +3010,7 @@

Navigation

-exception awsiot.greengrasscoreipc.model.InvalidRecipeDirectoryPathError(*, message=None)
+exception awsiot.greengrasscoreipc.model.InvalidRecipeDirectoryPathError(*, message=None)

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

@@ -2544,7 +3018,7 @@

Navigation

message –

Parameters
-

message (Optional[str]) –

+

message (Optional[str]) –

@@ -2556,7 +3030,7 @@

Navigation

-class awsiot.greengrasscoreipc.model.CreateLocalDeploymentResponse(*, deployment_id=None)
+class awsiot.greengrasscoreipc.model.CreateLocalDeploymentResponse(*, deployment_id=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -2564,7 +3038,7 @@

Navigation

deployment_id –

Parameters
-

deployment_id (Optional[str]) –

+

deployment_id (Optional[str]) –

@@ -2576,7 +3050,7 @@

Navigation

-class awsiot.greengrasscoreipc.model.CreateLocalDeploymentRequest(*, group_name=None, root_component_versions_to_add=None, root_components_to_remove=None, component_to_configuration=None, component_to_run_with_info=None, recipe_directory_path=None, artifacts_directory_path=None)
+class awsiot.greengrasscoreipc.model.CreateLocalDeploymentRequest(*, group_name=None, root_component_versions_to_add=None, root_components_to_remove=None, component_to_configuration=None, component_to_run_with_info=None, recipe_directory_path=None, artifacts_directory_path=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -2593,13 +3067,13 @@

Navigation

Parameters
    -

  • group_name (Optional[str]) –

    • -

  • root_component_versions_to_add (Optional[Dict[str, str]]) –

    • -

  • root_components_to_remove (Optional[List[str]]) –

    • -

  • component_to_configuration (Optional[Dict[str, Dict[str, Any]]]) –

    • -

  • component_to_run_with_info (Optional[Dict[str, awsiot.greengrasscoreipc.model.RunWithInfo]]) –

    • -

  • recipe_directory_path (Optional[str]) –

    • -

  • artifacts_directory_path (Optional[str]) –

    • +

  • group_name (Optional[str]) –

    • +

  • root_component_versions_to_add (Optional[Dict[str, str]]) –

    • +

  • root_components_to_remove (Optional[List[str]]) –

    • +

  • component_to_configuration (Optional[Dict[str, Dict[str, Any]]]) –

    • +

  • component_to_run_with_info (Optional[Dict[str, awsiot.greengrasscoreipc.model.RunWithInfo]]) –

    • +

  • recipe_directory_path (Optional[str]) –

    • +

  • artifacts_directory_path (Optional[str]) –

@@ -2640,9 +3114,35 @@

Navigation

+
+
+class awsiot.greengrasscoreipc.model.PauseComponentResponse
+

Bases: awsiot.eventstreamrpc.Shape

+
+ +
+
+class awsiot.greengrasscoreipc.model.PauseComponentRequest(*, component_name=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+

component_name –

+
+
Parameters
+

component_name (Optional[str]) –

+
+
+
+
+component_name
+
+ +
+
-class awsiot.greengrasscoreipc.model.StopComponentResponse(*, stop_status=None, message=None)
+class awsiot.greengrasscoreipc.model.StopComponentResponse(*, stop_status=None, message=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -2654,8 +3154,8 @@

Navigation

Parameters
    -

  • stop_status (Optional[str]) –

    • -

  • message (Optional[str]) –

    • +

  • stop_status (Optional[str]) –

    • +

  • message (Optional[str]) –

@@ -2674,7 +3174,7 @@

Navigation

-class awsiot.greengrasscoreipc.model.StopComponentRequest(*, component_name=None)
+class awsiot.greengrasscoreipc.model.StopComponentRequest(*, component_name=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -2682,7 +3182,7 @@

Navigation

component_name –

Parameters
-

component_name (Optional[str]) –

+

component_name (Optional[str]) –

@@ -2694,7 +3194,7 @@

Navigation

-class awsiot.greengrasscoreipc.model.ListLocalDeploymentsResponse(*, local_deployments=None)
+class awsiot.greengrasscoreipc.model.ListLocalDeploymentsResponse(*, local_deployments=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -2714,597 +3214,883 @@

Navigation

-class awsiot.greengrasscoreipc.model.ListLocalDeploymentsRequest
+class awsiot.greengrasscoreipc.model.ListLocalDeploymentsRequest +

Bases: awsiot.eventstreamrpc.Shape

+
+ +
+
+class awsiot.greengrasscoreipc.model.SubscribeToComponentUpdatesResponse
+

Bases: awsiot.eventstreamrpc.Shape

+
+ +
+
+class awsiot.greengrasscoreipc.model.SubscribeToComponentUpdatesRequest
+

Bases: awsiot.eventstreamrpc.Shape

+
+ +
+
+class awsiot.greengrasscoreipc.model.ListNamedShadowsForThingResponse(*, results=None, timestamp=None, next_token=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+
    +

  • results –

    • +

  • timestamp –

    • +

  • next_token –

    • +
+
+
Parameters
+
+
+
+
+
+results
+
+ +
+
+timestamp
+
+ +
+
+next_token
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.ListNamedShadowsForThingRequest(*, thing_name=None, next_token=None, page_size=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+
    +

  • thing_name –

    • +

  • next_token –

    • +

  • page_size –

    • +
+
+
Parameters
+
    +

  • thing_name (Optional[str]) –

    • +

  • next_token (Optional[str]) –

    • +

  • page_size (Optional[int]) –

    • +
+
+
+
+
+thing_name
+
+ +
+
+next_token
+
+ +
+
+page_size
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.UpdateStateResponse
+

Bases: awsiot.eventstreamrpc.Shape

+
+ +
+
+class awsiot.greengrasscoreipc.model.UpdateStateRequest(*, state=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+

state – ReportedLifecycleState enum value

+
+
Parameters
+

state (Optional[str]) –

+
+
+
+
+state
+

ReportedLifecycleState enum value

+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.GetSecretValueResponse(*, secret_id=None, version_id=None, version_stage=None, secret_value=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+
    +

  • secret_id –

    • +

  • version_id –

    • +

  • version_stage –

    • +

  • secret_value –

    • +
+
+
Parameters
+
+
+
+
+
+secret_id
+
+ +
+
+version_id
+
+ +
+
+version_stage
+
+ +
+
+secret_value
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.GetSecretValueRequest(*, secret_id=None, version_id=None, version_stage=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+
    +

  • secret_id –

    • +

  • version_id –

    • +

  • version_stage –

    • +
+
+
Parameters
+
    +

  • secret_id (Optional[str]) –

    • +

  • version_id (Optional[str]) –

    • +

  • version_stage (Optional[str]) –

    • +
+
+
+
+
+secret_id
+
+ +
+
+version_id
+
+ +
+
+version_stage
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusResponse(*, deployment=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+

deployment –

+
+
Parameters
+

deployment (Optional[awsiot.greengrasscoreipc.model.LocalDeployment]) –

+
+
+
+
+deployment
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusRequest(*, deployment_id=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+

deployment_id –

+
+
Parameters
+

deployment_id (Optional[str]) –

+
+
+
+
+deployment_id
+
+ +
+ +
+
+exception awsiot.greengrasscoreipc.model.ComponentNotFoundError(*, message=None)
+

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

+

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

+
+
Keyword Arguments
+

message –

+
+
Parameters
+

message (Optional[str]) –

+
+
+
+
+message
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.RestartComponentResponse(*, restart_status=None, message=None)

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+
    +

  • restart_status – RequestStatus enum value

    • +

  • message –

    • +
+
+
Parameters
+
    +

  • restart_status (Optional[str]) –

    • +

  • message (Optional[str]) –

    • +
+
+
+
+
+restart_status
+

RequestStatus enum value

-
-
-class awsiot.greengrasscoreipc.model.SubscribeToComponentUpdatesResponse
-

Bases: awsiot.eventstreamrpc.Shape

-
+
+
+message
+
-
-
-class awsiot.greengrasscoreipc.model.SubscribeToComponentUpdatesRequest
-

Bases: awsiot.eventstreamrpc.Shape

-
-class awsiot.greengrasscoreipc.model.GetComponentDetailsResponse(*, component_details=None)
+
+class awsiot.greengrasscoreipc.model.RestartComponentRequest(*, component_name=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

component_details –

+

component_name –

Parameters
-

component_details (Optional[awsiot.greengrasscoreipc.model.ComponentDetails]) –

+

component_name (Optional[str]) –

-
-component_details
+
+component_name
-
-
-class awsiot.greengrasscoreipc.model.GetComponentDetailsRequest(*, component_name=None)
-

Bases: awsiot.eventstreamrpc.Shape

+
+
+exception awsiot.greengrasscoreipc.model.InvalidTokenError(*, message=None)
+

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

Keyword Arguments
-

component_name –

+

message –

Parameters
-

component_name (Optional[str]) –

+

message (Optional[str]) –

-
-component_name
+
+message
-
-class awsiot.greengrasscoreipc.model.SubscribeToTopicResponse(*, topic_name=None)
+
+class awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenResponse(*, is_valid=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

topic_name –

+

is_valid –

Parameters
-

topic_name (Optional[str]) –

+

is_valid (Optional[bool]) –

-
-topic_name
+
+is_valid
-
-class awsiot.greengrasscoreipc.model.SubscribeToTopicRequest(*, topic=None)
+
+class awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenRequest(*, token=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

topic –

+

token –

Parameters
-

topic (Optional[str]) –

+

token (Optional[str]) –

-
-topic
+
+token
-
-
-class awsiot.greengrasscoreipc.model.GetConfigurationResponse(*, component_name=None, value=None)
-

Bases: awsiot.eventstreamrpc.Shape

+
+
+exception awsiot.greengrasscoreipc.model.FailedUpdateConditionCheckError(*, message=None)
+

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

Keyword Arguments
-
    -

  • component_name –

    • -

  • value –

    • -
+

message –

Parameters
-
    -

  • component_name (Optional[str]) –

    • -

  • value (Optional[Dict[str, Any]]) –

    • -
+

message (Optional[str]) –

-
-component_name
+
+message
-
-
-value
-
+
+
+
+class awsiot.greengrasscoreipc.model.UpdateConfigurationResponse
+

Bases: awsiot.eventstreamrpc.Shape

-
-class awsiot.greengrasscoreipc.model.GetConfigurationRequest(*, component_name=None, key_path=None)
+
+class awsiot.greengrasscoreipc.model.UpdateConfigurationRequest(*, key_path=None, timestamp=None, value_to_merge=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
    -

  • component_name –

  • key_path –

    • +

  • timestamp –

    • +

  • value_to_merge –

Parameters
    -

  • component_name (Optional[str]) –

    • -

  • key_path (Optional[List[str]]) –

    • +

  • key_path (Optional[List[str]]) –

    • +

  • timestamp (Optional[datetime.datetime]) –

    • +

  • value_to_merge (Optional[Dict[str, Any]]) –

-
-component_name
+
+key_path
-
-key_path
+
+timestamp
-
+
+
+value_to_merge
+
-
-
-class awsiot.greengrasscoreipc.model.UpdateStateResponse
-

Bases: awsiot.eventstreamrpc.Shape

-
-
-class awsiot.greengrasscoreipc.model.UpdateStateRequest(*, state=None)
-

Bases: awsiot.eventstreamrpc.Shape

+
+
+exception awsiot.greengrasscoreipc.model.ConflictError(*, message=None)
+

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

Keyword Arguments
-

state – ReportedLifecycleState enum value

+

message –

Parameters
-

state (Optional[str]) –

+

message (Optional[str]) –

-
-state
-

ReportedLifecycleState enum value

-
+
+message
+
-
-class awsiot.greengrasscoreipc.model.GetSecretValueResponse(*, secret_id=None, version_id=None, version_stage=None, secret_value=None)
+
+class awsiot.greengrasscoreipc.model.UpdateThingShadowResponse(*, payload=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-
    -

  • secret_id –

    • -

  • version_id –

    • -

  • version_stage –

    • -

  • secret_value –

    • -
+

payload –

Parameters
-
+

payload (Optional[bytes]) –

-
-secret_id
-
- -
-
-version_id
-
- -
-
-version_stage
-
- -
-
-secret_value
+
+payload
-
-class awsiot.greengrasscoreipc.model.GetSecretValueRequest(*, secret_id=None, version_id=None, version_stage=None)
+
+class awsiot.greengrasscoreipc.model.UpdateThingShadowRequest(*, thing_name=None, shadow_name=None, payload=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
    -

  • secret_id –

    • -

  • version_id –

    • -

  • version_stage –

    • +

  • thing_name –

    • +

  • shadow_name –

    • +

  • payload –

Parameters
    -

  • secret_id (Optional[str]) –

    • -

  • version_id (Optional[str]) –

    • -

  • version_stage (Optional[str]) –

    • +

  • thing_name (Optional[str]) –

    • +

  • shadow_name (Optional[str]) –

    • +

  • payload (Optional[bytes]) –

-
-secret_id
+
+thing_name
-
-version_id
+
+shadow_name
-
-version_stage
+
+payload
-
-class awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusResponse(*, deployment=None)
+
+class awsiot.greengrasscoreipc.model.SendConfigurationValidityReportResponse
+

Bases: awsiot.eventstreamrpc.Shape

+
+ +
+
+class awsiot.greengrasscoreipc.model.SendConfigurationValidityReportRequest(*, configuration_validity_report=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

deployment –

+

configuration_validity_report –

Parameters
-

deployment (Optional[awsiot.greengrasscoreipc.model.LocalDeployment]) –

+

configuration_validity_report (Optional[awsiot.greengrasscoreipc.model.ConfigurationValidityReport]) –

-
-deployment
+
+configuration_validity_report
-
-class awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusRequest(*, deployment_id=None)
+
+class awsiot.greengrasscoreipc.model.GetThingShadowResponse(*, payload=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

deployment_id –

+

payload –

Parameters
-

deployment_id (Optional[str]) –

+

payload (Optional[bytes]) –

-
-deployment_id
+
+payload
-
-
-exception awsiot.greengrasscoreipc.model.ComponentNotFoundError(*, message=None)
-

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

+
+
+class awsiot.greengrasscoreipc.model.GetThingShadowRequest(*, thing_name=None, shadow_name=None)
+

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

message –

+
    +

  • thing_name –

    • +

  • shadow_name –

    • +
Parameters
-

message (Optional[str]) –

+
    +

  • thing_name (Optional[str]) –

    • +

  • shadow_name (Optional[str]) –

    • +
-
-message
+
+thing_name
+
+ +
+
+shadow_name
-
-class awsiot.greengrasscoreipc.model.RestartComponentResponse(*, restart_status=None, message=None)
+
+class awsiot.greengrasscoreipc.model.CreateDebugPasswordResponse(*, password=None, username=None, password_expiration=None, certificate_sha256_hash=None, certificate_sha1_hash=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
    -

  • restart_status – RequestStatus enum value

    • -

  • message –

    • +

  • password –

    • +

  • username –

    • +

  • password_expiration –

    • +

  • certificate_sha256_hash –

    • +

  • certificate_sha1_hash –

Parameters
    -

  • restart_status (Optional[str]) –

    • -

  • message (Optional[str]) –

    • +

  • password (Optional[str]) –

    • +

  • username (Optional[str]) –

    • +

  • password_expiration (Optional[datetime.datetime]) –

    • +

  • certificate_sha256_hash (Optional[str]) –

    • +

  • certificate_sha1_hash (Optional[str]) –

-
-restart_status
-

RequestStatus enum value

+
+password
+
+ +
+
+username
+
+ +
+
+password_expiration
+
+ +
+
+certificate_sha256_hash
+
+ +
+
+certificate_sha1_hash
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.CreateDebugPasswordRequest
+

Bases: awsiot.eventstreamrpc.Shape

+
+
+class awsiot.greengrasscoreipc.model.ListComponentsResponse(*, components=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+

components –

+
+
Parameters
+

components (Optional[List[awsiot.greengrasscoreipc.model.ComponentDetails]]) –

+
+
-
-message
+
+components
-
-class awsiot.greengrasscoreipc.model.RestartComponentRequest(*, component_name=None)
+
+class awsiot.greengrasscoreipc.model.ListComponentsRequest
+

Bases: awsiot.eventstreamrpc.Shape

+
+ +
+
+class awsiot.greengrasscoreipc.model.PublishToTopicResponse
+

Bases: awsiot.eventstreamrpc.Shape

+
+ +
+
+class awsiot.greengrasscoreipc.model.PublishToTopicRequest(*, topic=None, publish_message=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

component_name –

+
    +

  • topic –

    • +

  • publish_message –

    • +
Parameters
-

component_name (Optional[str]) –

+
-
-component_name
+
+topic
+
+ +
+
+publish_message
-
-
-exception awsiot.greengrasscoreipc.model.InvalidTokenError(*, message=None)
-

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

+
+
+class awsiot.greengrasscoreipc.model.GetComponentDetailsResponse(*, component_details=None)
+

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

message –

+

component_details –

Parameters
-

message (Optional[str]) –

+

component_details (Optional[awsiot.greengrasscoreipc.model.ComponentDetails]) –

-
-message
+
+component_details
-
-class awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenResponse(*, is_valid=None)
+
+class awsiot.greengrasscoreipc.model.GetComponentDetailsRequest(*, component_name=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

is_valid –

+

component_name –

Parameters
-

is_valid (Optional[bool]) –

+

component_name (Optional[str]) –

-
-is_valid
+
+component_name
-
-class awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenRequest(*, token=None)
+
+class awsiot.greengrasscoreipc.model.SubscribeToTopicResponse(*, topic_name=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

token –

+

topic_name –

Parameters
-

token (Optional[str]) –

+

topic_name (Optional[str]) –

-
-token
+
+topic_name
-
-class awsiot.greengrasscoreipc.model.SubscribeToValidateConfigurationUpdatesResponse
-

Bases: awsiot.eventstreamrpc.Shape

-
- -
-
-class awsiot.greengrasscoreipc.model.SubscribeToValidateConfigurationUpdatesRequest
+
+class awsiot.greengrasscoreipc.model.SubscribeToTopicRequest(*, topic=None)

Bases: awsiot.eventstreamrpc.Shape

-
- -
-
-exception awsiot.greengrasscoreipc.model.FailedUpdateConditionCheckError(*, message=None)
-

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

Keyword Arguments
-

message –

+

topic –

Parameters
-

message (Optional[str]) –

+

topic (Optional[str]) –

-
-message
+
+topic
-
-
-exception awsiot.greengrasscoreipc.model.ConflictError(*, message=None)
-

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

+
+
+class awsiot.greengrasscoreipc.model.GetConfigurationResponse(*, component_name=None, value=None)
+

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

message –

+
    +

  • component_name –

    • +

  • value –

    • +
Parameters
-

message (Optional[str]) –

+
    +

  • component_name (Optional[str]) –

    • +

  • value (Optional[Dict[str, Any]]) –

    • +
-
-message
+
+component_name
-
+
+
+value
+
-
-
-class awsiot.greengrasscoreipc.model.UpdateConfigurationResponse
-

Bases: awsiot.eventstreamrpc.Shape

-
-class awsiot.greengrasscoreipc.model.UpdateConfigurationRequest(*, key_path=None, timestamp=None, value_to_merge=None)
+
+class awsiot.greengrasscoreipc.model.GetConfigurationRequest(*, component_name=None, key_path=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
    +

  • component_name –

  • key_path –

    • -

  • timestamp –

    • -

  • value_to_merge –

Parameters
    -

  • key_path (Optional[List[str]]) –

    • -

  • timestamp (Optional[datetime.datetime]) –

    • -

  • value_to_merge (Optional[Dict[str, Any]]) –

    • +

  • component_name (Optional[str]) –

    • +

  • key_path (Optional[List[str]]) –

-
-key_path
-
- -
-
-timestamp
+
+component_name
-
-value_to_merge
+
+key_path
-
-class awsiot.greengrasscoreipc.model.SendConfigurationValidityReportResponse
+
+class awsiot.greengrasscoreipc.model.SubscribeToValidateConfigurationUpdatesResponse

Bases: awsiot.eventstreamrpc.Shape

-
-class awsiot.greengrasscoreipc.model.SendConfigurationValidityReportRequest(*, configuration_validity_report=None)
+
+class awsiot.greengrasscoreipc.model.SubscribeToValidateConfigurationUpdatesRequest

Bases: awsiot.eventstreamrpc.Shape

-

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

-
-
Keyword Arguments
-

configuration_validity_report –

-
-
Parameters
-

configuration_validity_report (Optional[awsiot.greengrasscoreipc.model.ConfigurationValidityReport]) –

-
-
-
-
-configuration_validity_report
-
- -
- -
-
-exception awsiot.greengrasscoreipc.model.InvalidArgumentsError(*, message=None)
-

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

-

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

-
-
Keyword Arguments
-

message –

-
-
Parameters
-

message (Optional[str]) –

-
-
-
-
-message
-
-
-class awsiot.greengrasscoreipc.model.DeferComponentUpdateResponse
+class awsiot.greengrasscoreipc.model.DeferComponentUpdateResponse

Bases: awsiot.eventstreamrpc.Shape

-class awsiot.greengrasscoreipc.model.DeferComponentUpdateRequest(*, deployment_id=None, message=None, recheck_after_ms=None)
+class awsiot.greengrasscoreipc.model.DeferComponentUpdateRequest(*, deployment_id=None, message=None, recheck_after_ms=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -3317,9 +4103,9 @@

Navigation

Parameters
    -

  • deployment_id (Optional[str]) –

    • -

  • message (Optional[str]) –

    • -

  • recheck_after_ms (Optional[int]) –

    • +

  • deployment_id (Optional[str]) –

    • +

  • message (Optional[str]) –

    • +

  • recheck_after_ms (Optional[int]) –

@@ -3340,137 +4126,86 @@

Navigation

-
-
-class awsiot.greengrasscoreipc.model.CreateDebugPasswordResponse(*, password=None, username=None, password_expiration=None, certificate_sha256_hash=None, certificate_sha1_hash=None)
-

Bases: awsiot.eventstreamrpc.Shape

+
+
+exception awsiot.greengrasscoreipc.model.InvalidArgumentsError(*, message=None)
+

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

Keyword Arguments
-
    -

  • password –

    • -

  • username –

    • -

  • password_expiration –

    • -

  • certificate_sha256_hash –

    • -

  • certificate_sha1_hash –

    • -
+

message –

Parameters
-
    -

  • password (Optional[str]) –

    • -

  • username (Optional[str]) –

    • -

  • password_expiration (Optional[datetime.datetime]) –

    • -

  • certificate_sha256_hash (Optional[str]) –

    • -

  • certificate_sha1_hash (Optional[str]) –

    • -
+

message (Optional[str]) –

-
-password
-
- -
-
-username
-
- -
-
-password_expiration
-
- -
-
-certificate_sha256_hash
-
- -
-
-certificate_sha1_hash
+
+message
-
-class awsiot.greengrasscoreipc.model.CreateDebugPasswordRequest
-

Bases: awsiot.eventstreamrpc.Shape

-
- -
-
-class awsiot.greengrasscoreipc.model.ListComponentsResponse(*, components=None)
+
+class awsiot.greengrasscoreipc.model.DeleteThingShadowResponse(*, payload=None)

Bases: awsiot.eventstreamrpc.Shape

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

Keyword Arguments
-

components –

+

payload –

Parameters
-

components (Optional[List[awsiot.greengrasscoreipc.model.ComponentDetails]]) –

+

payload (Optional[bytes]) –

-
-components
+
+payload
-
-class awsiot.greengrasscoreipc.model.ListComponentsRequest
+
+class awsiot.greengrasscoreipc.model.DeleteThingShadowRequest(*, thing_name=None, shadow_name=None)

Bases: awsiot.eventstreamrpc.Shape

-
- -
-
-exception awsiot.greengrasscoreipc.model.ResourceNotFoundError(*, message=None, resource_type=None, resource_name=None)
-

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

Keyword Arguments
    -

  • message –

    • -

  • resource_type –

    • -

  • resource_name –

    • +

  • thing_name –

    • +

  • shadow_name –

Parameters
    -

  • message (Optional[str]) –

    • -

  • resource_type (Optional[str]) –

    • -

  • resource_name (Optional[str]) –

    • +

  • thing_name (Optional[str]) –

    • +

  • shadow_name (Optional[str]) –

-
-message
-
- -
-
-resource_type
+
+thing_name
-
-resource_name
+
+shadow_name
-class awsiot.greengrasscoreipc.model.SubscribeToConfigurationUpdateResponse
+class awsiot.greengrasscoreipc.model.SubscribeToConfigurationUpdateResponse

Bases: awsiot.eventstreamrpc.Shape

-class awsiot.greengrasscoreipc.model.SubscribeToConfigurationUpdateRequest(*, component_name=None, key_path=None)
+class awsiot.greengrasscoreipc.model.SubscribeToConfigurationUpdateRequest(*, component_name=None, key_path=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -3482,8 +4217,8 @@

Navigation

Parameters
    -

  • component_name (Optional[str]) –

    • -

  • key_path (Optional[List[str]]) –

    • +

  • component_name (Optional[str]) –

    • +

  • key_path (Optional[List[str]]) –

@@ -3501,13 +4236,13 @@

Navigation

-class awsiot.greengrasscoreipc.model.PublishToIoTCoreResponse
+class awsiot.greengrasscoreipc.model.PublishToIoTCoreResponse

Bases: awsiot.eventstreamrpc.Shape

-class awsiot.greengrasscoreipc.model.PublishToIoTCoreRequest(*, topic_name=None, qos=None, payload=None)
+class awsiot.greengrasscoreipc.model.PublishToIoTCoreRequest(*, topic_name=None, qos=None, payload=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -3520,9 +4255,9 @@

Navigation

Parameters
    -

  • topic_name (Optional[str]) –

    • -

  • qos (Optional[str]) –

    • -

  • payload (Optional[bytes]) –

    • +

  • topic_name (Optional[str]) –

    • +

  • qos (Optional[str]) –

    • +

  • payload (Optional[bytes]) –

@@ -3544,46 +4279,73 @@

Navigation

-
-
-class awsiot.greengrasscoreipc.model.PublishToTopicResponse
-

Bases: awsiot.eventstreamrpc.Shape

-
- -
-
-class awsiot.greengrasscoreipc.model.PublishToTopicRequest(*, topic=None, publish_message=None)
-

Bases: awsiot.eventstreamrpc.Shape

+
+
+exception awsiot.greengrasscoreipc.model.ResourceNotFoundError(*, message=None, resource_type=None, resource_name=None)
+

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

Keyword Arguments
    -

  • topic –

    • -

  • publish_message –

    • +

  • message –

    • +

  • resource_type –

    • +

  • resource_name –

Parameters
-
-topic
+
+message
-
-publish_message
+
+resource_type
+
+ +
+
+resource_name
+
+ +
+ +
+
+class awsiot.greengrasscoreipc.model.ResumeComponentResponse
+

Bases: awsiot.eventstreamrpc.Shape

+
+ +
+
+class awsiot.greengrasscoreipc.model.ResumeComponentRequest(*, component_name=None)
+

Bases: awsiot.eventstreamrpc.Shape

+

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

+
+
Keyword Arguments
+

component_name –

+
+
Parameters
+

component_name (Optional[str]) –

+
+
+
+
+component_name
-exception awsiot.greengrasscoreipc.model.UnauthorizedError(*, message=None)
+exception awsiot.greengrasscoreipc.model.UnauthorizedError(*, message=None)

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

@@ -3591,7 +4353,7 @@

Navigation

message –

Parameters
-

message (Optional[str]) –

+

message (Optional[str]) –

@@ -3603,7 +4365,7 @@

Navigation

-exception awsiot.greengrasscoreipc.model.ServiceError(*, message=None)
+exception awsiot.greengrasscoreipc.model.ServiceError(*, message=None)

Bases: awsiot.greengrasscoreipc.model.GreengrassCoreIPCError

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

@@ -3611,7 +4373,7 @@

Navigation

message –

Parameters
-

message (Optional[str]) –

+

message (Optional[str]) –

@@ -3623,13 +4385,13 @@

Navigation

-class awsiot.greengrasscoreipc.model.SubscribeToIoTCoreResponse
+class awsiot.greengrasscoreipc.model.SubscribeToIoTCoreResponse

Bases: awsiot.eventstreamrpc.Shape

-class awsiot.greengrasscoreipc.model.SubscribeToIoTCoreRequest(*, topic_name=None, qos=None)
+class awsiot.greengrasscoreipc.model.SubscribeToIoTCoreRequest(*, topic_name=None, qos=None)

Bases: awsiot.eventstreamrpc.Shape

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

@@ -3641,8 +4403,8 @@

Navigation

Parameters
    -

  • topic_name (Optional[str]) –

    • -

  • qos (Optional[str]) –

    • +

  • topic_name (Optional[str]) –

    • +

  • qos (Optional[str]) –

@@ -3685,7 +4447,7 @@

This Page

Quick search

- +
@@ -3716,7 +4478,7 @@

Navigation

\ No newline at end of file diff --git a/docs/awsiot/iotidentity.html b/docs/awsiot/iotidentity.html index b412bfd3..78ad6cf6 100644 --- a/docs/awsiot/iotidentity.html +++ b/docs/awsiot/iotidentity.html @@ -54,8 +54,10 @@

Navigation

awsiot.iotidentity

-class awsiot.iotidentity.IotIdentityClient(mqtt_connection)
+class awsiot.iotidentity.IotIdentityClient(mqtt_connection)

Bases: awsiot.MqttServiceClient

+

An AWS IoT service that assists with provisioning a device and installing unique client certificates on it

+

AWS Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html

Parameters

mqtt_connection (awscrt.mqtt.Connection) –

@@ -64,12 +66,13 @@

Navigation

publish_create_certificate_from_csr(request, qos)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

+

Creates a certificate from a certificate signing request (CSR). AWS IoT provides client certificates that are signed by the Amazon Root certificate authority (CA). The new certificate has a PENDING_ACTIVATION status. When you call RegisterThing to provision a thing with this certificate, the certificate status changes to ACTIVE or INACTIVE as described in the template.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

Parameters
Returns
@@ -86,12 +89,13 @@

Navigation

publish_create_keys_and_certificate(request, qos)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

+

Creates new keys and a certificate. AWS IoT provides client certificates that are signed by the Amazon Root certificate authority (CA). The new certificate has a PENDING_ACTIVATION status. When you call RegisterThing to provision a thing with this certificate, the certificate status changes to ACTIVE or INACTIVE as described in the template.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

Parameters
Returns
@@ -108,12 +112,13 @@

Navigation

publish_register_thing(request, qos)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

+

Provisions an AWS IoT thing using a pre-defined template.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

Parameters
Returns
@@ -130,27 +135,27 @@

Navigation

subscribe_to_create_certificate_from_csr_accepted(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

+

Subscribes to the accepted topic of the CreateCertificateFromCsr operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -158,27 +163,27 @@

Navigation

subscribe_to_create_certificate_from_csr_rejected(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

+

Subscribes to the rejected topic of the CreateCertificateFromCsr operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -186,27 +191,27 @@

Navigation

subscribe_to_create_keys_and_certificate_accepted(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

+

Subscribes to the accepted topic of the CreateKeysAndCertificate operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -214,27 +219,27 @@

Navigation

subscribe_to_create_keys_and_certificate_rejected(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

+

Subscribes to the rejected topic of the CreateKeysAndCertificate operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -242,27 +247,27 @@

Navigation

subscribe_to_register_thing_accepted(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

+

Subscribes to the accepted topic of the RegisterThing operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -270,27 +275,27 @@

Navigation

subscribe_to_register_thing_rejected(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

+

Subscribes to the rejected topic of the RegisterThing operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -299,20 +304,22 @@

Navigation

-class awsiot.iotidentity.CreateCertificateFromCsrRequest(*args, **kwargs)
+class awsiot.iotidentity.CreateCertificateFromCsrRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to perform a CreateCertificateFromCsr operation.

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

Keyword Arguments
-

certificate_signing_request (str) –

+

certificate_signing_request (str) – The CSR, in PEM format.

certificate_signing_request
-
+

The CSR, in PEM format.

+
Type
-

str

+

str

@@ -321,24 +328,26 @@

Navigation

-class awsiot.iotidentity.CreateCertificateFromCsrResponse(*args, **kwargs)
+class awsiot.iotidentity.CreateCertificateFromCsrResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response payload to a CreateCertificateFromCsr request.

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

Keyword Arguments
    -

  • certificate_id (str) –

    • -

  • certificate_ownership_token (str) –

    • -

  • certificate_pem (str) –

    • +

  • certificate_id (str) – The ID of the certificate.

    • +

  • certificate_ownership_token (str) – The token to prove ownership of the certificate during provisioning.

    • +

  • certificate_pem (str) – The certificate data, in PEM format.

certificate_id
-
+

The ID of the certificate.

+
Type
-

str

+

str

@@ -346,9 +355,10 @@

Navigation

certificate_ownership_token
-
+

The token to prove ownership of the certificate during provisioning.

+
Type
-

str

+

str

@@ -356,9 +366,10 @@

Navigation

certificate_pem
-
+

The certificate data, in PEM format.

+
Type
-

str

+

str

@@ -367,39 +378,43 @@

Navigation

-class awsiot.iotidentity.CreateCertificateFromCsrSubscriptionRequest(*args, **kwargs)
+class awsiot.iotidentity.CreateCertificateFromCsrSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to the responses of the CreateCertificateFromCsr operation.

This class has no attributes.

-class awsiot.iotidentity.CreateKeysAndCertificateRequest(*args, **kwargs)
+class awsiot.iotidentity.CreateKeysAndCertificateRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to perform a CreateKeysAndCertificate operation.

This class has no attributes.

-class awsiot.iotidentity.CreateKeysAndCertificateResponse(*args, **kwargs)
+class awsiot.iotidentity.CreateKeysAndCertificateResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response payload to a CreateKeysAndCertificate request.

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

Keyword Arguments
    -

  • certificate_id (str) –

    • -

  • certificate_ownership_token (str) –

    • -

  • certificate_pem (str) –

    • -

  • private_key (str) –

    • +

  • certificate_id (str) – The certificate id.

    • +

  • certificate_ownership_token (str) – The token to prove ownership of the certificate during provisioning.

    • +

  • certificate_pem (str) – The certificate data, in PEM format.

    • +

  • private_key (str) – The private key.

certificate_id
-
+

The certificate id.

+
Type
-

str

+

str

@@ -407,9 +422,10 @@

Navigation

certificate_ownership_token
-
+

The token to prove ownership of the certificate during provisioning.

+
Type
-

str

+

str

@@ -417,9 +433,10 @@

Navigation

certificate_pem
-
+

The certificate data, in PEM format.

+
Type
-

str

+

str

@@ -427,9 +444,10 @@

Navigation

private_key
-
+

The private key.

+
Type
-

str

+

str

@@ -438,31 +456,34 @@

Navigation

-class awsiot.iotidentity.CreateKeysAndCertificateSubscriptionRequest(*args, **kwargs)
+class awsiot.iotidentity.CreateKeysAndCertificateSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to the responses of the CreateKeysAndCertificate operation.

This class has no attributes.

-class awsiot.iotidentity.ErrorResponse(*args, **kwargs)
+class awsiot.iotidentity.ErrorResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response document containing details about a failed request.

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

Keyword Arguments
    -

  • error_code (str) –

    • -

  • error_message (str) –

    • -

  • status_code (int) –

    • +

  • error_code (str) – Response error code

    • +

  • error_message (str) – Response error message

    • +

  • status_code (int) – Response status code

error_code
-
+

Response error code

+
Type
-

str

+

str

@@ -470,9 +491,10 @@

Navigation

error_message
-
+

Response error message

+
Type
-

str

+

str

@@ -480,9 +502,10 @@

Navigation

status_code
-
+

Response status code

+
Type
-

int

+

int

@@ -491,24 +514,26 @@

Navigation

-class awsiot.iotidentity.RegisterThingRequest(*args, **kwargs)
+class awsiot.iotidentity.RegisterThingRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to perform a RegisterThing operation.

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

Keyword Arguments
    -

  • certificate_ownership_token (str) –

    • -

  • parameters (typing.Dict[str, str]) –

    • -

  • template_name (str) –

    • +

  • certificate_ownership_token (str) – The token to prove ownership of the certificate. The token is generated by AWS IoT when you create a certificate over MQTT.

    • +

  • parameters (typing.Dict[str, str]) – Optional. Key-value pairs from the device that are used by the pre-provisioning hooks to evaluate the registration request.

    • +

  • template_name (str) – The provisioning template name.

certificate_ownership_token
-
+

The token to prove ownership of the certificate. The token is generated by AWS IoT when you create a certificate over MQTT.

+
Type
-

str

+

str

@@ -516,9 +541,10 @@

Navigation

parameters
-
+

Optional. Key-value pairs from the device that are used by the pre-provisioning hooks to evaluate the registration request.

+
Type
-

typing.Dict[str, str]

+

typing.Dict[str, str]

@@ -526,9 +552,10 @@

Navigation

template_name
-
+

The provisioning template name.

+
Type
-

str

+

str

@@ -537,23 +564,25 @@

Navigation

-class awsiot.iotidentity.RegisterThingResponse(*args, **kwargs)
+class awsiot.iotidentity.RegisterThingResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response payload to a RegisterThing request.

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

Keyword Arguments
    -

  • device_configuration (typing.Dict[str, str]) –

    • -

  • thing_name (str) –

    • +

  • device_configuration (typing.Dict[str, str]) – The device configuration defined in the template.

    • +

  • thing_name (str) – The name of the IoT thing created during provisioning.

device_configuration
-
+

The device configuration defined in the template.

+
Type
-

typing.Dict[str, str]

+

typing.Dict[str, str]

@@ -561,9 +590,10 @@

Navigation

thing_name
-
+

The name of the IoT thing created during provisioning.

+
Type
-

str

+

str

@@ -572,20 +602,22 @@

Navigation

-class awsiot.iotidentity.RegisterThingSubscriptionRequest(*args, **kwargs)
+class awsiot.iotidentity.RegisterThingSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to the responses of the RegisterThing operation.

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

Keyword Arguments
-

template_name (str) –

+

template_name (str) – Name of the provisioning template to listen for RegisterThing responses for.

template_name
-
+

Name of the provisioning template to listen for RegisterThing responses for.

+
Type
-

str

+

str

@@ -618,7 +650,7 @@

This Page

Quick search

- +
@@ -649,7 +681,7 @@

Navigation

\ No newline at end of file diff --git a/docs/awsiot/iotjobs.html b/docs/awsiot/iotjobs.html index 991f6af0..f7067bb1 100644 --- a/docs/awsiot/iotjobs.html +++ b/docs/awsiot/iotjobs.html @@ -54,8 +54,10 @@

Navigation

awsiot.iotjobs

-class awsiot.iotjobs.IotJobsClient(mqtt_connection)
+class awsiot.iotjobs.IotJobsClient(mqtt_connection)

Bases: 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

Parameters

mqtt_connection (awscrt.mqtt.Connection) –

@@ -64,12 +66,13 @@

Navigation

publish_describe_job_execution(request, qos)
-

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

+

Gets detailed information about a job execution.

+

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

Parameters
Returns
@@ -86,12 +89,13 @@

Navigation

publish_get_pending_job_executions(request, qos)
-

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

+

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

Parameters
Returns
@@ -108,12 +112,13 @@

Navigation

publish_start_next_pending_job_execution(request, qos)
-

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

+

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

Parameters
Returns
@@ -130,12 +135,13 @@

Navigation

publish_update_job_execution(request, qos)
-

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

+

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

Parameters
Returns
@@ -152,27 +158,27 @@

Navigation

subscribe_to_describe_job_execution_accepted(request, qos, callback)
-

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

+

Subscribes to the accepted topic for the DescribeJobExecution operation

+

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

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -180,27 +186,27 @@

Navigation

subscribe_to_describe_job_execution_rejected(request, qos, callback)
-

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

+

Subscribes to the rejected topic for the DescribeJobExecution operation

+

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

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -208,27 +214,27 @@

Navigation

subscribe_to_get_pending_job_executions_accepted(request, qos, callback)
-

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

+

Subscribes to the accepted topic for the GetPendingJobsExecutions operation

+

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

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -236,27 +242,27 @@

Navigation

subscribe_to_get_pending_job_executions_rejected(request, qos, callback)
-

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

+

Subscribes to the rejected topic for the GetPendingJobsExecutions operation

+

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

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -264,27 +270,27 @@

Navigation

subscribe_to_job_executions_changed_events(request, qos, callback)
-

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

+

Subscribes to JobExecutionsChanged notifications for a given IoT thing.

+

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

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -297,22 +303,21 @@

Navigation

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -320,27 +325,27 @@

Navigation

subscribe_to_start_next_pending_job_execution_accepted(request, qos, callback)
-

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

+

Subscribes to the accepted topic for the StartNextPendingJobExecution operation

+

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

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -348,27 +353,27 @@

Navigation

subscribe_to_start_next_pending_job_execution_rejected(request, qos, callback)
-

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

+

Subscribes to the rejected topic for the StartNextPendingJobExecution operation

+

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

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -376,27 +381,27 @@

Navigation

subscribe_to_update_job_execution_accepted(request, qos, callback)
-

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

+

Subscribes to the accepted topic for the UpdateJobExecution operation

+

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

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -404,27 +409,27 @@

Navigation

subscribe_to_update_job_execution_rejected(request, qos, callback)
-

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

+

Subscribes to the rejected topic for the UpdateJobExecution operation

+

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

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -433,26 +438,28 @@

Navigation

-class awsiot.iotjobs.DescribeJobExecutionRequest(*args, **kwargs)
+class awsiot.iotjobs.DescribeJobExecutionRequest(*args, **kwargs)

Bases: 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 Arguments
    -

  • client_token (str) –

    • -

  • execution_number (int) –

    • -

  • include_job_document (bool) –

    • -

  • job_id (str) –

    • -

  • thing_name (str) –

    • +

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

client_token
-
+

An opaque string used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

+
Type
-

str

+

str

@@ -460,9 +467,10 @@

Navigation

execution_number
-
+

Optional. A number that identifies a job execution on a device. If not specified, the latest job execution is returned.

+
Type
-

int

+

int

@@ -470,9 +478,10 @@

Navigation

include_job_document
-
+

Optional. Unless set to false, the response contains the job document. The default is true.

+
Type
-

bool

+

bool

@@ -480,9 +489,10 @@

Navigation

job_id
-
+

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.

+
Type
-

str

+

str

@@ -490,9 +500,10 @@

Navigation

thing_name
-
+

The name of the thing associated with the device.

+
Type
-

str

+

str

@@ -501,24 +512,26 @@

Navigation

-class awsiot.iotjobs.DescribeJobExecutionResponse(*args, **kwargs)
+class awsiot.iotjobs.DescribeJobExecutionResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response payload to a DescribeJobExecution request.

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

Keyword Arguments
client_token
-
+

A client token used to correlate requests and responses.

+
Type
-

str

+

str

@@ -526,7 +539,8 @@

Navigation

execution
-
+

Contains data about a job execution.

+
Type

JobExecutionData

@@ -536,9 +550,10 @@

Navigation

timestamp
-
+

The time when the message was sent.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -547,23 +562,25 @@

Navigation

-class awsiot.iotjobs.DescribeJobExecutionSubscriptionRequest(*args, **kwargs)
+class awsiot.iotjobs.DescribeJobExecutionSubscriptionRequest(*args, **kwargs)

Bases: 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 Arguments
    -

  • job_id (str) –

    • -

  • thing_name (str) –

    • +

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

job_id
-
+

Job ID that you want to subscribe to DescribeJobExecution response events for.

+
Type
-

str

+

str

@@ -571,9 +588,10 @@

Navigation

thing_name
-
+

Name of the IoT Thing that you want to subscribe to DescribeJobExecution response events for.

+
Type
-

str

+

str

@@ -582,23 +600,25 @@

Navigation

-class awsiot.iotjobs.GetPendingJobExecutionsRequest(*args, **kwargs)
+class awsiot.iotjobs.GetPendingJobExecutionsRequest(*args, **kwargs)

Bases: 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 Arguments
    -

  • client_token (str) –

    • -

  • thing_name (str) –

    • +

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

client_token
-
+

Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

+
Type
-

str

+

str

@@ -606,9 +626,10 @@

Navigation

thing_name
-
+

IoT Thing the request is relative to.

+
Type
-

str

+

str

@@ -617,25 +638,27 @@

Navigation

-class awsiot.iotjobs.GetPendingJobExecutionsResponse(*args, **kwargs)
+class awsiot.iotjobs.GetPendingJobExecutionsResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response payload to a GetPendingJobExecutions request.

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

Keyword Arguments
client_token
-
+

A client token used to correlate requests and responses.

+
Type
-

str

+

str

@@ -643,9 +666,10 @@

Navigation

in_progress_jobs
-
+

A list of JobExecutionSummary objects with status IN_PROGRESS.

+
Type
-

typing.List[JobExecutionSummary]

+

typing.List[JobExecutionSummary]

@@ -653,9 +677,10 @@

Navigation

queued_jobs
-
+

A list of JobExecutionSummary objects with status QUEUED.

+
Type
-

typing.List[JobExecutionSummary]

+

typing.List[JobExecutionSummary]

@@ -663,9 +688,10 @@

Navigation

timestamp
-
+

The time when the message was sent.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -674,20 +700,22 @@

Navigation

-class awsiot.iotjobs.GetPendingJobExecutionsSubscriptionRequest(*args, **kwargs)
+class awsiot.iotjobs.GetPendingJobExecutionsSubscriptionRequest(*args, **kwargs)

Bases: 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 Arguments
-

thing_name (str) –

+

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

thing_name
-
+

Name of the IoT Thing that you want to subscribe to GetPendingJobExecutions response events for.

+
Type
-

str

+

str

@@ -696,31 +724,33 @@

Navigation

-class awsiot.iotjobs.JobExecutionData(*args, **kwargs)
+class awsiot.iotjobs.JobExecutionData(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data about a job execution.

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

Keyword Arguments
    -

  • execution_number (int) –

    • -

  • job_document (typing.Dict[str, typing.Any]) –

    • -

  • job_id (str) –

    • -

  • last_updated_at (datetime.datetime) –

    • -

  • queued_at (datetime.datetime) –

    • -

  • started_at (datetime.datetime) –

    • -

  • status (str) –

    • -

  • status_details (typing.Dict[str, str]) –

    • -

  • thing_name (str) –

    • -

  • version_number (int) –

    • +

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

execution_number
-
+

A number that identifies a job execution on a device. It can be used later in commands that return or update job execution information.

+
Type
-

int

+

int

@@ -728,9 +758,10 @@

Navigation

job_document
-
+

The content of the job document.

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -738,9 +769,10 @@

Navigation

job_id
-
+

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

+
Type
-

str

+

str

@@ -748,9 +780,10 @@

Navigation

last_updated_at
-
+

The time when the job execution started.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -758,9 +791,10 @@

Navigation

queued_at
-
+

The time when the job execution was enqueued.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -768,9 +802,10 @@

Navigation

started_at
-
+

The time when the job execution started.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -778,9 +813,10 @@

Navigation

status
-
+

The status of the job execution. Can be one of: QUEUED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELED, TIMED_OUT, REJECTED, or REMOVED.

+
Type
-

str

+

str

@@ -788,9 +824,10 @@

Navigation

status_details
-
+

A collection of name-value pairs that describe the status of the job execution.

+
Type
-

typing.Dict[str, str]

+

typing.Dict[str, str]

@@ -798,9 +835,10 @@

Navigation

thing_name
-
+

The name of the thing that is executing the job.

+
Type
-

str

+

str

@@ -808,9 +846,10 @@

Navigation

version_number
-
+

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

+
Type
-

int

+

int

@@ -819,24 +858,26 @@

Navigation

-class awsiot.iotjobs.JobExecutionState(*args, **kwargs)
+class awsiot.iotjobs.JobExecutionState(*args, **kwargs)

Bases: 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 Arguments
    -

  • status (str) –

    • -

  • status_details (typing.Dict[str, str]) –

    • -

  • version_number (int) –

    • +

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

status
-
+

The status of the job execution. Can be one of: QUEUED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELED, TIMED_OUT, REJECTED, or REMOVED.

+
Type
-

str

+

str

@@ -844,9 +885,10 @@

Navigation

status_details
-
+

A collection of name-value pairs that describe the status of the job execution.

+
Type
-

typing.Dict[str, str]

+

typing.Dict[str, str]

@@ -854,9 +896,10 @@

Navigation

version_number
-
+

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

+
Type
-

int

+

int

@@ -865,27 +908,29 @@

Navigation

-class awsiot.iotjobs.JobExecutionSummary(*args, **kwargs)
+class awsiot.iotjobs.JobExecutionSummary(*args, **kwargs)

Bases: 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 Arguments
    -

  • execution_number (int) –

    • -

  • job_id (str) –

    • -

  • last_updated_at (datetime.datetime) –

    • -

  • queued_at (datetime.datetime) –

    • -

  • started_at (datetime.datetime) –

    • -

  • version_number (int) –

    • +

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

execution_number
-
+

A number that identifies a job execution on a device.

+
Type
-

int

+

int

@@ -893,9 +938,10 @@

Navigation

job_id
-
+

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

+
Type
-

str

+

str

@@ -903,9 +949,10 @@

Navigation

last_updated_at
-
+

The time when the job execution was last updated.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -913,9 +960,10 @@

Navigation

queued_at
-
+

The time when the job execution was enqueued.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -923,9 +971,10 @@

Navigation

started_at
-
+

The time when the job execution started.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -933,9 +982,10 @@

Navigation

version_number
-
+

The version of the job execution. Job execution versions are incremented each time the AWS IoT Jobs service receives an update from a device.

+
Type
-

int

+

int

@@ -944,23 +994,25 @@

Navigation

-class awsiot.iotjobs.JobExecutionsChangedEvent(*args, **kwargs)
+class awsiot.iotjobs.JobExecutionsChangedEvent(*args, **kwargs)

Bases: 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 Arguments
jobs
-
+

Map from JobStatus to a list of Jobs transitioning to that status.

+
Type
-

typing.Dict[str, typing.List[JobExecutionSummary]]

+

typing.Dict[str, typing.List[JobExecutionSummary]]

@@ -968,9 +1020,10 @@

Navigation

timestamp
-
+

The time when the message was sent.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -979,20 +1032,22 @@

Navigation

-class awsiot.iotjobs.JobExecutionsChangedSubscriptionRequest(*args, **kwargs)
+class awsiot.iotjobs.JobExecutionsChangedSubscriptionRequest(*args, **kwargs)

Bases: 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 Arguments
-

thing_name (str) –

+

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

thing_name
-
+

Name of the IoT Thing that you want to subscribe to JobExecutionsChanged events for.

+
Type
-

str

+

str

@@ -1001,21 +1056,23 @@

Navigation

-class awsiot.iotjobs.NextJobExecutionChangedEvent(*args, **kwargs)
+class awsiot.iotjobs.NextJobExecutionChangedEvent(*args, **kwargs)

Bases: 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 Arguments
execution
-
+

Contains data about a job execution.

+
Type

JobExecutionData

@@ -1025,9 +1082,10 @@

Navigation

timestamp
-
+

The time when the message was sent.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -1036,20 +1094,22 @@

Navigation

-class awsiot.iotjobs.NextJobExecutionChangedSubscriptionRequest(*args, **kwargs)
+class awsiot.iotjobs.NextJobExecutionChangedSubscriptionRequest(*args, **kwargs)

Bases: 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 Arguments
-

thing_name (str) –

+

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

thing_name
-
+

Name of the IoT Thing that you want to subscribe to NextJobExecutionChanged events for.

+
Type
-

str

+

str

@@ -1058,26 +1118,28 @@

Navigation

-class awsiot.iotjobs.RejectedError(*args, **kwargs)
+class awsiot.iotjobs.RejectedError(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response document containing details about a failed request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • code (str) –

    • -

  • execution_state (JobExecutionState) –

    • -

  • message (str) –

    • -

  • timestamp (datetime.datetime) –

    • +

  • client_token (str) – Opaque token that can correlate this response to the original request.

    • +

  • code (str) – Indicates the type of error.

    • +

  • execution_state (JobExecutionState) – A JobExecutionState object. This field is included only when the code field has the value InvalidStateTransition or VersionMismatch.

    • +

  • message (str) – A text message that provides additional information.

    • +

  • timestamp (datetime.datetime) – The date and time the response was generated by AWS IoT.

client_token
-
+

Opaque token that can correlate this response to the original request.

+
Type
-

str

+

str

@@ -1085,9 +1147,10 @@

Navigation

code
-
+

Indicates the type of error.

+
Type
-

str

+

str

@@ -1095,7 +1158,8 @@

Navigation

execution_state
-
+

A JobExecutionState object. This field is included only when the code field has the value InvalidStateTransition or VersionMismatch.

+
Type

JobExecutionState

@@ -1105,9 +1169,10 @@

Navigation

message
-
+

A text message that provides additional information.

+
Type
-

str

+

str

@@ -1115,9 +1180,10 @@

Navigation

timestamp
-
+

The date and time the response was generated by AWS IoT.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -1126,24 +1192,26 @@

Navigation

-class awsiot.iotjobs.StartNextJobExecutionResponse(*args, **kwargs)
+class awsiot.iotjobs.StartNextJobExecutionResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response payload to a StartNextJobExecution request.

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

Keyword Arguments
client_token
-
+

A client token used to correlate requests and responses.

+
Type
-

str

+

str

@@ -1151,7 +1219,8 @@

Navigation

execution
-
+

Contains data about a job execution.

+
Type

JobExecutionData

@@ -1161,9 +1230,10 @@

Navigation

timestamp
-
+

The time when the message was sent to the device.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -1172,25 +1242,27 @@

Navigation

-class awsiot.iotjobs.StartNextPendingJobExecutionRequest(*args, **kwargs)
+class awsiot.iotjobs.StartNextPendingJobExecutionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to make a StartNextPendingJobExecution request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • status_details (typing.Dict[str, str]) –

    • -

  • step_timeout_in_minutes (int) –

    • -

  • thing_name (str) –

    • +

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

    • +

  • status_details (typing.Dict[str, str]) – A collection of name-value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

    • +

  • step_timeout_in_minutes (int) – Specifies the amount of time this device has to finish execution of this job.

    • +

  • thing_name (str) – IoT Thing the request is relative to.

client_token
-
+

Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

+
Type
-

str

+

str

@@ -1198,9 +1270,10 @@

Navigation

status_details
-
+

A collection of name-value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

+
Type
-

typing.Dict[str, str]

+

typing.Dict[str, str]

@@ -1208,9 +1281,10 @@

Navigation

step_timeout_in_minutes
-
+

Specifies the amount of time this device has to finish execution of this job.

+
Type
-

int

+

int

@@ -1218,9 +1292,10 @@

Navigation

thing_name
-
+

IoT Thing the request is relative to.

+
Type
-

str

+

str

@@ -1229,20 +1304,22 @@

Navigation

-class awsiot.iotjobs.StartNextPendingJobExecutionSubscriptionRequest(*args, **kwargs)
+class awsiot.iotjobs.StartNextPendingJobExecutionSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to StartNextPendingJobExecution responses.

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

Keyword Arguments
-

thing_name (str) –

+

thing_name (str) – Name of the IoT Thing that you want to subscribe to StartNextPendingJobExecution response events for.

thing_name
-
+

Name of the IoT Thing that you want to subscribe to StartNextPendingJobExecution response events for.

+
Type
-

str

+

str

@@ -1251,31 +1328,33 @@

Navigation

-class awsiot.iotjobs.UpdateJobExecutionRequest(*args, **kwargs)
+class awsiot.iotjobs.UpdateJobExecutionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to make an UpdateJobExecution request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • execution_number (int) –

    • -

  • expected_version (int) –

    • -

  • include_job_document (bool) –

    • -

  • include_job_execution_state (bool) –

    • -

  • job_id (str) –

    • -

  • status (str) –

    • -

  • status_details (typing.Dict[str, str]) –

    • -

  • step_timeout_in_minutes (int) –

    • -

  • thing_name (str) –

    • +

  • client_token (str) – A client token 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 used.

    • +

  • expected_version (int) – 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 the AWS IoT Jobs service does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned.

    • +

  • include_job_document (bool) – Optional. When included and set to true, the response contains the JobDocument. The default is false.

    • +

  • include_job_execution_state (bool) – Optional. When included and set to true, the response contains the JobExecutionState field. The default is false.

    • +

  • job_id (str) – The unique identifier assigned to this job when it was created.

    • +

  • status (str) – The new status for the job execution (IN_PROGRESS, FAILED, SUCCEEDED, or REJECTED). This must be specified on every update.

    • +

  • status_details (typing.Dict[str, str]) – A collection of name-value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

    • +

  • step_timeout_in_minutes (int) – 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 is set to TIMED_OUT. Setting or resetting this timeout has no effect on the job execution timeout that might have been specified when the job was created (by using CreateJob with the timeoutConfig).

    • +

  • thing_name (str) – The name of the thing associated with the device.

client_token
-
+

A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

+
Type
-

str

+

str

@@ -1283,9 +1362,10 @@

Navigation

execution_number
-
+

Optional. A number that identifies a job execution on a device. If not specified, the latest job execution is used.

+
Type
-

int

+

int

@@ -1293,9 +1373,10 @@

Navigation

expected_version
-
+

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 the AWS IoT Jobs service does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned.

+
Type
-

int

+

int

@@ -1303,9 +1384,10 @@

Navigation

include_job_document
-
+

Optional. When included and set to true, the response contains the JobDocument. The default is false.

+
Type
-

bool

+

bool

@@ -1313,9 +1395,10 @@

Navigation

include_job_execution_state
-
+

Optional. When included and set to true, the response contains the JobExecutionState field. The default is false.

+
Type
-

bool

+

bool

@@ -1323,9 +1406,10 @@

Navigation

job_id
-
+

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

+
Type
-

str

+

str

@@ -1333,9 +1417,10 @@

Navigation

status
-
+

The new status for the job execution (IN_PROGRESS, FAILED, SUCCEEDED, or REJECTED). This must be specified on every update.

+
Type
-

str

+

str

@@ -1343,9 +1428,10 @@

Navigation

status_details
-
+

A collection of name-value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

+
Type
-

typing.Dict[str, str]

+

typing.Dict[str, str]

@@ -1353,9 +1439,10 @@

Navigation

step_timeout_in_minutes
-
+

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 is set to TIMED_OUT. Setting or resetting this timeout has no effect on the job execution timeout that might have been specified when the job was created (by using CreateJob with the timeoutConfig).

+
Type
-

int

+

int

@@ -1363,9 +1450,10 @@

Navigation

thing_name
-
+

The name of the thing associated with the device.

+
Type
-

str

+

str

@@ -1374,25 +1462,27 @@

Navigation

-class awsiot.iotjobs.UpdateJobExecutionResponse(*args, **kwargs)
+class awsiot.iotjobs.UpdateJobExecutionResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response payload to an UpdateJobExecution request.

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

Keyword Arguments
client_token
-
+

A client token used to correlate requests and responses.

+
Type
-

str

+

str

@@ -1400,7 +1490,8 @@

Navigation

execution_state
-
+

Contains data about the state of a job execution.

+
Type

JobExecutionState

@@ -1410,9 +1501,10 @@

Navigation

job_document
-
+

A UTF-8 encoded JSON document that contains information that your devices need to perform the job.

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -1420,9 +1512,10 @@

Navigation

timestamp
-
+

The time when the message was sent.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -1431,23 +1524,25 @@

Navigation

-class awsiot.iotjobs.UpdateJobExecutionSubscriptionRequest(*args, **kwargs)
+class awsiot.iotjobs.UpdateJobExecutionSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to UpdateJobExecution responses.

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

Keyword Arguments
    -

  • job_id (str) –

    • -

  • thing_name (str) –

    • +

  • job_id (str) – Job ID that you want to subscribe to UpdateJobExecution response events for.

    • +

  • thing_name (str) – Name of the IoT Thing that you want to subscribe to UpdateJobExecution response events for.

job_id
-
+

Job ID that you want to subscribe to UpdateJobExecution response events for.

+
Type
-

str

+

str

@@ -1455,15 +1550,124 @@

Navigation

thing_name
-
+

Name of the IoT Thing that you want to subscribe to UpdateJobExecution response events for.

+
Type
-

str

+

str

+
+
+class awsiot.iotjobs.JobStatus
+

Bases: object

+

The status of the job execution.

+
+
+CANCELED = 'CANCELED'
+
+ +
+
+FAILED = 'FAILED'
+
+ +
+
+QUEUED = 'QUEUED'
+
+ +
+
+IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+SUCCEEDED = 'SUCCEEDED'
+
+ +
+
+TIMED_OUT = 'TIMED_OUT'
+
+ +
+
+REJECTED = 'REJECTED'
+
+ +
+
+REMOVED = 'REMOVED'
+
+ +
+ +
+
+class awsiot.iotjobs.RejectedErrorCode
+

Bases: object

+

A value indicating the kind of error encountered while processing an AWS IoT Jobs request

+
+
+INTERNAL_ERROR = 'InternalError'
+

There was an internal error during the processing of the request.

+
+ +
+
+INVALID_JSON = 'InvalidJson'
+

The contents of the request could not be interpreted as valid UTF-8-encoded JSON.

+
+ +
+
+INVALID_REQUEST = 'InvalidRequest'
+

The contents of the request were invalid. The message contains details about the error.

+
+ +
+
+INVALID_STATE_TRANSITION = 'InvalidStateTransition'
+

An update attempted to change the job execution to a state that is invalid because of the job execution’s current state. In this case, the body of the error message also contains the executionState field.

+
+ +
+
+RESOURCE_NOT_FOUND = 'ResourceNotFound'
+

The JobExecution specified by the request topic does not exist.

+
+ +
+
+VERSION_MISMATCH = 'VersionMismatch'
+

The expected version specified in the request does not match the version of the job execution in the AWS IoT Jobs service. In this case, the body of the error message also contains the executionState field.

+
+ +
+
+INVALID_TOPIC = 'InvalidTopic'
+

The request was sent to a topic in the AWS IoT Jobs namespace that does not map to any API.

+
+ +
+
+REQUEST_THROTTLED = 'RequestThrottled'
+

The request was throttled.

+
+ +
+
+TERMINAL_STATE_REACHED = 'TerminalStateReached'
+

Occurs when a command to describe a job is performed on a job that is in a terminal state.

+
+ +
+ @@ -1490,7 +1694,7 @@

This Page

Quick search

- +
@@ -1521,7 +1725,7 @@

Navigation

\ No newline at end of file diff --git a/docs/awsiot/iotshadow.html b/docs/awsiot/iotshadow.html index c98d916e..00a27542 100644 --- a/docs/awsiot/iotshadow.html +++ b/docs/awsiot/iotshadow.html @@ -50,8 +50,10 @@

Navigation

awsiot.iotshadow

-class awsiot.iotshadow.IotShadowClient(mqtt_connection)
+class awsiot.iotshadow.IotShadowClient(mqtt_connection)

Bases: awsiot.MqttServiceClient

+

The AWS IoT Device Shadow service adds shadows to AWS IoT thing objects. Shadows are a simple data store for device properties and state. Shadows can make a device’s state available to apps and other services whether the device is connected to AWS IoT or not.

+

AWS Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html

Parameters

mqtt_connection (awscrt.mqtt.Connection) –

@@ -60,12 +62,13 @@

Navigation

publish_delete_named_shadow(request, qos)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic

+

Deletes a named shadow for an AWS IoT thing.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic

Parameters
Returns
@@ -82,12 +85,13 @@

Navigation

publish_delete_shadow(request, qos)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic

+

Deletes the (classic) shadow for an AWS IoT thing.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic

Parameters

  • request (awsiot.iotshadow.DeleteShadowRequest) – DeleteShadowRequest instance.

    • -

  • qos (int) – The Quality of Service guarantee of this message

    • +

  • qos (int) – The Quality of Service guarantee of this message

Returns
@@ -104,12 +108,13 @@

Navigation

publish_get_named_shadow(request, qos)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic

+

Gets a named shadow for an AWS IoT thing.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic

Parameters
Returns
@@ -126,12 +131,13 @@

Navigation

publish_get_shadow(request, qos)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic

+

Gets the (classic) shadow for an AWS IoT thing.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic

Parameters

  • request (awsiot.iotshadow.GetShadowRequest) – GetShadowRequest instance.

    • -

  • qos (int) – The Quality of Service guarantee of this message

    • +

  • qos (int) – The Quality of Service guarantee of this message

Returns
@@ -148,12 +154,13 @@

Navigation

publish_update_named_shadow(request, qos)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic

+

Update a named shadow for a device.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic

Parameters
Returns
@@ -170,12 +177,13 @@

Navigation

publish_update_shadow(request, qos)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic

+

Update a device’s (classic) shadow.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic

Parameters

  • request (awsiot.iotshadow.UpdateShadowRequest) – UpdateShadowRequest instance.

    • -

  • qos (int) – The Quality of Service guarantee of this message

    • +

  • qos (int) – The Quality of Service guarantee of this message

Returns
@@ -192,27 +200,27 @@

Navigation

subscribe_to_delete_named_shadow_accepted(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-accepted-pub-sub-topic

+

Subscribes to the accepted topic for the DeleteNamedShadow operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-accepted-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -220,27 +228,27 @@

Navigation

subscribe_to_delete_named_shadow_rejected(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-rejected-pub-sub-topic

+

Subscribes to the rejected topic for the DeleteNamedShadow operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-rejected-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -248,27 +256,27 @@

Navigation

subscribe_to_delete_shadow_accepted(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-accepted-pub-sub-topic

+

Subscribes to the accepted topic for the DeleteShadow operation

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-accepted-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -276,27 +284,27 @@

Navigation

subscribe_to_delete_shadow_rejected(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-rejected-pub-sub-topic

+

Subscribes to the rejected topic for the DeleteShadow operation

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-rejected-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -304,27 +312,27 @@

Navigation

subscribe_to_get_named_shadow_accepted(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-accepted-pub-sub-topic

+

Subscribes to the accepted topic for the GetNamedShadow operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-accepted-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -332,27 +340,27 @@

Navigation

subscribe_to_get_named_shadow_rejected(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-rejected-pub-sub-topic

+

Subscribes to the rejected topic for the GetNamedShadow operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-rejected-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -360,27 +368,27 @@

Navigation

subscribe_to_get_shadow_accepted(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-accepted-pub-sub-topic

+

Subscribes to the accepted topic for the GetShadow operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-accepted-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -388,27 +396,27 @@

Navigation

subscribe_to_get_shadow_rejected(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-rejected-pub-sub-topic

+

Subscribes to the rejected topic for the GetShadow operation.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-rejected-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -416,27 +424,27 @@

Navigation

subscribe_to_named_shadow_delta_updated_events(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic

+

Subscribe to NamedShadowDelta events for a named shadow of an AWS IoT thing.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -444,27 +452,27 @@

Navigation

subscribe_to_named_shadow_updated_events(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic

+

Subscribe to ShadowUpdated events for a named shadow of an AWS IoT thing.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -472,27 +480,27 @@

Navigation

subscribe_to_shadow_delta_updated_events(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic

+

Subscribe to ShadowDelta events for the (classic) shadow of an AWS IoT thing.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -500,27 +508,27 @@

Navigation

subscribe_to_shadow_updated_events(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic

+

Subscribe to ShadowUpdated events for the (classic) shadow of an AWS IoT thing.

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -528,27 +536,27 @@

Navigation

subscribe_to_update_named_shadow_accepted(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-accepted-pub-sub-topic

+

Subscribes to the accepted topic for the UpdateNamedShadow operation

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-accepted-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -556,27 +564,27 @@

Navigation

subscribe_to_update_named_shadow_rejected(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-rejected-pub-sub-topic

+

Subscribes to the rejected topic for the UpdateNamedShadow operation

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-rejected-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -584,27 +592,27 @@

Navigation

subscribe_to_update_shadow_accepted(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-accepted-pub-sub-topic

+

Subscribes to the accepted topic for the UpdateShadow operation

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-accepted-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -612,27 +620,27 @@

Navigation

subscribe_to_update_shadow_rejected(request, qos, callback)
-

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-rejected-pub-sub-topic

+

Subscribes to the rejected topic for the UpdateShadow operation

+

API Docs: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-rejected-pub-sub-topic

Parameters
Returns
-

Tuple with two values. The first is a Future -which will contain a result of None when the server has acknowledged -the subscription, 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.

+

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.

Return type
-

Tuple[concurrent.futures._base.Future, str]

+

Tuple[concurrent.futures._base.Future, str]

@@ -641,24 +649,26 @@

Navigation

-class awsiot.iotshadow.DeleteNamedShadowRequest(*args, **kwargs)
+class awsiot.iotshadow.DeleteNamedShadowRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to make a DeleteNamedShadow request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • shadow_name (str) –

    • -

  • thing_name (str) –

    • +

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

    • +

  • shadow_name (str) – Name of the shadow to delete.

    • +

  • thing_name (str) – AWS IoT thing to delete a named shadow from.

client_token
-
+

Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

+
Type
-

str

+

str

@@ -666,9 +676,10 @@

Navigation

shadow_name
-
+

Name of the shadow to delete.

+
Type
-

str

+

str

@@ -676,9 +687,10 @@

Navigation

thing_name
-
+

AWS IoT thing to delete a named shadow from.

+
Type
-

str

+

str

@@ -687,23 +699,25 @@

Navigation

-class awsiot.iotshadow.DeleteNamedShadowSubscriptionRequest(*args, **kwargs)
+class awsiot.iotshadow.DeleteNamedShadowSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to DeleteNamedShadow responses for an AWS IoT thing.

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

Keyword Arguments
    -

  • shadow_name (str) –

    • -

  • thing_name (str) –

    • +

  • shadow_name (str) – Name of the shadow to subscribe to DeleteNamedShadow operations for.

    • +

  • thing_name (str) – AWS IoT thing to subscribe to DeleteNamedShadow operations for.

shadow_name
-
+

Name of the shadow to subscribe to DeleteNamedShadow operations for.

+
Type
-

str

+

str

@@ -711,9 +725,10 @@

Navigation

thing_name
-
+

AWS IoT thing to subscribe to DeleteNamedShadow operations for.

+
Type
-

str

+

str

@@ -722,23 +737,25 @@

Navigation

-class awsiot.iotshadow.DeleteShadowRequest(*args, **kwargs)
+class awsiot.iotshadow.DeleteShadowRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to make a DeleteShadow request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • thing_name (str) –

    • +

  • 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) – AWS IoT thing to delete the (classic) shadow of.

client_token
-
+

Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

+
Type
-

str

+

str

@@ -746,9 +763,10 @@

Navigation

thing_name
-
+

AWS IoT thing to delete the (classic) shadow of.

+
Type
-

str

+

str

@@ -757,24 +775,26 @@

Navigation

-class awsiot.iotshadow.DeleteShadowResponse(*args, **kwargs)
+class awsiot.iotshadow.DeleteShadowResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response payload to a DeleteShadow request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • timestamp (datetime.datetime) –

    • -

  • version (int) –

    • +

  • client_token (str) – A client token used to correlate requests and responses.

    • +

  • timestamp (datetime.datetime) – The time the response was generated by AWS IoT.

    • +

  • version (int) – The current version of the document for the device’s shadow.

client_token
-
+

A client token used to correlate requests and responses.

+
Type
-

str

+

str

@@ -782,9 +802,10 @@

Navigation

timestamp
-
+

The time the response was generated by AWS IoT.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -792,9 +813,10 @@

Navigation

version
-
+

The current version of the document for the device’s shadow.

+
Type
-

int

+

int

@@ -803,20 +825,22 @@

Navigation

-class awsiot.iotshadow.DeleteShadowSubscriptionRequest(*args, **kwargs)
+class awsiot.iotshadow.DeleteShadowSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to DeleteShadow responses for an AWS IoT thing.

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

Keyword Arguments
-

thing_name (str) –

+

thing_name (str) – AWS IoT thing to subscribe to DeleteShadow operations for.

thing_name
-
+

AWS IoT thing to subscribe to DeleteShadow operations for.

+
Type
-

str

+

str

@@ -825,25 +849,27 @@

Navigation

-class awsiot.iotshadow.ErrorResponse(*args, **kwargs)
+class awsiot.iotshadow.ErrorResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response document containing details about a failed request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • code (int) –

    • -

  • message (str) –

    • -

  • timestamp (datetime.datetime) –

    • +

  • client_token (str) – Opaque request-response correlation data. Present only if a client token was used in the request.

    • +

  • code (int) – An HTTP response code that indicates the type of error.

    • +

  • message (str) – A text message that provides additional information.

    • +

  • timestamp (datetime.datetime) – The date and time the response was generated by AWS IoT. This property is not present in all error response documents.

client_token
-
+

Opaque request-response correlation data. Present only if a client token was used in the request.

+
Type
-

str

+

str

@@ -851,9 +877,10 @@

Navigation

code
-
+

An HTTP response code that indicates the type of error.

+
Type
-

int

+

int

@@ -861,9 +888,10 @@

Navigation

message
-
+

A text message that provides additional information.

+
Type
-

str

+

str

@@ -871,9 +899,10 @@

Navigation

timestamp
-
+

The date and time the response was generated by AWS IoT. This property is not present in all error response documents.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -882,24 +911,26 @@

Navigation

-class awsiot.iotshadow.GetNamedShadowRequest(*args, **kwargs)
+class awsiot.iotshadow.GetNamedShadowRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to make a GetNamedShadow request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • shadow_name (str) –

    • -

  • thing_name (str) –

    • +

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

    • +

  • shadow_name (str) – Name of the shadow to get.

    • +

  • thing_name (str) – AWS IoT thing to get the named shadow for.

client_token
-
+

Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

+
Type
-

str

+

str

@@ -907,9 +938,10 @@

Navigation

shadow_name
-
+

Name of the shadow to get.

+
Type
-

str

+

str

@@ -917,9 +949,10 @@

Navigation

thing_name
-
+

AWS IoT thing to get the named shadow for.

+
Type
-

str

+

str

@@ -928,23 +961,25 @@

Navigation

-class awsiot.iotshadow.GetNamedShadowSubscriptionRequest(*args, **kwargs)
+class awsiot.iotshadow.GetNamedShadowSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to GetNamedShadow responses.

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

Keyword Arguments
    -

  • shadow_name (str) –

    • -

  • thing_name (str) –

    • +

  • shadow_name (str) – Name of the shadow to subscribe to GetNamedShadow responses for.

    • +

  • thing_name (str) – AWS IoT thing subscribe to GetNamedShadow responses for.

shadow_name
-
+

Name of the shadow to subscribe to GetNamedShadow responses for.

+
Type
-

str

+

str

@@ -952,9 +987,10 @@

Navigation

thing_name
-
+

AWS IoT thing subscribe to GetNamedShadow responses for.

+
Type
-

str

+

str

@@ -963,23 +999,25 @@

Navigation

-class awsiot.iotshadow.GetShadowRequest(*args, **kwargs)
+class awsiot.iotshadow.GetShadowRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to make a GetShadow request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • thing_name (str) –

    • +

  • 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) – AWS IoT thing to get the (classic) shadow for.

client_token
-
+

Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

+
Type
-

str

+

str

@@ -987,9 +1025,10 @@

Navigation

thing_name
-
+

AWS IoT thing to get the (classic) shadow for.

+
Type
-

str

+

str

@@ -998,26 +1037,28 @@

Navigation

-class awsiot.iotshadow.GetShadowResponse(*args, **kwargs)
+class awsiot.iotshadow.GetShadowResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response payload to a GetShadow request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • metadata (ShadowMetadata) –

    • -

  • state (ShadowStateWithDelta) –

    • -

  • timestamp (datetime.datetime) –

    • -

  • version (int) –

    • +

  • client_token (str) – An opaque token used to correlate requests and responses.

    • +

  • metadata (ShadowMetadata) – Contains the timestamps for each attribute in the desired and reported sections of the state.

    • +

  • state (ShadowStateWithDelta) – The (classic) shadow state of the AWS IoT thing.

    • +

  • timestamp (datetime.datetime) – The time the response was generated by AWS IoT.

    • +

  • version (int) – The current version of the document for the device’s shadow shared in AWS IoT. It is increased by one over the previous version of the document.

client_token
-
+

An opaque token used to correlate requests and responses.

+
Type
-

str

+

str

@@ -1025,7 +1066,8 @@

Navigation

metadata
-
+

Contains the timestamps for each attribute in the desired and reported sections of the state.

+
Type

ShadowMetadata

@@ -1035,7 +1077,8 @@

Navigation

state
-
+

The (classic) shadow state of the AWS IoT thing.

+
Type

ShadowStateWithDelta

@@ -1045,9 +1088,10 @@

Navigation

timestamp
-
+

The time the response was generated by AWS IoT.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -1055,9 +1099,10 @@

Navigation

version
-
+

The current version of the document for the device’s shadow shared in AWS IoT. It is increased by one over the previous version of the document.

+
Type
-

int

+

int

@@ -1066,20 +1111,22 @@

Navigation

-class awsiot.iotshadow.GetShadowSubscriptionRequest(*args, **kwargs)
+class awsiot.iotshadow.GetShadowSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to GetShadow responses.

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

Keyword Arguments
-

thing_name (str) –

+

thing_name (str) – AWS IoT thing subscribe to GetShadow responses for.

thing_name
-
+

AWS IoT thing subscribe to GetShadow responses for.

+
Type
-

str

+

str

@@ -1088,23 +1135,25 @@

Navigation

-class awsiot.iotshadow.NamedShadowDeltaUpdatedSubscriptionRequest(*args, **kwargs)
+class awsiot.iotshadow.NamedShadowDeltaUpdatedSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to a device’s NamedShadowDelta events.

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

Keyword Arguments
    -

  • shadow_name (str) –

    • -

  • thing_name (str) –

    • +

  • shadow_name (str) – Name of the shadow to get ShadowDelta events for.

    • +

  • thing_name (str) – Name of the AWS IoT thing to get NamedShadowDelta events for.

shadow_name
-
+

Name of the shadow to get ShadowDelta events for.

+
Type
-

str

+

str

@@ -1112,9 +1161,10 @@

Navigation

thing_name
-
+

Name of the AWS IoT thing to get NamedShadowDelta events for.

+
Type
-

str

+

str

@@ -1123,23 +1173,25 @@

Navigation

-class awsiot.iotshadow.NamedShadowUpdatedSubscriptionRequest(*args, **kwargs)
+class awsiot.iotshadow.NamedShadowUpdatedSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to a device’s NamedShadowUpdated events.

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

Keyword Arguments
    -

  • shadow_name (str) –

    • -

  • thing_name (str) –

    • +

  • shadow_name (str) – Name of the shadow to get NamedShadowUpdated events for.

    • +

  • thing_name (str) – Name of the AWS IoT thing to get NamedShadowUpdated events for.

shadow_name
-
+

Name of the shadow to get NamedShadowUpdated events for.

+
Type
-

str

+

str

@@ -1147,9 +1199,10 @@

Navigation

thing_name
-
+

Name of the AWS IoT thing to get NamedShadowUpdated events for.

+
Type
-

str

+

str

@@ -1158,25 +1211,27 @@

Navigation

-class awsiot.iotshadow.ShadowDeltaUpdatedEvent(*args, **kwargs)
+class awsiot.iotshadow.ShadowDeltaUpdatedEvent(*args, **kwargs)

Bases: awsiot.ModeledClass

+

An event generated when a shadow document was updated by a request to AWS IoT. The event payload contains only the changes requested.

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

Keyword Arguments
metadata
-
+

Timestamps for the shadow properties that were updated.

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -1184,9 +1239,10 @@

Navigation

state
-
+

Shadow properties that were updated.

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -1194,9 +1250,10 @@

Navigation

timestamp
-
+

The time the event was generated by AWS IoT.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -1204,9 +1261,10 @@

Navigation

version
-
+

The current version of the document for the device’s shadow.

+
Type
-

int

+

int

@@ -1215,20 +1273,22 @@

Navigation

-class awsiot.iotshadow.ShadowDeltaUpdatedSubscriptionRequest(*args, **kwargs)
+class awsiot.iotshadow.ShadowDeltaUpdatedSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to a device’s ShadowDelta events.

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

Keyword Arguments
-

thing_name (str) –

+

thing_name (str) – Name of the AWS IoT thing to get ShadowDelta events for.

thing_name
-
+

Name of the AWS IoT thing to get ShadowDelta events for.

+
Type
-

str

+

str

@@ -1237,23 +1297,25 @@

Navigation

-class awsiot.iotshadow.ShadowMetadata(*args, **kwargs)
+class awsiot.iotshadow.ShadowMetadata(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Contains the last-updated timestamps for each attribute in the desired and reported sections of the shadow state.

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

Keyword Arguments
desired
-
+

Contains the timestamps for each attribute in the desired section of a shadow’s state.

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -1261,9 +1323,10 @@

Navigation

reported
-
+

Contains the timestamps for each attribute in the reported section of a shadow’s state.

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -1272,23 +1335,25 @@

Navigation

-class awsiot.iotshadow.ShadowState(*args, **kwargs)
+class awsiot.iotshadow.ShadowState(*args, **kwargs)

Bases: awsiot.ModeledClass

+

(Potentially partial) state of an AWS IoT thing’s shadow.

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

Keyword Arguments
desired
-
+

The desired shadow state (from external services and devices).

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -1296,9 +1361,10 @@

Navigation

reported
-
+

The (last) reported shadow state from the device.

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -1307,24 +1373,26 @@

Navigation

-class awsiot.iotshadow.ShadowStateWithDelta(*args, **kwargs)
+class awsiot.iotshadow.ShadowStateWithDelta(*args, **kwargs)

Bases: awsiot.ModeledClass

+

(Potentially partial) state of an AWS IoT thing’s shadow. Includes the delta between the reported and desired states.

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

Keyword Arguments
delta
-
+

The delta between the reported and desired states.

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -1332,9 +1400,10 @@

Navigation

desired
-
+

The desired shadow state (from external services and devices).

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -1342,9 +1411,10 @@

Navigation

reported
-
+

The (last) reported shadow state from the device.

+
Type
-

typing.Dict[str, typing.Any]

+

typing.Dict[str, typing.Any]

@@ -1353,22 +1423,24 @@

Navigation

-class awsiot.iotshadow.ShadowUpdatedEvent(*args, **kwargs)
+class awsiot.iotshadow.ShadowUpdatedEvent(*args, **kwargs)

Bases: awsiot.ModeledClass

+

A description of the before and after states of a device shadow.

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

Keyword Arguments
current
-
+

Contains the state of the object after the update.

+
Type

ShadowUpdatedSnapshot

@@ -1378,7 +1450,8 @@

Navigation

previous
-
+

Contains the state of the object before the update.

+
Type

ShadowUpdatedSnapshot

@@ -1388,9 +1461,10 @@

Navigation

timestamp
-
+

The time the event was generated by AWS IoT.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -1399,22 +1473,24 @@

Navigation

-class awsiot.iotshadow.ShadowUpdatedSnapshot(*args, **kwargs)
+class awsiot.iotshadow.ShadowUpdatedSnapshot(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Complete state of the (classic) shadow of an AWS IoT Thing.

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

Keyword Arguments
    -

  • metadata (ShadowMetadata) –

    • -

  • state (ShadowState) –

    • -

  • version (int) –

    • +

  • metadata (ShadowMetadata) – Contains the timestamps for each attribute in the desired and reported sections of the state.

    • +

  • state (ShadowState) – Current shadow state.

    • +

  • version (int) – The current version of the document for the device’s shadow.

metadata
-
+

Contains the timestamps for each attribute in the desired and reported sections of the state.

+
Type

ShadowMetadata

@@ -1424,7 +1500,8 @@

Navigation

state
-
+

Current shadow state.

+
Type

ShadowState

@@ -1434,9 +1511,10 @@

Navigation

version
-
+

The current version of the document for the device’s shadow.

+
Type
-

int

+

int

@@ -1445,20 +1523,22 @@

Navigation

-class awsiot.iotshadow.ShadowUpdatedSubscriptionRequest(*args, **kwargs)
+class awsiot.iotshadow.ShadowUpdatedSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to a device’s ShadowUpdated events.

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

Keyword Arguments
-

thing_name (str) –

+

thing_name (str) – Name of the AWS IoT thing to get ShadowUpdated events for.

thing_name
-
+

Name of the AWS IoT thing to get ShadowUpdated events for.

+
Type
-

str

+

str

@@ -1467,26 +1547,28 @@

Navigation

-class awsiot.iotshadow.UpdateNamedShadowRequest(*args, **kwargs)
+class awsiot.iotshadow.UpdateNamedShadowRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to make an UpdateNamedShadow request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • shadow_name (str) –

    • -

  • state (ShadowState) –

    • -

  • thing_name (str) –

    • -

  • version (int) –

    • +

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

    • +

  • shadow_name (str) – Name of the shadow to update.

    • +

  • state (ShadowState) – Requested changes to shadow state. Updates affect only the fields specified.

    • +

  • thing_name (str) – Aws IoT thing to update a named shadow of.

    • +

  • version (int) – (Optional) The Device Shadow service applies the update only if the specified version matches the latest version.

client_token
-
+

Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

+
Type
-

str

+

str

@@ -1494,9 +1576,10 @@

Navigation

shadow_name
-
+

Name of the shadow to update.

+
Type
-

str

+

str

@@ -1504,7 +1587,8 @@

Navigation

state
-
+

Requested changes to shadow state. Updates affect only the fields specified.

+
Type

ShadowState

@@ -1514,9 +1598,10 @@

Navigation

thing_name
-
+

Aws IoT thing to update a named shadow of.

+
Type
-

str

+

str

@@ -1524,9 +1609,10 @@

Navigation

version
-
+

(Optional) The Device Shadow service applies the update only if the specified version matches the latest version.

+
Type
-

int

+

int

@@ -1535,23 +1621,25 @@

Navigation

-class awsiot.iotshadow.UpdateNamedShadowSubscriptionRequest(*args, **kwargs)
+class awsiot.iotshadow.UpdateNamedShadowSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to UpdateNamedShadow responses.

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

Keyword Arguments
    -

  • shadow_name (str) –

    • -

  • thing_name (str) –

    • +

  • shadow_name (str) – Name of the shadow to listen to UpdateNamedShadow responses for.

    • +

  • thing_name (str) – Name of the AWS IoT thing to listen to UpdateNamedShadow responses for.

shadow_name
-
+

Name of the shadow to listen to UpdateNamedShadow responses for.

+
Type
-

str

+

str

@@ -1559,9 +1647,10 @@

Navigation

thing_name
-
+

Name of the AWS IoT thing to listen to UpdateNamedShadow responses for.

+
Type
-

str

+

str

@@ -1570,25 +1659,27 @@

Navigation

-class awsiot.iotshadow.UpdateShadowRequest(*args, **kwargs)
+class awsiot.iotshadow.UpdateShadowRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to make an UpdateShadow request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • state (ShadowState) –

    • -

  • thing_name (str) –

    • -

  • version (int) –

    • +

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

    • +

  • state (ShadowState) – Requested changes to the shadow state. Updates affect only the fields specified.

    • +

  • thing_name (str) – Aws IoT thing to update the (classic) shadow of.

    • +

  • version (int) – (Optional) The Device Shadow service processes the update only if the specified version matches the latest version.

client_token
-
+

Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

+
Type
-

str

+

str

@@ -1596,7 +1687,8 @@

Navigation

state
-
+

Requested changes to the shadow state. Updates affect only the fields specified.

+
Type

ShadowState

@@ -1606,9 +1698,10 @@

Navigation

thing_name
-
+

Aws IoT thing to update the (classic) shadow of.

+
Type
-

str

+

str

@@ -1616,9 +1709,10 @@

Navigation

version
-
+

(Optional) The Device Shadow service processes the update only if the specified version matches the latest version.

+
Type
-

int

+

int

@@ -1627,26 +1721,28 @@

Navigation

-class awsiot.iotshadow.UpdateShadowResponse(*args, **kwargs)
+class awsiot.iotshadow.UpdateShadowResponse(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Response payload to an UpdateShadow request.

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

Keyword Arguments
    -

  • client_token (str) –

    • -

  • metadata (ShadowMetadata) –

    • -

  • state (ShadowState) –

    • -

  • timestamp (datetime.datetime) –

    • -

  • version (int) –

    • +

  • client_token (str) – An opaque token used to correlate requests and responses. Present only if a client token was used in the request.

    • +

  • metadata (ShadowMetadata) – Contains the timestamps for each attribute in the desired and reported sections so that you can determine when the state was updated.

    • +

  • state (ShadowState) – Updated device shadow state.

    • +

  • timestamp (datetime.datetime) – The time the response was generated by AWS IoT.

    • +

  • version (int) – The current version of the document for the device’s shadow shared in AWS IoT. It is increased by one over the previous version of the document.

client_token
-
+

An opaque token used to correlate requests and responses. Present only if a client token was used in the request.

+
Type
-

str

+

str

@@ -1654,7 +1750,8 @@

Navigation

metadata
-
+

Contains the timestamps for each attribute in the desired and reported sections so that you can determine when the state was updated.

+
Type

ShadowMetadata

@@ -1664,7 +1761,8 @@

Navigation

state
-
+

Updated device shadow state.

+
Type

ShadowState

@@ -1674,9 +1772,10 @@

Navigation

timestamp
-
+

The time the response was generated by AWS IoT.

+
Type
-

datetime.datetime

+

datetime.datetime

@@ -1684,9 +1783,10 @@

Navigation

version
-
+

The current version of the document for the device’s shadow shared in AWS IoT. It is increased by one over the previous version of the document.

+
Type
-

int

+

int

@@ -1695,20 +1795,22 @@

Navigation

-class awsiot.iotshadow.UpdateShadowSubscriptionRequest(*args, **kwargs)
+class awsiot.iotshadow.UpdateShadowSubscriptionRequest(*args, **kwargs)

Bases: awsiot.ModeledClass

+

Data needed to subscribe to UpdateShadow responses.

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

Keyword Arguments
-

thing_name (str) –

+

thing_name (str) – Name of the AWS IoT thing to listen to UpdateShadow responses for.

thing_name
-
+

Name of the AWS IoT thing to listen to UpdateShadow responses for.

+
Type
-

str

+

str

@@ -1738,7 +1840,7 @@

This Page

Quick search

- +
@@ -1766,7 +1868,7 @@

Navigation

\ No newline at end of file diff --git a/docs/awsiot/mqtt_connection_builder.html b/docs/awsiot/mqtt_connection_builder.html index 68ad63a6..1bca7902 100644 --- a/docs/awsiot/mqtt_connection_builder.html +++ b/docs/awsiot/mqtt_connection_builder.html @@ -145,8 +145,8 @@

Navigation

Keyword Arguments
    -

  • cert_filepath (str) – Path to certificate file.

    • -

  • pri_key_filepath (str) – Path to private key file.

    • +

  • cert_filepath (str) – Path to certificate file.

    • +

  • pri_key_filepath (str) – Path to private key file.

Return type
@@ -165,8 +165,8 @@

Navigation

Keyword Arguments
    -

  • cert_bytes (bytes) – Certificate file bytes.

    • -

  • pri_key_bytes (bytes) – Private key bytes.

    • +

  • cert_bytes (bytes) – Certificate file bytes.

    • +

  • pri_key_bytes (bytes) – Private key bytes.

Return type
@@ -185,7 +185,7 @@

Navigation

Keyword Arguments
    -

  • region (str) – AWS region to use when signing.

    • +

  • region (str) – AWS region to use when signing.

  • credentials_provider (awscrt.auth.AwsCredentialsProvider) – Source of AWS credentials to use when signing.

  • websocket_proxy_options (awscrt.http.HttpProxyOptions) – Deprecated, for proxy settings use http_proxy_options (described in @@ -259,7 +259,7 @@

    This Page

    Quick search

    - +
    @@ -290,7 +290,7 @@

    Navigation

    \ No newline at end of file diff --git a/docs/genindex.html b/docs/genindex.html index 2f42472d..ecd12135 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -81,6 +81,8 @@

    A

  • (awsiot.greengrasscoreipc.client.CreateLocalDeploymentOperation method)
  • (awsiot.greengrasscoreipc.client.DeferComponentUpdateOperation method) +
    • +
  • (awsiot.greengrasscoreipc.client.DeleteThingShadowOperation method)
  • (awsiot.greengrasscoreipc.client.GetComponentDetailsOperation method)
    • @@ -89,16 +91,24 @@

    A

  • (awsiot.greengrasscoreipc.client.GetLocalDeploymentStatusOperation method)
  • (awsiot.greengrasscoreipc.client.GetSecretValueOperation method) +
    • +
  • (awsiot.greengrasscoreipc.client.GetThingShadowOperation method)
  • (awsiot.greengrasscoreipc.client.ListComponentsOperation method)
  • (awsiot.greengrasscoreipc.client.ListLocalDeploymentsOperation method) +
    • +
  • (awsiot.greengrasscoreipc.client.ListNamedShadowsForThingOperation method) +
    • +
  • (awsiot.greengrasscoreipc.client.PauseComponentOperation method)
  • (awsiot.greengrasscoreipc.client.PublishToIoTCoreOperation method)
  • (awsiot.greengrasscoreipc.client.PublishToTopicOperation method)
  • (awsiot.greengrasscoreipc.client.RestartComponentOperation method) +
    • +
  • (awsiot.greengrasscoreipc.client.ResumeComponentOperation method)
  • (awsiot.greengrasscoreipc.client.SendConfigurationValidityReportOperation method)
    • @@ -117,6 +127,8 @@

    A

  • (awsiot.greengrasscoreipc.client.UpdateConfigurationOperation method)
  • (awsiot.greengrasscoreipc.client.UpdateStateOperation method) +
    • +
  • (awsiot.greengrasscoreipc.client.UpdateThingShadowOperation method)
  • (awsiot.greengrasscoreipc.client.ValidateAuthorizationTokenOperation method)
    • @@ -217,6 +229,8 @@

    B

    C

      +
    • CANCELED (awsiot.iotjobs.JobStatus attribute) +
    • certificate_authorities (awsiot.greengrass_discovery.GGGroup attribute)
    • certificate_id (awsiot.iotidentity.CreateCertificateFromCsrResponse attribute) @@ -297,6 +311,8 @@

      C

    • (awsiot.greengrasscoreipc.client.CreateLocalDeploymentOperation method)
    • (awsiot.greengrasscoreipc.client.DeferComponentUpdateOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.DeleteThingShadowOperation method)
    • (awsiot.greengrasscoreipc.client.GetComponentDetailsOperation method)
      • @@ -305,16 +321,24 @@

      C

    • (awsiot.greengrasscoreipc.client.GetLocalDeploymentStatusOperation method)
    • (awsiot.greengrasscoreipc.client.GetSecretValueOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.GetThingShadowOperation method)
    • (awsiot.greengrasscoreipc.client.ListComponentsOperation method)
    • (awsiot.greengrasscoreipc.client.ListLocalDeploymentsOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.ListNamedShadowsForThingOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.PauseComponentOperation method)
    • (awsiot.greengrasscoreipc.client.PublishToIoTCoreOperation method)
    • (awsiot.greengrasscoreipc.client.PublishToTopicOperation method)
    • (awsiot.greengrasscoreipc.client.RestartComponentOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.ResumeComponentOperation method)
    • (awsiot.greengrasscoreipc.client.SendConfigurationValidityReportOperation method)
      • @@ -333,6 +357,8 @@

      C

    • (awsiot.greengrasscoreipc.client.UpdateConfigurationOperation method)
    • (awsiot.greengrasscoreipc.client.UpdateStateOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.UpdateThingShadowOperation method)
    • (awsiot.greengrasscoreipc.client.ValidateAuthorizationTokenOperation method)
      • @@ -357,8 +383,12 @@

      C

    • (awsiot.greengrasscoreipc.model.GetConfigurationRequest attribute)
    • (awsiot.greengrasscoreipc.model.GetConfigurationResponse attribute) +
      • +
    • (awsiot.greengrasscoreipc.model.PauseComponentRequest attribute)
    • (awsiot.greengrasscoreipc.model.RestartComponentRequest attribute) +
      • +
    • (awsiot.greengrasscoreipc.model.ResumeComponentRequest attribute)
    • (awsiot.greengrasscoreipc.model.StopComponentRequest attribute)
      • @@ -412,6 +442,8 @@

      C

    • ConnectivityInfo (class in awsiot.greengrass_discovery)
    • cores (awsiot.greengrass_discovery.GGGroup attribute) +
      • +
    • cpus (awsiot.greengrasscoreipc.model.SystemResourceLimits attribute)
    • create_static_authtoken_amender() (awsiot.eventstreamrpc.MessageAmendment static method)
      • @@ -462,6 +494,12 @@

      D

    • DeleteShadowResponse (class in awsiot.iotshadow)
    • DeleteShadowSubscriptionRequest (class in awsiot.iotshadow) +
      • +
    • DeleteThingShadowOperation (class in awsiot.greengrasscoreipc.client) +
      • +
    • DeleteThingShadowRequest (class in awsiot.greengrasscoreipc.model) +
      • +
    • DeleteThingShadowResponse (class in awsiot.greengrasscoreipc.model)
    • delta (awsiot.iotshadow.ShadowStateWithDelta attribute)
      • @@ -571,10 +609,12 @@

      E

      F

      @@ -589,6 +629,8 @@

      G

    • (awsiot.greengrasscoreipc.client.CreateLocalDeploymentOperation method)
    • (awsiot.greengrasscoreipc.client.DeferComponentUpdateOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.DeleteThingShadowOperation method)
    • (awsiot.greengrasscoreipc.client.GetComponentDetailsOperation method)
      • @@ -597,16 +639,24 @@

      G

    • (awsiot.greengrasscoreipc.client.GetLocalDeploymentStatusOperation method)
    • (awsiot.greengrasscoreipc.client.GetSecretValueOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.GetThingShadowOperation method)
    • (awsiot.greengrasscoreipc.client.ListComponentsOperation method)
    • (awsiot.greengrasscoreipc.client.ListLocalDeploymentsOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.ListNamedShadowsForThingOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.PauseComponentOperation method)
    • (awsiot.greengrasscoreipc.client.PublishToIoTCoreOperation method)
    • (awsiot.greengrasscoreipc.client.PublishToTopicOperation method)
    • (awsiot.greengrasscoreipc.client.RestartComponentOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.ResumeComponentOperation method)
    • (awsiot.greengrasscoreipc.client.SendConfigurationValidityReportOperation method)
      • @@ -625,16 +675,18 @@

      G

    • (awsiot.greengrasscoreipc.client.UpdateConfigurationOperation method)
    • (awsiot.greengrasscoreipc.client.UpdateStateOperation method) +
      • +
    • (awsiot.greengrasscoreipc.client.UpdateThingShadowOperation method)
    • (awsiot.greengrasscoreipc.client.ValidateAuthorizationTokenOperation method)
    • GetComponentDetailsOperation (class in awsiot.greengrasscoreipc.client) -
      • -
    • GetComponentDetailsRequest (class in awsiot.greengrasscoreipc.model)
        • +
      • GetComponentDetailsRequest (class in awsiot.greengrasscoreipc.model) +
      • GetComponentDetailsResponse (class in awsiot.greengrasscoreipc.model)
      • GetConfigurationOperation (class in awsiot.greengrasscoreipc.client) @@ -670,6 +722,12 @@

        G

      • GetShadowResponse (class in awsiot.iotshadow)
      • GetShadowSubscriptionRequest (class in awsiot.iotshadow) +
        • +
      • GetThingShadowOperation (class in awsiot.greengrasscoreipc.client) +
        • +
      • GetThingShadowRequest (class in awsiot.greengrasscoreipc.model) +
        • +
      • GetThingShadowResponse (class in awsiot.greengrasscoreipc.model)
      • gg_group_id (awsiot.greengrass_discovery.GGGroup attribute)
        • @@ -706,6 +764,8 @@

        I

        - + - +
      • include_job_execution_state (awsiot.iotjobs.UpdateJobExecutionRequest attribute)
        • -
      • InvalidArgumentsError +
      • INTERNAL_ERROR (awsiot.iotjobs.RejectedErrorCode attribute)
        • -
      • InvalidArtifactsDirectoryPathError +
      • INVALID_JSON (awsiot.iotjobs.RejectedErrorCode attribute) +
        • +
      • INVALID_REQUEST (awsiot.iotjobs.RejectedErrorCode attribute) +
        • +
      • INVALID_STATE_TRANSITION (awsiot.iotjobs.RejectedErrorCode attribute)
        		• -
        • ListLocalDeploymentsOperation (class in awsiot.greengrasscoreipc.client)
        • ListLocalDeploymentsRequest (class in awsiot.greengrasscoreipc.model)
        • ListLocalDeploymentsResponse (class in awsiot.greengrasscoreipc.model) +
          • +
        • ListNamedShadowsForThingOperation (class in awsiot.greengrasscoreipc.client) +
          • +
        • ListNamedShadowsForThingRequest (class in awsiot.greengrasscoreipc.model) +
          • +
        • ListNamedShadowsForThingResponse (class in awsiot.greengrasscoreipc.model)
        • local_deployments (awsiot.greengrasscoreipc.model.ListLocalDeploymentsResponse attribute)
          • @@ -843,6 +921,8 @@

          L

          M

          - +
          +
        • TERMINAL_STATE_REACHED (awsiot.iotjobs.RejectedErrorCode attribute) +
        • thing_arn (awsiot.greengrass_discovery.GGCore attribute)
          • -
        • thing_name (awsiot.iotidentity.RegisterThingResponse attribute) +
        • thing_name (awsiot.greengrasscoreipc.model.DeleteThingShadowRequest attribute)
          		• +
        • VERSION_MISMATCH (awsiot.iotjobs.RejectedErrorCode attribute) +
        • version_number (awsiot.iotjobs.JobExecutionData attribute)
            @@ -1711,7 +1879,7 @@

            W

            Quick search

            - +
            @@ -1736,7 +1904,7 @@

            Navigation

            \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index ed304ee5..a67da7ea 100644 --- a/docs/index.html +++ b/docs/index.html @@ -107,7 +107,7 @@

            This Page

            Quick search

            - +
            @@ -135,7 +135,7 @@

            Navigation

            \ No newline at end of file diff --git a/docs/objects.inv b/docs/objects.inv index 17464539..5c7fce74 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/py-modindex.html b/docs/py-modindex.html index 2276ed25..d5e48529 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -119,7 +119,7 @@

            Python Module Index

            Quick search

            - +
            @@ -144,7 +144,7 @@

            Navigation

            \ No newline at end of file diff --git a/docs/search.html b/docs/search.html index aa6f6411..a5c25d35 100644 --- a/docs/search.html +++ b/docs/search.html @@ -49,13 +49,14 @@

            Navigation

            Search

            -
            - +

            @@ -65,7 +66,7 @@

            Search

            - +
            @@ -102,7 +103,7 @@

            Navigation

            \ No newline at end of file diff --git a/docs/searchindex.js b/docs/searchindex.js index a56ff5d9..7d597d50 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["awsiot/awsiot","awsiot/eventstreamrpc","awsiot/greengrass_discovery","awsiot/greengrasscoreipc","awsiot/iotidentity","awsiot/iotjobs","awsiot/iotshadow","awsiot/mqtt_connection_builder","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["awsiot/awsiot.rst","awsiot/eventstreamrpc.rst","awsiot/greengrass_discovery.rst","awsiot/greengrasscoreipc.rst","awsiot/iotidentity.rst","awsiot/iotjobs.rst","awsiot/iotshadow.rst","awsiot/mqtt_connection_builder.rst","index.rst"],objects:{"":{awsiot:[0,0,0,"-"]},"awsiot.MqttServiceClient":{mqtt_connection:[0,2,1,""],unsubscribe:[0,3,1,""]},"awsiot.eventstreamrpc":{AccessDeniedError:[1,4,1,""],Client:[1,1,1,""],ClientOperation:[1,1,1,""],Connection:[1,1,1,""],ConnectionClosedError:[1,4,1,""],DeserializeError:[1,4,1,""],ErrorShape:[1,4,1,""],EventStreamError:[1,4,1,""],EventStreamOperationError:[1,4,1,""],LifecycleHandler:[1,1,1,""],MessageAmendment:[1,1,1,""],Operation:[1,1,1,""],SerializeError:[1,4,1,""],Shape:[1,1,1,""],ShapeIndex:[1,1,1,""],StreamClosedError:[1,4,1,""],StreamResponseHandler:[1,1,1,""],UnmappedDataError:[1,4,1,""]},"awsiot.eventstreamrpc.Connection":{close:[1,3,1,""],connect:[1,3,1,""]},"awsiot.eventstreamrpc.LifecycleHandler":{on_connect:[1,3,1,""],on_disconnect:[1,3,1,""],on_error:[1,3,1,""],on_ping:[1,3,1,""]},"awsiot.eventstreamrpc.MessageAmendment":{create_static_authtoken_amender:[1,3,1,""],headers:[1,5,1,""],payload:[1,5,1,""]},"awsiot.eventstreamrpc.ShapeIndex":{find_shape_type:[1,3,1,""]},"awsiot.greengrass_discovery":{ConnectivityInfo:[2,1,1,""],DiscoverResponse:[2,1,1,""],DiscoveryClient:[2,1,1,""],DiscoveryException:[2,4,1,""],GGCore:[2,1,1,""],GGGroup:[2,1,1,""]},"awsiot.greengrass_discovery.ConnectivityInfo":{host_address:[2,5,1,""],id:[2,5,1,""],metadata:[2,5,1,""],port:[2,5,1,""]},"awsiot.greengrass_discovery.DiscoverResponse":{gg_groups:[2,5,1,""]},"awsiot.greengrass_discovery.DiscoveryClient":{discover:[2,3,1,""]},"awsiot.greengrass_discovery.DiscoveryException":{http_response_code:[2,5,1,""],message:[2,5,1,""]},"awsiot.greengrass_discovery.GGCore":{connectivity:[2,5,1,""],thing_arn:[2,5,1,""]},"awsiot.greengrass_discovery.GGGroup":{certificate_authorities:[2,5,1,""],cores:[2,5,1,""],gg_group_id:[2,5,1,""]},"awsiot.greengrasscoreipc":{client:[3,0,0,"-"],connect:[3,6,1,""],model:[3,0,0,"-"]},"awsiot.greengrasscoreipc.client":{CreateDebugPasswordOperation:[3,1,1,""],CreateLocalDeploymentOperation:[3,1,1,""],DeferComponentUpdateOperation:[3,1,1,""],GetComponentDetailsOperation:[3,1,1,""],GetConfigurationOperation:[3,1,1,""],GetLocalDeploymentStatusOperation:[3,1,1,""],GetSecretValueOperation:[3,1,1,""],GreengrassCoreIPCClient:[3,1,1,""],ListComponentsOperation:[3,1,1,""],ListLocalDeploymentsOperation:[3,1,1,""],PublishToIoTCoreOperation:[3,1,1,""],PublishToTopicOperation:[3,1,1,""],RestartComponentOperation:[3,1,1,""],SendConfigurationValidityReportOperation:[3,1,1,""],StopComponentOperation:[3,1,1,""],SubscribeToComponentUpdatesOperation:[3,1,1,""],SubscribeToComponentUpdatesStreamHandler:[3,1,1,""],SubscribeToConfigurationUpdateOperation:[3,1,1,""],SubscribeToConfigurationUpdateStreamHandler:[3,1,1,""],SubscribeToIoTCoreOperation:[3,1,1,""],SubscribeToIoTCoreStreamHandler:[3,1,1,""],SubscribeToTopicOperation:[3,1,1,""],SubscribeToTopicStreamHandler:[3,1,1,""],SubscribeToValidateConfigurationUpdatesOperation:[3,1,1,""],SubscribeToValidateConfigurationUpdatesStreamHandler:[3,1,1,""],UpdateConfigurationOperation:[3,1,1,""],UpdateStateOperation:[3,1,1,""],ValidateAuthorizationTokenOperation:[3,1,1,""]},"awsiot.greengrasscoreipc.client.CreateDebugPasswordOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.CreateLocalDeploymentOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.DeferComponentUpdateOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.GetComponentDetailsOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.GetConfigurationOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.GetLocalDeploymentStatusOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.GetSecretValueOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.GreengrassCoreIPCClient":{new_create_debug_password:[3,3,1,""],new_create_local_deployment:[3,3,1,""],new_defer_component_update:[3,3,1,""],new_get_component_details:[3,3,1,""],new_get_configuration:[3,3,1,""],new_get_local_deployment_status:[3,3,1,""],new_get_secret_value:[3,3,1,""],new_list_components:[3,3,1,""],new_list_local_deployments:[3,3,1,""],new_publish_to_iot_core:[3,3,1,""],new_publish_to_topic:[3,3,1,""],new_restart_component:[3,3,1,""],new_send_configuration_validity_report:[3,3,1,""],new_stop_component:[3,3,1,""],new_subscribe_to_component_updates:[3,3,1,""],new_subscribe_to_configuration_update:[3,3,1,""],new_subscribe_to_iot_core:[3,3,1,""],new_subscribe_to_topic:[3,3,1,""],new_subscribe_to_validate_configuration_updates:[3,3,1,""],new_update_configuration:[3,3,1,""],new_update_state:[3,3,1,""],new_validate_authorization_token:[3,3,1,""]},"awsiot.greengrasscoreipc.client.ListComponentsOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.ListLocalDeploymentsOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.PublishToIoTCoreOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.PublishToTopicOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.RestartComponentOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SendConfigurationValidityReportOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.StopComponentOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SubscribeToComponentUpdatesOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SubscribeToComponentUpdatesStreamHandler":{on_stream_closed:[3,3,1,""],on_stream_error:[3,3,1,""],on_stream_event:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SubscribeToConfigurationUpdateOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SubscribeToConfigurationUpdateStreamHandler":{on_stream_closed:[3,3,1,""],on_stream_error:[3,3,1,""],on_stream_event:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SubscribeToIoTCoreOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SubscribeToIoTCoreStreamHandler":{on_stream_closed:[3,3,1,""],on_stream_error:[3,3,1,""],on_stream_event:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SubscribeToTopicOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SubscribeToTopicStreamHandler":{on_stream_closed:[3,3,1,""],on_stream_error:[3,3,1,""],on_stream_event:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesStreamHandler":{on_stream_closed:[3,3,1,""],on_stream_error:[3,3,1,""],on_stream_event:[3,3,1,""]},"awsiot.greengrasscoreipc.client.UpdateConfigurationOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.UpdateStateOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.client.ValidateAuthorizationTokenOperation":{activate:[3,3,1,""],close:[3,3,1,""],get_response:[3,3,1,""]},"awsiot.greengrasscoreipc.model":{BinaryMessage:[3,1,1,""],ComponentDetails:[3,1,1,""],ComponentNotFoundError:[3,4,1,""],ComponentUpdatePolicyEvents:[3,1,1,""],ConfigurationUpdateEvent:[3,1,1,""],ConfigurationUpdateEvents:[3,1,1,""],ConfigurationValidityReport:[3,1,1,""],ConfigurationValidityStatus:[3,1,1,""],ConflictError:[3,4,1,""],CreateDebugPasswordRequest:[3,1,1,""],CreateDebugPasswordResponse:[3,1,1,""],CreateLocalDeploymentRequest:[3,1,1,""],CreateLocalDeploymentResponse:[3,1,1,""],DeferComponentUpdateRequest:[3,1,1,""],DeferComponentUpdateResponse:[3,1,1,""],DeploymentStatus:[3,1,1,""],FailedUpdateConditionCheckError:[3,4,1,""],GetComponentDetailsRequest:[3,1,1,""],GetComponentDetailsResponse:[3,1,1,""],GetConfigurationRequest:[3,1,1,""],GetConfigurationResponse:[3,1,1,""],GetLocalDeploymentStatusRequest:[3,1,1,""],GetLocalDeploymentStatusResponse:[3,1,1,""],GetSecretValueRequest:[3,1,1,""],GetSecretValueResponse:[3,1,1,""],GreengrassCoreIPCError:[3,4,1,""],InvalidArgumentsError:[3,4,1,""],InvalidArtifactsDirectoryPathError:[3,4,1,""],InvalidRecipeDirectoryPathError:[3,4,1,""],InvalidTokenError:[3,4,1,""],IoTCoreMessage:[3,1,1,""],JsonMessage:[3,1,1,""],LifecycleState:[3,1,1,""],ListComponentsRequest:[3,1,1,""],ListComponentsResponse:[3,1,1,""],ListLocalDeploymentsRequest:[3,1,1,""],ListLocalDeploymentsResponse:[3,1,1,""],LocalDeployment:[3,1,1,""],MQTTMessage:[3,1,1,""],PostComponentUpdateEvent:[3,1,1,""],PreComponentUpdateEvent:[3,1,1,""],PublishMessage:[3,1,1,""],PublishToIoTCoreRequest:[3,1,1,""],PublishToIoTCoreResponse:[3,1,1,""],PublishToTopicRequest:[3,1,1,""],PublishToTopicResponse:[3,1,1,""],QOS:[3,1,1,""],ReportedLifecycleState:[3,1,1,""],RequestStatus:[3,1,1,""],ResourceNotFoundError:[3,4,1,""],RestartComponentRequest:[3,1,1,""],RestartComponentResponse:[3,1,1,""],RunWithInfo:[3,1,1,""],SecretValue:[3,1,1,""],SendConfigurationValidityReportRequest:[3,1,1,""],SendConfigurationValidityReportResponse:[3,1,1,""],ServiceError:[3,4,1,""],StopComponentRequest:[3,1,1,""],StopComponentResponse:[3,1,1,""],SubscribeToComponentUpdatesRequest:[3,1,1,""],SubscribeToComponentUpdatesResponse:[3,1,1,""],SubscribeToConfigurationUpdateRequest:[3,1,1,""],SubscribeToConfigurationUpdateResponse:[3,1,1,""],SubscribeToIoTCoreRequest:[3,1,1,""],SubscribeToIoTCoreResponse:[3,1,1,""],SubscribeToTopicRequest:[3,1,1,""],SubscribeToTopicResponse:[3,1,1,""],SubscribeToValidateConfigurationUpdatesRequest:[3,1,1,""],SubscribeToValidateConfigurationUpdatesResponse:[3,1,1,""],SubscriptionResponseMessage:[3,1,1,""],UnauthorizedError:[3,4,1,""],UpdateConfigurationRequest:[3,1,1,""],UpdateConfigurationResponse:[3,1,1,""],UpdateStateRequest:[3,1,1,""],UpdateStateResponse:[3,1,1,""],ValidateAuthorizationTokenRequest:[3,1,1,""],ValidateAuthorizationTokenResponse:[3,1,1,""],ValidateConfigurationUpdateEvent:[3,1,1,""],ValidateConfigurationUpdateEvents:[3,1,1,""]},"awsiot.greengrasscoreipc.model.BinaryMessage":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ComponentDetails":{component_name:[3,5,1,""],configuration:[3,5,1,""],state:[3,5,1,""],version:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ComponentNotFoundError":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ComponentUpdatePolicyEvents":{post_update_event:[3,5,1,""],pre_update_event:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ConfigurationUpdateEvent":{component_name:[3,5,1,""],key_path:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ConfigurationUpdateEvents":{configuration_update_event:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ConfigurationValidityReport":{deployment_id:[3,5,1,""],message:[3,5,1,""],status:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ConflictError":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.CreateDebugPasswordResponse":{certificate_sha1_hash:[3,5,1,""],certificate_sha256_hash:[3,5,1,""],password:[3,5,1,""],password_expiration:[3,5,1,""],username:[3,5,1,""]},"awsiot.greengrasscoreipc.model.CreateLocalDeploymentRequest":{artifacts_directory_path:[3,5,1,""],component_to_configuration:[3,5,1,""],component_to_run_with_info:[3,5,1,""],group_name:[3,5,1,""],recipe_directory_path:[3,5,1,""],root_component_versions_to_add:[3,5,1,""],root_components_to_remove:[3,5,1,""]},"awsiot.greengrasscoreipc.model.CreateLocalDeploymentResponse":{deployment_id:[3,5,1,""]},"awsiot.greengrasscoreipc.model.DeferComponentUpdateRequest":{deployment_id:[3,5,1,""],message:[3,5,1,""],recheck_after_ms:[3,5,1,""]},"awsiot.greengrasscoreipc.model.FailedUpdateConditionCheckError":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.GetComponentDetailsRequest":{component_name:[3,5,1,""]},"awsiot.greengrasscoreipc.model.GetComponentDetailsResponse":{component_details:[3,5,1,""]},"awsiot.greengrasscoreipc.model.GetConfigurationRequest":{component_name:[3,5,1,""],key_path:[3,5,1,""]},"awsiot.greengrasscoreipc.model.GetConfigurationResponse":{component_name:[3,5,1,""],value:[3,5,1,""]},"awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusRequest":{deployment_id:[3,5,1,""]},"awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusResponse":{deployment:[3,5,1,""]},"awsiot.greengrasscoreipc.model.GetSecretValueRequest":{secret_id:[3,5,1,""],version_id:[3,5,1,""],version_stage:[3,5,1,""]},"awsiot.greengrasscoreipc.model.GetSecretValueResponse":{secret_id:[3,5,1,""],secret_value:[3,5,1,""],version_id:[3,5,1,""],version_stage:[3,5,1,""]},"awsiot.greengrasscoreipc.model.InvalidArgumentsError":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.InvalidArtifactsDirectoryPathError":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.InvalidRecipeDirectoryPathError":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.InvalidTokenError":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.IoTCoreMessage":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.JsonMessage":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ListComponentsResponse":{components:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ListLocalDeploymentsResponse":{local_deployments:[3,5,1,""]},"awsiot.greengrasscoreipc.model.LocalDeployment":{deployment_id:[3,5,1,""],status:[3,5,1,""]},"awsiot.greengrasscoreipc.model.MQTTMessage":{payload:[3,5,1,""],topic_name:[3,5,1,""]},"awsiot.greengrasscoreipc.model.PostComponentUpdateEvent":{deployment_id:[3,5,1,""]},"awsiot.greengrasscoreipc.model.PreComponentUpdateEvent":{deployment_id:[3,5,1,""],is_ggc_restarting:[3,5,1,""]},"awsiot.greengrasscoreipc.model.PublishMessage":{binary_message:[3,5,1,""],json_message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.PublishToIoTCoreRequest":{payload:[3,5,1,""],qos:[3,5,1,""],topic_name:[3,5,1,""]},"awsiot.greengrasscoreipc.model.PublishToTopicRequest":{publish_message:[3,5,1,""],topic:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ResourceNotFoundError":{message:[3,5,1,""],resource_name:[3,5,1,""],resource_type:[3,5,1,""]},"awsiot.greengrasscoreipc.model.RestartComponentRequest":{component_name:[3,5,1,""]},"awsiot.greengrasscoreipc.model.RestartComponentResponse":{message:[3,5,1,""],restart_status:[3,5,1,""]},"awsiot.greengrasscoreipc.model.RunWithInfo":{posix_user:[3,5,1,""]},"awsiot.greengrasscoreipc.model.SecretValue":{secret_binary:[3,5,1,""],secret_string:[3,5,1,""]},"awsiot.greengrasscoreipc.model.SendConfigurationValidityReportRequest":{configuration_validity_report:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ServiceError":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.StopComponentRequest":{component_name:[3,5,1,""]},"awsiot.greengrasscoreipc.model.StopComponentResponse":{message:[3,5,1,""],stop_status:[3,5,1,""]},"awsiot.greengrasscoreipc.model.SubscribeToConfigurationUpdateRequest":{component_name:[3,5,1,""],key_path:[3,5,1,""]},"awsiot.greengrasscoreipc.model.SubscribeToIoTCoreRequest":{qos:[3,5,1,""],topic_name:[3,5,1,""]},"awsiot.greengrasscoreipc.model.SubscribeToTopicRequest":{topic:[3,5,1,""]},"awsiot.greengrasscoreipc.model.SubscribeToTopicResponse":{topic_name:[3,5,1,""]},"awsiot.greengrasscoreipc.model.SubscriptionResponseMessage":{binary_message:[3,5,1,""],json_message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.UnauthorizedError":{message:[3,5,1,""]},"awsiot.greengrasscoreipc.model.UpdateConfigurationRequest":{key_path:[3,5,1,""],timestamp:[3,5,1,""],value_to_merge:[3,5,1,""]},"awsiot.greengrasscoreipc.model.UpdateStateRequest":{state:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenRequest":{token:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenResponse":{is_valid:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvent":{configuration:[3,5,1,""],deployment_id:[3,5,1,""]},"awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvents":{validate_configuration_update_event:[3,5,1,""]},"awsiot.iotidentity":{CreateCertificateFromCsrRequest:[4,1,1,""],CreateCertificateFromCsrResponse:[4,1,1,""],CreateCertificateFromCsrSubscriptionRequest:[4,1,1,""],CreateKeysAndCertificateRequest:[4,1,1,""],CreateKeysAndCertificateResponse:[4,1,1,""],CreateKeysAndCertificateSubscriptionRequest:[4,1,1,""],ErrorResponse:[4,1,1,""],IotIdentityClient:[4,1,1,""],RegisterThingRequest:[4,1,1,""],RegisterThingResponse:[4,1,1,""],RegisterThingSubscriptionRequest:[4,1,1,""]},"awsiot.iotidentity.CreateCertificateFromCsrRequest":{certificate_signing_request:[4,5,1,""]},"awsiot.iotidentity.CreateCertificateFromCsrResponse":{certificate_id:[4,5,1,""],certificate_ownership_token:[4,5,1,""],certificate_pem:[4,5,1,""]},"awsiot.iotidentity.CreateKeysAndCertificateResponse":{certificate_id:[4,5,1,""],certificate_ownership_token:[4,5,1,""],certificate_pem:[4,5,1,""],private_key:[4,5,1,""]},"awsiot.iotidentity.ErrorResponse":{error_code:[4,5,1,""],error_message:[4,5,1,""],status_code:[4,5,1,""]},"awsiot.iotidentity.IotIdentityClient":{publish_create_certificate_from_csr:[4,3,1,""],publish_create_keys_and_certificate:[4,3,1,""],publish_register_thing:[4,3,1,""],subscribe_to_create_certificate_from_csr_accepted:[4,3,1,""],subscribe_to_create_certificate_from_csr_rejected:[4,3,1,""],subscribe_to_create_keys_and_certificate_accepted:[4,3,1,""],subscribe_to_create_keys_and_certificate_rejected:[4,3,1,""],subscribe_to_register_thing_accepted:[4,3,1,""],subscribe_to_register_thing_rejected:[4,3,1,""]},"awsiot.iotidentity.RegisterThingRequest":{certificate_ownership_token:[4,5,1,""],parameters:[4,5,1,""],template_name:[4,5,1,""]},"awsiot.iotidentity.RegisterThingResponse":{device_configuration:[4,5,1,""],thing_name:[4,5,1,""]},"awsiot.iotidentity.RegisterThingSubscriptionRequest":{template_name:[4,5,1,""]},"awsiot.iotjobs":{DescribeJobExecutionRequest:[5,1,1,""],DescribeJobExecutionResponse:[5,1,1,""],DescribeJobExecutionSubscriptionRequest:[5,1,1,""],GetPendingJobExecutionsRequest:[5,1,1,""],GetPendingJobExecutionsResponse:[5,1,1,""],GetPendingJobExecutionsSubscriptionRequest:[5,1,1,""],IotJobsClient:[5,1,1,""],JobExecutionData:[5,1,1,""],JobExecutionState:[5,1,1,""],JobExecutionSummary:[5,1,1,""],JobExecutionsChangedEvent:[5,1,1,""],JobExecutionsChangedSubscriptionRequest:[5,1,1,""],NextJobExecutionChangedEvent:[5,1,1,""],NextJobExecutionChangedSubscriptionRequest:[5,1,1,""],RejectedError:[5,1,1,""],StartNextJobExecutionResponse:[5,1,1,""],StartNextPendingJobExecutionRequest:[5,1,1,""],StartNextPendingJobExecutionSubscriptionRequest:[5,1,1,""],UpdateJobExecutionRequest:[5,1,1,""],UpdateJobExecutionResponse:[5,1,1,""],UpdateJobExecutionSubscriptionRequest:[5,1,1,""]},"awsiot.iotjobs.DescribeJobExecutionRequest":{client_token:[5,5,1,""],execution_number:[5,5,1,""],include_job_document:[5,5,1,""],job_id:[5,5,1,""],thing_name:[5,5,1,""]},"awsiot.iotjobs.DescribeJobExecutionResponse":{client_token:[5,5,1,""],execution:[5,5,1,""],timestamp:[5,5,1,""]},"awsiot.iotjobs.DescribeJobExecutionSubscriptionRequest":{job_id:[5,5,1,""],thing_name:[5,5,1,""]},"awsiot.iotjobs.GetPendingJobExecutionsRequest":{client_token:[5,5,1,""],thing_name:[5,5,1,""]},"awsiot.iotjobs.GetPendingJobExecutionsResponse":{client_token:[5,5,1,""],in_progress_jobs:[5,5,1,""],queued_jobs:[5,5,1,""],timestamp:[5,5,1,""]},"awsiot.iotjobs.GetPendingJobExecutionsSubscriptionRequest":{thing_name:[5,5,1,""]},"awsiot.iotjobs.IotJobsClient":{publish_describe_job_execution:[5,3,1,""],publish_get_pending_job_executions:[5,3,1,""],publish_start_next_pending_job_execution:[5,3,1,""],publish_update_job_execution:[5,3,1,""],subscribe_to_describe_job_execution_accepted:[5,3,1,""],subscribe_to_describe_job_execution_rejected:[5,3,1,""],subscribe_to_get_pending_job_executions_accepted:[5,3,1,""],subscribe_to_get_pending_job_executions_rejected:[5,3,1,""],subscribe_to_job_executions_changed_events:[5,3,1,""],subscribe_to_next_job_execution_changed_events:[5,3,1,""],subscribe_to_start_next_pending_job_execution_accepted:[5,3,1,""],subscribe_to_start_next_pending_job_execution_rejected:[5,3,1,""],subscribe_to_update_job_execution_accepted:[5,3,1,""],subscribe_to_update_job_execution_rejected:[5,3,1,""]},"awsiot.iotjobs.JobExecutionData":{execution_number:[5,5,1,""],job_document:[5,5,1,""],job_id:[5,5,1,""],last_updated_at:[5,5,1,""],queued_at:[5,5,1,""],started_at:[5,5,1,""],status:[5,5,1,""],status_details:[5,5,1,""],thing_name:[5,5,1,""],version_number:[5,5,1,""]},"awsiot.iotjobs.JobExecutionState":{status:[5,5,1,""],status_details:[5,5,1,""],version_number:[5,5,1,""]},"awsiot.iotjobs.JobExecutionSummary":{execution_number:[5,5,1,""],job_id:[5,5,1,""],last_updated_at:[5,5,1,""],queued_at:[5,5,1,""],started_at:[5,5,1,""],version_number:[5,5,1,""]},"awsiot.iotjobs.JobExecutionsChangedEvent":{jobs:[5,5,1,""],timestamp:[5,5,1,""]},"awsiot.iotjobs.JobExecutionsChangedSubscriptionRequest":{thing_name:[5,5,1,""]},"awsiot.iotjobs.NextJobExecutionChangedEvent":{execution:[5,5,1,""],timestamp:[5,5,1,""]},"awsiot.iotjobs.NextJobExecutionChangedSubscriptionRequest":{thing_name:[5,5,1,""]},"awsiot.iotjobs.RejectedError":{client_token:[5,5,1,""],code:[5,5,1,""],execution_state:[5,5,1,""],message:[5,5,1,""],timestamp:[5,5,1,""]},"awsiot.iotjobs.StartNextJobExecutionResponse":{client_token:[5,5,1,""],execution:[5,5,1,""],timestamp:[5,5,1,""]},"awsiot.iotjobs.StartNextPendingJobExecutionRequest":{client_token:[5,5,1,""],status_details:[5,5,1,""],step_timeout_in_minutes:[5,5,1,""],thing_name:[5,5,1,""]},"awsiot.iotjobs.StartNextPendingJobExecutionSubscriptionRequest":{thing_name:[5,5,1,""]},"awsiot.iotjobs.UpdateJobExecutionRequest":{client_token:[5,5,1,""],execution_number:[5,5,1,""],expected_version:[5,5,1,""],include_job_document:[5,5,1,""],include_job_execution_state:[5,5,1,""],job_id:[5,5,1,""],status:[5,5,1,""],status_details:[5,5,1,""],step_timeout_in_minutes:[5,5,1,""],thing_name:[5,5,1,""]},"awsiot.iotjobs.UpdateJobExecutionResponse":{client_token:[5,5,1,""],execution_state:[5,5,1,""],job_document:[5,5,1,""],timestamp:[5,5,1,""]},"awsiot.iotjobs.UpdateJobExecutionSubscriptionRequest":{job_id:[5,5,1,""],thing_name:[5,5,1,""]},"awsiot.iotshadow":{DeleteNamedShadowRequest:[6,1,1,""],DeleteNamedShadowSubscriptionRequest:[6,1,1,""],DeleteShadowRequest:[6,1,1,""],DeleteShadowResponse:[6,1,1,""],DeleteShadowSubscriptionRequest:[6,1,1,""],ErrorResponse:[6,1,1,""],GetNamedShadowRequest:[6,1,1,""],GetNamedShadowSubscriptionRequest:[6,1,1,""],GetShadowRequest:[6,1,1,""],GetShadowResponse:[6,1,1,""],GetShadowSubscriptionRequest:[6,1,1,""],IotShadowClient:[6,1,1,""],NamedShadowDeltaUpdatedSubscriptionRequest:[6,1,1,""],NamedShadowUpdatedSubscriptionRequest:[6,1,1,""],ShadowDeltaUpdatedEvent:[6,1,1,""],ShadowDeltaUpdatedSubscriptionRequest:[6,1,1,""],ShadowMetadata:[6,1,1,""],ShadowState:[6,1,1,""],ShadowStateWithDelta:[6,1,1,""],ShadowUpdatedEvent:[6,1,1,""],ShadowUpdatedSnapshot:[6,1,1,""],ShadowUpdatedSubscriptionRequest:[6,1,1,""],UpdateNamedShadowRequest:[6,1,1,""],UpdateNamedShadowSubscriptionRequest:[6,1,1,""],UpdateShadowRequest:[6,1,1,""],UpdateShadowResponse:[6,1,1,""],UpdateShadowSubscriptionRequest:[6,1,1,""]},"awsiot.iotshadow.DeleteNamedShadowRequest":{client_token:[6,5,1,""],shadow_name:[6,5,1,""],thing_name:[6,5,1,""]},"awsiot.iotshadow.DeleteNamedShadowSubscriptionRequest":{shadow_name:[6,5,1,""],thing_name:[6,5,1,""]},"awsiot.iotshadow.DeleteShadowRequest":{client_token:[6,5,1,""],thing_name:[6,5,1,""]},"awsiot.iotshadow.DeleteShadowResponse":{client_token:[6,5,1,""],timestamp:[6,5,1,""],version:[6,5,1,""]},"awsiot.iotshadow.DeleteShadowSubscriptionRequest":{thing_name:[6,5,1,""]},"awsiot.iotshadow.ErrorResponse":{client_token:[6,5,1,""],code:[6,5,1,""],message:[6,5,1,""],timestamp:[6,5,1,""]},"awsiot.iotshadow.GetNamedShadowRequest":{client_token:[6,5,1,""],shadow_name:[6,5,1,""],thing_name:[6,5,1,""]},"awsiot.iotshadow.GetNamedShadowSubscriptionRequest":{shadow_name:[6,5,1,""],thing_name:[6,5,1,""]},"awsiot.iotshadow.GetShadowRequest":{client_token:[6,5,1,""],thing_name:[6,5,1,""]},"awsiot.iotshadow.GetShadowResponse":{client_token:[6,5,1,""],metadata:[6,5,1,""],state:[6,5,1,""],timestamp:[6,5,1,""],version:[6,5,1,""]},"awsiot.iotshadow.GetShadowSubscriptionRequest":{thing_name:[6,5,1,""]},"awsiot.iotshadow.IotShadowClient":{publish_delete_named_shadow:[6,3,1,""],publish_delete_shadow:[6,3,1,""],publish_get_named_shadow:[6,3,1,""],publish_get_shadow:[6,3,1,""],publish_update_named_shadow:[6,3,1,""],publish_update_shadow:[6,3,1,""],subscribe_to_delete_named_shadow_accepted:[6,3,1,""],subscribe_to_delete_named_shadow_rejected:[6,3,1,""],subscribe_to_delete_shadow_accepted:[6,3,1,""],subscribe_to_delete_shadow_rejected:[6,3,1,""],subscribe_to_get_named_shadow_accepted:[6,3,1,""],subscribe_to_get_named_shadow_rejected:[6,3,1,""],subscribe_to_get_shadow_accepted:[6,3,1,""],subscribe_to_get_shadow_rejected:[6,3,1,""],subscribe_to_named_shadow_delta_updated_events:[6,3,1,""],subscribe_to_named_shadow_updated_events:[6,3,1,""],subscribe_to_shadow_delta_updated_events:[6,3,1,""],subscribe_to_shadow_updated_events:[6,3,1,""],subscribe_to_update_named_shadow_accepted:[6,3,1,""],subscribe_to_update_named_shadow_rejected:[6,3,1,""],subscribe_to_update_shadow_accepted:[6,3,1,""],subscribe_to_update_shadow_rejected:[6,3,1,""]},"awsiot.iotshadow.NamedShadowDeltaUpdatedSubscriptionRequest":{shadow_name:[6,5,1,""],thing_name:[6,5,1,""]},"awsiot.iotshadow.NamedShadowUpdatedSubscriptionRequest":{shadow_name:[6,5,1,""],thing_name:[6,5,1,""]},"awsiot.iotshadow.ShadowDeltaUpdatedEvent":{metadata:[6,5,1,""],state:[6,5,1,""],timestamp:[6,5,1,""],version:[6,5,1,""]},"awsiot.iotshadow.ShadowDeltaUpdatedSubscriptionRequest":{thing_name:[6,5,1,""]},"awsiot.iotshadow.ShadowMetadata":{desired:[6,5,1,""],reported:[6,5,1,""]},"awsiot.iotshadow.ShadowState":{desired:[6,5,1,""],reported:[6,5,1,""]},"awsiot.iotshadow.ShadowStateWithDelta":{delta:[6,5,1,""],desired:[6,5,1,""],reported:[6,5,1,""]},"awsiot.iotshadow.ShadowUpdatedEvent":{current:[6,5,1,""],previous:[6,5,1,""],timestamp:[6,5,1,""]},"awsiot.iotshadow.ShadowUpdatedSnapshot":{metadata:[6,5,1,""],state:[6,5,1,""],version:[6,5,1,""]},"awsiot.iotshadow.ShadowUpdatedSubscriptionRequest":{thing_name:[6,5,1,""]},"awsiot.iotshadow.UpdateNamedShadowRequest":{client_token:[6,5,1,""],shadow_name:[6,5,1,""],state:[6,5,1,""],thing_name:[6,5,1,""],version:[6,5,1,""]},"awsiot.iotshadow.UpdateNamedShadowSubscriptionRequest":{shadow_name:[6,5,1,""],thing_name:[6,5,1,""]},"awsiot.iotshadow.UpdateShadowRequest":{client_token:[6,5,1,""],state:[6,5,1,""],thing_name:[6,5,1,""],version:[6,5,1,""]},"awsiot.iotshadow.UpdateShadowResponse":{client_token:[6,5,1,""],metadata:[6,5,1,""],state:[6,5,1,""],timestamp:[6,5,1,""],version:[6,5,1,""]},"awsiot.iotshadow.UpdateShadowSubscriptionRequest":{thing_name:[6,5,1,""]},"awsiot.mqtt_connection_builder":{mtls_from_bytes:[7,6,1,""],mtls_from_path:[7,6,1,""],websockets_with_custom_handshake:[7,6,1,""],websockets_with_default_aws_signing:[7,6,1,""]},awsiot:{ModeledClass:[0,1,1,""],MqttServiceClient:[0,1,1,""],eventstreamrpc:[1,0,0,"-"],greengrass_discovery:[2,0,0,"-"],greengrasscoreipc:[3,0,0,"-"],iotidentity:[4,0,0,"-"],iotjobs:[5,0,0,"-"],iotshadow:[6,0,0,"-"],mqtt_connection_builder:[7,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","property","Python property"],"3":["py","method","Python method"],"4":["py","exception","Python exception"],"5":["py","attribute","Python attribute"],"6":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:property","3":"py:method","4":"py:exception","5":"py:attribute","6":"py:function"},terms:{"0":[1,3,7],"1":[4,5,6,7],"10":3,"1200sec":7,"20":7,"3":7,"3000m":7,"443":7,"5":7,"5000m":7,"5x":7,"8883":7,"byte":[1,3,7],"class":[0,1,2,3,4,5,6,7],"default":[1,3,4,5,6,7],"do":1,"enum":3,"float":3,"function":[1,7],"int":[1,2,3,4,5,6,7],"new":[3,7],"public":1,"return":[0,1,2,3,4,5,6,7],"static":1,"true":[1,3,7],"while":7,A:[1,4,5,6,7],For:1,If:[1,7],It:7,The:[1,3,4,5,6,7],These:1,Will:7,_base:[0,1,2,3,4,5,6],_createdebugpasswordoper:3,_createlocaldeploymentoper:3,_defercomponentupdateoper:3,_getcomponentdetailsoper:3,_getconfigurationoper:3,_getlocaldeploymentstatusoper:3,_getsecretvalueoper:3,_listcomponentsoper:3,_listlocaldeploymentsoper:3,_publishtoiotcoreoper:3,_publishtotopicoper:3,_restartcomponentoper:3,_sendconfigurationvalidityreportoper:3,_stopcomponentoper:3,_subscribetocomponentupdatesoper:3,_subscribetoconfigurationupdateoper:3,_subscribetoiotcoreoper:3,_subscribetotopicoper:3,_subscribetovalidateconfigurationupdatesoper:3,_updateconfigurationoper:3,_updatestateoper:3,_validateauthorizationtokenoper:3,accept:6,access:1,accessdeniederror:1,acknowledg:[0,4,5,6],across:[1,7],activ:3,add:1,address:2,after:[1,7],again:1,aliv:7,all:[1,3,4,5,6,7],alpn:7,alreadi:[1,7],alwai:1,amazon:[4,5,6,8],amend:1,amount:7,an:[0,1,2,3,4,5,6,7],ani:[3,5,6],anoth:1,anyth:[4,5,6],api:[1,4,5,6],appli:7,applic:1,appropri:1,ar:[1,3,4,5,6,7],arg:[1,4,5,6],argument:[3,4,5,6,7],arn:2,arriv:[1,4,5,6],artifacts_directory_path:3,assum:7,asynchron:[1,2],attempt:[1,3,7],attribut:[3,4,5,6],auth:7,authent:3,authtoken:[1,3],automat:7,avoid:1,aw:[0,2,4,5,6,7],aws_gg_nucleus_domain_socket_filepath_for_compon:3,awscredentialsprovid:7,awscrt:[0,1,2,4,5,6,7],awscrterror:7,awsiot:8,awsiotsdk:8,b:1,base:[0,1,2,3,4,5,6],been:1,befor:[1,4,5,6,7],being:[1,7],between:7,binari:1,binary_messag:3,binarymessag:3,bind:8,bool:[1,3,5,7],bootstrap:[1,2,7],build:1,builder:7,ca:7,ca_byt:7,ca_dirpath:7,ca_filepath:7,call:[1,3,7],callabl:[1,4,5,6,7],callback:[1,3,4,5,6,7],can:7,cannot:[4,5,6],catalog:1,caus:[1,7],cert:4,cert_byt:7,cert_filepath:7,certif:7,certificate_author:2,certificate_id:4,certificate_ownership_token:4,certificate_pem:4,certificate_sha1_hash:3,certificate_sha256_hash:3,certificate_signing_request:4,child:1,clean:[1,7],clean_sess:7,client:[0,1,2,3,7],client_bootstrap:7,client_id:7,client_token:[5,6],clientbootstrap:[1,2,7],clientoper:1,clienttlscontext:2,close:[1,3],code:[2,5,6,7],com:[4,5,6,8],come:1,common:7,compat:7,complet:[1,3,7],compon:3,component_detail:3,component_nam:3,component_to_configur:3,component_to_run_with_info:3,componentdetail:3,componentnotfounderror:3,componentupdatepolicyev:3,concurr:[0,1,2,3,4,5,6],configur:[3,7],configuration_update_ev:3,configuration_validity_report:3,configurationupdateev:3,configurationvalidityreport:3,configurationvaliditystatu:3,conflicterror:3,connect:[0,1,2,3,4,5,6,7],connect_message_amend:1,connectionclosederror:1,connectivityinfo:2,connectreturncod:7,constructor:[3,4,5,6],contain:[1,2,4,5,6,7],context:2,continut:1,core:[2,7],cours:[1,3],creat:[1,3,7],create_static_authtoken_amend:1,createcertificatefromcsrrequest:4,createcertificatefromcsrrespons:4,createcertificatefromcsrsubscriptionrequest:4,createdebugpasswordoper:3,createdebugpasswordrequest:3,createdebugpasswordrespons:3,createkeysandcertificaterequest:4,createkeysandcertificaterespons:4,createkeysandcertificatesubscriptionrequest:4,createlocaldeploymentoper:3,createlocaldeploymentrequest:3,createlocaldeploymentrespons:3,credenti:7,credentials_provid:7,current:6,custom:7,data:[1,3],datetim:[3,5,6],deal:1,defercomponentupdateoper:3,defercomponentupdaterequest:3,defercomponentupdaterespons:3,delet:6,deletenamedshadowrequest:6,deletenamedshadowsubscriptionrequest:6,deleteshadowrequest:6,deleteshadowrespons:6,deleteshadowsubscriptionrequest:6,delta:6,deni:1,deploy:3,deployment_id:3,deploymentstatu:3,deprec:7,describ:7,describejobexecut:5,describejobexecutionrequest:5,describejobexecutionrespons:5,describejobexecutionsubscriptionrequest:5,deseri:1,deserializeerror:1,desir:6,develop:8,developerguid:[4,5,6,8],devic:[6,7],device_configur:4,dict:[3,4,5,6,7],directori:7,disabl:7,disconnect:[1,7],discov:2,discoveri:2,discoverrespons:2,discoverycli:2,discoveryexcept:2,doc:[4,5,6,7,8],document:[1,6],doe:1,domain:3,done:[1,7],doubl:7,durat:7,dure:3,each:[1,4,5,6,7],effect:1,enable_metrics_collect:7,end:1,endpoint:7,environ:3,error:[1,2,3,7],error_cod:4,error_messag:4,errorrespons:[4,6],errorshap:[1,3],establish:[1,3,7],even:1,event:[1,3,4,5,6],eventstream:1,eventstreamerror:1,eventstreamoperationerror:1,eventstreamrpc:[3,8],except:[1,2,3,4,5,6,7],execut:5,execution_numb:5,execution_st:5,exist:7,expect:[4,5,6],expected_vers:5,explain:1,fail:[1,3,4,5,6,7],failedupdateconditioncheckerror:3,failur:[1,2],fals:[1,7],file:7,filepath:7,find_shape_typ:1,finish:1,fire:3,first:[1,4,5,6],fleet:4,follow:7,forget:7,forgotten:7,format:7,forward:7,from:[0,1,3,7],fulli:1,futur:[0,1,2,3,4,5,6],gener:0,get:[6,7],get_respons:3,getcomponentdetailsoper:3,getcomponentdetailsrequest:3,getcomponentdetailsrespons:3,getconfigurationoper:3,getconfigurationrequest:3,getconfigurationrespons:3,getlocaldeploymentstatusoper:3,getlocaldeploymentstatusrequest:3,getlocaldeploymentstatusrespons:3,getnamedshadowrequest:6,getnamedshadowsubscriptionrequest:6,getpendingjobexecut:5,getpendingjobexecutionsrequest:5,getpendingjobexecutionsrespons:5,getpendingjobexecutionssubscriptionrequest:5,getsecretvalueoper:3,getsecretvaluerequest:3,getsecretvaluerespons:3,getshadowrequest:6,getshadowrespons:6,getshadowsubscriptionrequest:6,gg_group:2,gg_group_id:2,ggcore:2,gggroup:2,github:8,given:1,greengrass:[2,3],greengrass_discoveri:8,greengrasscoreipc:8,greengrasscoreipccli:3,greengrasscoreipcerror:3,group:2,group_nam:3,guarante:[4,5,6],guid:8,ha:[0,1,3,4,5,6,7],handl:[1,3],handler:[1,3],handshak:7,happen:3,have:1,header:1,higher:7,host:[1,7],host_address:2,host_nam:1,html:[4,5,6],http:[2,4,5,6,7,8],http_proxy_opt:7,http_response_cod:2,httpproxyopt:7,id:[2,7],in_progress_job:5,include_job_docu:5,include_job_execution_st:5,index:8,info:[1,2,3,7],inform:7,inherit:[1,3],init:1,initi:[1,3],input:0,instanc:[4,5,6],interact:1,interv:7,invalid:7,invalidargumentserror:3,invalidartifactsdirectorypatherror:3,invalidrecipedirectorypatherror:3,invalidtokenerror:3,invok:[1,3,4,5,6,7],io:[1,2,7],iot:[4,5,6,7],iotcoremessag:3,iotident:8,iotidentitycli:4,iotjob:8,iotjobscli:5,iotshadow:8,iotshadowcli:6,ipc:3,ipc_socket:3,is_ggc_restart:3,is_valid:3,its:7,job:5,job_docu:5,job_id:5,jobexecutiondata:5,jobexecutionschang:5,jobexecutionschangedev:5,jobexecutionschangedsubscriptionrequest:5,jobexecutionst:5,jobexecutionsummari:5,json_messag:3,jsonmessag:3,keep:7,keep_alive_sec:7,kei:7,key_path:3,keyword:[3,4,5,6,7],known:1,kwarg:[4,5,6,7],last:1,last_updated_at:5,latest:[4,5,6,8],leak:1,level:1,life:1,lifecycle_handl:[1,3],lifecyclehandl:[1,3],lifecyclest:3,list:[2,3,5],listcomponentsoper:3,listcomponentsrequest:3,listcomponentsrespons:3,listlocaldeploymentsoper:3,listlocaldeploymentsrequest:3,listlocaldeploymentsrespons:3,load:7,local_deploy:3,localdeploy:3,longer:7,loss:7,lost:7,mai:[1,3,4,5,6,7],map:1,max:7,maximum:7,memori:7,mesag:7,messag:[0,1,2,3,4,5,6],messageamend:1,metadata:[2,6],method:[1,3],millisecond:7,min:7,minimum:7,minut:7,model:[0,1,3],model_nam:1,modeledclass:[0,2,4,5,6],modifi:7,modul:8,more:[1,3,7],mqtt:[0,4,5,6,7],mqtt_connect:[0,4,5,6],mqtt_connection_build:8,mqttmessag:3,mqttservicecli:[0,4,5,6],mtl:7,mtls_from_byt:7,mtls_from_path:7,multipl:1,must:[1,7],name:[1,7],namedshadowdeltaupdatedsubscriptionrequest:6,namedshadowupdatedsubscriptionrequest:6,nearli:1,necessarili:1,network:[1,3],new_create_debug_password:3,new_create_local_deploy:3,new_defer_component_upd:3,new_get_component_detail:3,new_get_configur:3,new_get_local_deployment_statu:3,new_get_secret_valu:3,new_list_compon:3,new_list_local_deploy:3,new_publish_to_iot_cor:3,new_publish_to_top:3,new_restart_compon:3,new_send_configuration_validity_report:3,new_stop_compon:3,new_subscribe_to_component_upd:3,new_subscribe_to_configuration_upd:3,new_subscribe_to_iot_cor:3,new_subscribe_to_top:3,new_subscribe_to_validate_configuration_upd:3,new_update_configur:3,new_update_st:3,new_validate_authorization_token:3,nextjobexecutionchang:5,nextjobexecutionchangedev:5,nextjobexecutionchangedsubscriptionrequest:5,none:[0,1,3,4,5,6,7],note:[1,4,5,6,7],noth:7,now:7,nucleu:3,number:[3,7],object:[0,1,2,3],occur:[1,3],offlin:7,omit:7,on_connect:1,on_connection_interrupt:7,on_connection_resum:7,on_disconnect:1,on_error:1,on_p:1,on_stream_clos:3,on_stream_error:3,on_stream_ev:3,one:3,onli:[1,3,7],open:1,oper:[1,2,3,7],option:[1,2,3,7],org:8,other:[3,7],otherwis:[1,7],output:0,over:[1,3,7],overrid:[1,3,7],packet:7,page:8,paramet:[0,1,2,3,4,5,6],pass:[1,4,5,6,7],password:[3,7],password_expir:3,path:[3,7],payload:[1,3],pem:7,perform:2,ping:[1,7],ping_timeout_m:7,place:7,plain:1,port:[1,2,7],posix_us:3,possibl:1,post_update_ev:3,postcomponentupdateev:3,pre_update_ev:3,precomponentupdateev:3,previou:[6,7],pri_key_byt:7,pri_key_filepath:7,privat:[1,7],private_kei:4,process:1,project:8,properli:1,properti:0,protect:1,protocol:[1,7],protocol_operation_timeout_m:7,provid:[1,7],provis:4,proxi:7,pub:6,publish:[4,5,6,7],publish_create_certificate_from_csr:4,publish_create_keys_and_certif:4,publish_delete_named_shadow:6,publish_delete_shadow:6,publish_describe_job_execut:5,publish_get_named_shadow:6,publish_get_pending_job_execut:5,publish_get_shadow:6,publish_messag:3,publish_register_th:4,publish_start_next_pending_job_execut:5,publish_update_job_execut:5,publish_update_named_shadow:6,publish_update_shadow:6,publishmessag:3,publishtoiotcoreoper:3,publishtoiotcorerequest:3,publishtoiotcorerespons:3,publishtotopicoper:3,publishtotopicrequest:3,publishtotopicrespons:3,pypi:8,qo:[3,4,5,6,7],qos1:7,qualiti:[4,5,6],queued_at:5,queued_job:5,re:[3,7],reach:7,readi:3,reason:1,receiv:[1,3,4,5,6,7],recheck_after_m:3,recipe_directory_path:3,reconnect:[1,7],reconnect_max_timeout_sec:7,reconnect_min_timeout_sec:7,region:[2,7],registerthingrequest:4,registerthingrespons:4,registerthingsubscriptionrequest:4,reject:6,rejectederror:5,rememb:7,remot:1,report:6,reportedlifecyclest:3,request:[3,4,5,6,7],requeststatu:3,requir:7,resourc:1,resource_nam:3,resource_typ:3,resourcenotfounderror:3,respons:[1,2,3,7],response_cod:2,restart_statu:3,restartcomponentoper:3,restartcomponentrequest:3,restartcomponentrespons:3,resubscribe_existing_top:7,result:[0,1,2,3,4,5,6],resum:7,return_cod:7,rewrit:1,root_component_versions_to_add:3,root_components_to_remov:3,rpc:1,runtimeerror:1,runwithinfo:3,s:[1,4,5,6],same:1,sdk:7,search:8,second:[3,4,5,6,7],secret_binari:3,secret_id:3,secret_str:3,secret_valu:3,secretvalu:3,see:[1,3,7],send:[0,1,3,7],sendconfigurationvalidityreportoper:3,sendconfigurationvalidityreportrequest:3,sendconfigurationvalidityreportrespons:3,sent:[3,7],sequenc:1,serial:1,serializeerror:1,server:[0,3,4,5,6,7],servic:[0,1,3,4,5,6],serviceerror:3,session:7,session_pres:7,set:[1,3,4,5,6,7],shadow:6,shadow_nam:6,shadowdeltaupdatedev:6,shadowdeltaupdatedsubscriptionrequest:6,shadowmetadata:6,shadowst:6,shadowstatewithdelta:6,shadowupdatedev:6,shadowupdatedsnapshot:6,shadowupdatedsubscriptionrequest:6,shape:[1,3],shape_index:[1,3],shape_typ:1,shapeindex:[1,3],shorter:7,should:[1,3,4,5,6,7],shutdown:1,sign:7,so:1,socket:[1,2,3,7],socket_opt:[1,2],socketopt:[1,2],sourc:7,start:7,started_at:5,startnextjobexecutionrespons:5,startnextpendingjobexecut:5,startnextpendingjobexecutionrequest:5,startnextpendingjobexecutionsubscriptionrequest:5,state:[3,6],statu:[3,5],status_cod:4,status_detail:5,step_timeout_in_minut:5,stop:[0,4,5,6],stop_statu:3,stopcomponentoper:3,stopcomponentrequest:3,stopcomponentrespons:3,store:7,str:[0,1,2,3,4,5,6,7],stream:[1,3],stream_handl:[1,3],streamclosederror:1,streamresponsehandl:[1,3],string:2,sub:6,subscribe_to_create_certificate_from_csr_accept:4,subscribe_to_create_certificate_from_csr_reject:4,subscribe_to_create_keys_and_certificate_accept:4,subscribe_to_create_keys_and_certificate_reject:4,subscribe_to_delete_named_shadow_accept:6,subscribe_to_delete_named_shadow_reject:6,subscribe_to_delete_shadow_accept:6,subscribe_to_delete_shadow_reject:6,subscribe_to_describe_job_execution_accept:5,subscribe_to_describe_job_execution_reject:5,subscribe_to_get_named_shadow_accept:6,subscribe_to_get_named_shadow_reject:6,subscribe_to_get_pending_job_executions_accept:5,subscribe_to_get_pending_job_executions_reject:5,subscribe_to_get_shadow_accept:6,subscribe_to_get_shadow_reject:6,subscribe_to_job_executions_changed_ev:5,subscribe_to_named_shadow_delta_updated_ev:6,subscribe_to_named_shadow_updated_ev:6,subscribe_to_next_job_execution_changed_ev:5,subscribe_to_register_thing_accept:4,subscribe_to_register_thing_reject:4,subscribe_to_shadow_delta_updated_ev:6,subscribe_to_shadow_updated_ev:6,subscribe_to_start_next_pending_job_execution_accept:5,subscribe_to_start_next_pending_job_execution_reject:5,subscribe_to_update_job_execution_accept:5,subscribe_to_update_job_execution_reject:5,subscribe_to_update_named_shadow_accept:6,subscribe_to_update_named_shadow_reject:6,subscribe_to_update_shadow_accept:6,subscribe_to_update_shadow_reject:6,subscribetocomponentupdatesoper:3,subscribetocomponentupdatesrequest:3,subscribetocomponentupdatesrespons:3,subscribetocomponentupdatesstreamhandl:3,subscribetoconfigurationupdateoper:3,subscribetoconfigurationupdaterequest:3,subscribetoconfigurationupdaterespons:3,subscribetoconfigurationupdatestreamhandl:3,subscribetoiotcoreoper:3,subscribetoiotcorerequest:3,subscribetoiotcorerespons:3,subscribetoiotcorestreamhandl:3,subscribetotopicoper:3,subscribetotopicrequest:3,subscribetotopicrespons:3,subscribetotopicstreamhandl:3,subscribetovalidateconfigurationupdatesoper:3,subscribetovalidateconfigurationupdatesrequest:3,subscribetovalidateconfigurationupdatesrespons:3,subscribetovalidateconfigurationupdatesstreamhandl:3,subscript:[4,5,6,7],subscriptionresponsemessag:3,succe:[1,3],success:[1,2],successfulli:[3,4,5,6,7],support:7,svcuid:3,system:7,tag:3,take:[4,5,6,7],tcp:7,tcp_connect_timeout_m:7,tell:0,template_nam:4,termin:1,text:1,than:7,thei:1,thi:[0,1,2,3,4,5,6,7],thing:2,thing_arn:2,thing_nam:[2,4,5,6],thread:1,time:[1,4,5,6,7],timeout:[3,7],timestamp:[3,5,6],tl:[1,2,7],tls_connection_opt:1,tls_context:2,tlsconnectionopt:1,token:3,top:7,topic:[0,3,4,5,6],topic_nam:3,transform:7,transform_arg:7,trust:7,tupl:[4,5,6],two:[4,5,6],type:[0,1,2,3,4,5,6,7],unauthorizederror:3,unexpectedli:7,union:3,uniqu:7,unix:[3,7],unless:1,unmappeddataerror:1,unsubscrib:[0,4,5,6,7],until:[3,7],updat:6,updateconfigurationoper:3,updateconfigurationrequest:3,updateconfigurationrespons:3,updatejobexecut:5,updatejobexecutionrequest:5,updatejobexecutionrespons:5,updatejobexecutionsubscriptionrequest:5,updatenamedshadowrequest:6,updatenamedshadowsubscriptionrequest:6,updateshadowrequest:6,updateshadowrespons:6,updateshadowsubscriptionrequest:6,updatestateoper:3,updatestaterequest:3,updatestaterespons:3,us:[0,1,3,7],user:1,usernam:[3,7],validate_configuration_update_ev:3,validateauthorizationtokenoper:3,validateauthorizationtokenrequest:3,validateauthorizationtokenrespons:3,validateconfigurationupdateev:3,valu:[1,3,4,5,6,7],value_to_merg:3,variabl:3,version:[3,6,7],version_id:3,version_numb:5,version_stag:3,via:[1,7],wa:[1,2,7],wait:[3,7],websocket:7,websocket_handshake_transform:7,websocket_proxy_opt:7,websockethandshaketransformarg:7,websockets_with_custom_handshak:7,websockets_with_default_aws_sign:7,well:7,were:7,when:[0,1,3,4,5,6,7],whenev:[1,7],whether:[3,7],which:[1,2,3,4,5,6,7],whose:[0,4,5,6],wire:[1,3],within:7,wo:4,written:[3,7],you:3,zero:7},titles:["awsiot","awsiot.eventstreamrpc","awsiot.greengrass_discovery","awsiot.greengrasscoreipc","awsiot.iotidentity","awsiot.iotjobs","awsiot.iotshadow","awsiot.mqtt_connection_builder","AWS IoT Device SDK v2 for Python"],titleterms:{api:8,aw:8,awsiot:[0,1,2,3,4,5,6,7],devic:8,eventstreamrpc:1,greengrass_discoveri:2,greengrasscoreipc:3,indic:8,iot:8,iotident:4,iotjob:5,iotshadow:6,mqtt_connection_build:7,python:8,refer:8,sdk:8,tabl:8,v2:8}}) \ No newline at end of file +Search.setIndex({docnames:["awsiot/awsiot","awsiot/eventstreamrpc","awsiot/greengrass_discovery","awsiot/greengrasscoreipc","awsiot/iotidentity","awsiot/iotjobs","awsiot/iotshadow","awsiot/mqtt_connection_builder","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["awsiot/awsiot.rst","awsiot/eventstreamrpc.rst","awsiot/greengrass_discovery.rst","awsiot/greengrasscoreipc.rst","awsiot/iotidentity.rst","awsiot/iotjobs.rst","awsiot/iotshadow.rst","awsiot/mqtt_connection_builder.rst","index.rst"],objects:{"":[[0,0,0,"-","awsiot"]],"awsiot.MqttServiceClient":[[0,2,1,"","mqtt_connection"],[0,3,1,"","unsubscribe"]],"awsiot.eventstreamrpc":[[1,4,1,"","AccessDeniedError"],[1,1,1,"","Client"],[1,1,1,"","ClientOperation"],[1,1,1,"","Connection"],[1,4,1,"","ConnectionClosedError"],[1,4,1,"","DeserializeError"],[1,4,1,"","ErrorShape"],[1,4,1,"","EventStreamError"],[1,4,1,"","EventStreamOperationError"],[1,1,1,"","LifecycleHandler"],[1,1,1,"","MessageAmendment"],[1,1,1,"","Operation"],[1,4,1,"","SerializeError"],[1,1,1,"","Shape"],[1,1,1,"","ShapeIndex"],[1,4,1,"","StreamClosedError"],[1,1,1,"","StreamResponseHandler"],[1,4,1,"","UnmappedDataError"]],"awsiot.eventstreamrpc.Connection":[[1,3,1,"","close"],[1,3,1,"","connect"]],"awsiot.eventstreamrpc.LifecycleHandler":[[1,3,1,"","on_connect"],[1,3,1,"","on_disconnect"],[1,3,1,"","on_error"],[1,3,1,"","on_ping"]],"awsiot.eventstreamrpc.MessageAmendment":[[1,3,1,"","create_static_authtoken_amender"],[1,5,1,"","headers"],[1,5,1,"","payload"]],"awsiot.eventstreamrpc.ShapeIndex":[[1,3,1,"","find_shape_type"]],"awsiot.greengrass_discovery":[[2,1,1,"","ConnectivityInfo"],[2,1,1,"","DiscoverResponse"],[2,1,1,"","DiscoveryClient"],[2,4,1,"","DiscoveryException"],[2,1,1,"","GGCore"],[2,1,1,"","GGGroup"]],"awsiot.greengrass_discovery.ConnectivityInfo":[[2,5,1,"","host_address"],[2,5,1,"","id"],[2,5,1,"","metadata"],[2,5,1,"","port"]],"awsiot.greengrass_discovery.DiscoverResponse":[[2,5,1,"","gg_groups"]],"awsiot.greengrass_discovery.DiscoveryClient":[[2,3,1,"","discover"]],"awsiot.greengrass_discovery.DiscoveryException":[[2,5,1,"","http_response_code"],[2,5,1,"","message"]],"awsiot.greengrass_discovery.GGCore":[[2,5,1,"","connectivity"],[2,5,1,"","thing_arn"]],"awsiot.greengrass_discovery.GGGroup":[[2,5,1,"","certificate_authorities"],[2,5,1,"","cores"],[2,5,1,"","gg_group_id"]],"awsiot.greengrasscoreipc":[[3,0,0,"-","client"],[3,6,1,"","connect"],[3,0,0,"-","model"]],"awsiot.greengrasscoreipc.client":[[3,1,1,"","CreateDebugPasswordOperation"],[3,1,1,"","CreateLocalDeploymentOperation"],[3,1,1,"","DeferComponentUpdateOperation"],[3,1,1,"","DeleteThingShadowOperation"],[3,1,1,"","GetComponentDetailsOperation"],[3,1,1,"","GetConfigurationOperation"],[3,1,1,"","GetLocalDeploymentStatusOperation"],[3,1,1,"","GetSecretValueOperation"],[3,1,1,"","GetThingShadowOperation"],[3,1,1,"","GreengrassCoreIPCClient"],[3,1,1,"","ListComponentsOperation"],[3,1,1,"","ListLocalDeploymentsOperation"],[3,1,1,"","ListNamedShadowsForThingOperation"],[3,1,1,"","PauseComponentOperation"],[3,1,1,"","PublishToIoTCoreOperation"],[3,1,1,"","PublishToTopicOperation"],[3,1,1,"","RestartComponentOperation"],[3,1,1,"","ResumeComponentOperation"],[3,1,1,"","SendConfigurationValidityReportOperation"],[3,1,1,"","StopComponentOperation"],[3,1,1,"","SubscribeToComponentUpdatesOperation"],[3,1,1,"","SubscribeToComponentUpdatesStreamHandler"],[3,1,1,"","SubscribeToConfigurationUpdateOperation"],[3,1,1,"","SubscribeToConfigurationUpdateStreamHandler"],[3,1,1,"","SubscribeToIoTCoreOperation"],[3,1,1,"","SubscribeToIoTCoreStreamHandler"],[3,1,1,"","SubscribeToTopicOperation"],[3,1,1,"","SubscribeToTopicStreamHandler"],[3,1,1,"","SubscribeToValidateConfigurationUpdatesOperation"],[3,1,1,"","SubscribeToValidateConfigurationUpdatesStreamHandler"],[3,1,1,"","UpdateConfigurationOperation"],[3,1,1,"","UpdateStateOperation"],[3,1,1,"","UpdateThingShadowOperation"],[3,1,1,"","ValidateAuthorizationTokenOperation"]],"awsiot.greengrasscoreipc.client.CreateDebugPasswordOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.CreateLocalDeploymentOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.DeferComponentUpdateOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.DeleteThingShadowOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.GetComponentDetailsOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.GetConfigurationOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.GetLocalDeploymentStatusOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.GetSecretValueOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.GetThingShadowOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.GreengrassCoreIPCClient":[[3,3,1,"","new_create_debug_password"],[3,3,1,"","new_create_local_deployment"],[3,3,1,"","new_defer_component_update"],[3,3,1,"","new_delete_thing_shadow"],[3,3,1,"","new_get_component_details"],[3,3,1,"","new_get_configuration"],[3,3,1,"","new_get_local_deployment_status"],[3,3,1,"","new_get_secret_value"],[3,3,1,"","new_get_thing_shadow"],[3,3,1,"","new_list_components"],[3,3,1,"","new_list_local_deployments"],[3,3,1,"","new_list_named_shadows_for_thing"],[3,3,1,"","new_pause_component"],[3,3,1,"","new_publish_to_iot_core"],[3,3,1,"","new_publish_to_topic"],[3,3,1,"","new_restart_component"],[3,3,1,"","new_resume_component"],[3,3,1,"","new_send_configuration_validity_report"],[3,3,1,"","new_stop_component"],[3,3,1,"","new_subscribe_to_component_updates"],[3,3,1,"","new_subscribe_to_configuration_update"],[3,3,1,"","new_subscribe_to_iot_core"],[3,3,1,"","new_subscribe_to_topic"],[3,3,1,"","new_subscribe_to_validate_configuration_updates"],[3,3,1,"","new_update_configuration"],[3,3,1,"","new_update_state"],[3,3,1,"","new_update_thing_shadow"],[3,3,1,"","new_validate_authorization_token"]],"awsiot.greengrasscoreipc.client.ListComponentsOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.ListLocalDeploymentsOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.ListNamedShadowsForThingOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.PauseComponentOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.PublishToIoTCoreOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.PublishToTopicOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.RestartComponentOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.ResumeComponentOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.SendConfigurationValidityReportOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.StopComponentOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.SubscribeToComponentUpdatesOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.SubscribeToComponentUpdatesStreamHandler":[[3,3,1,"","on_stream_closed"],[3,3,1,"","on_stream_error"],[3,3,1,"","on_stream_event"]],"awsiot.greengrasscoreipc.client.SubscribeToConfigurationUpdateOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.SubscribeToConfigurationUpdateStreamHandler":[[3,3,1,"","on_stream_closed"],[3,3,1,"","on_stream_error"],[3,3,1,"","on_stream_event"]],"awsiot.greengrasscoreipc.client.SubscribeToIoTCoreOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.SubscribeToIoTCoreStreamHandler":[[3,3,1,"","on_stream_closed"],[3,3,1,"","on_stream_error"],[3,3,1,"","on_stream_event"]],"awsiot.greengrasscoreipc.client.SubscribeToTopicOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.SubscribeToTopicStreamHandler":[[3,3,1,"","on_stream_closed"],[3,3,1,"","on_stream_error"],[3,3,1,"","on_stream_event"]],"awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesStreamHandler":[[3,3,1,"","on_stream_closed"],[3,3,1,"","on_stream_error"],[3,3,1,"","on_stream_event"]],"awsiot.greengrasscoreipc.client.UpdateConfigurationOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.UpdateStateOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.UpdateThingShadowOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.client.ValidateAuthorizationTokenOperation":[[3,3,1,"","activate"],[3,3,1,"","close"],[3,3,1,"","get_response"]],"awsiot.greengrasscoreipc.model":[[3,1,1,"","BinaryMessage"],[3,1,1,"","ComponentDetails"],[3,4,1,"","ComponentNotFoundError"],[3,1,1,"","ComponentUpdatePolicyEvents"],[3,1,1,"","ConfigurationUpdateEvent"],[3,1,1,"","ConfigurationUpdateEvents"],[3,1,1,"","ConfigurationValidityReport"],[3,1,1,"","ConfigurationValidityStatus"],[3,4,1,"","ConflictError"],[3,1,1,"","CreateDebugPasswordRequest"],[3,1,1,"","CreateDebugPasswordResponse"],[3,1,1,"","CreateLocalDeploymentRequest"],[3,1,1,"","CreateLocalDeploymentResponse"],[3,1,1,"","DeferComponentUpdateRequest"],[3,1,1,"","DeferComponentUpdateResponse"],[3,1,1,"","DeleteThingShadowRequest"],[3,1,1,"","DeleteThingShadowResponse"],[3,1,1,"","DeploymentStatus"],[3,4,1,"","FailedUpdateConditionCheckError"],[3,1,1,"","GetComponentDetailsRequest"],[3,1,1,"","GetComponentDetailsResponse"],[3,1,1,"","GetConfigurationRequest"],[3,1,1,"","GetConfigurationResponse"],[3,1,1,"","GetLocalDeploymentStatusRequest"],[3,1,1,"","GetLocalDeploymentStatusResponse"],[3,1,1,"","GetSecretValueRequest"],[3,1,1,"","GetSecretValueResponse"],[3,1,1,"","GetThingShadowRequest"],[3,1,1,"","GetThingShadowResponse"],[3,4,1,"","GreengrassCoreIPCError"],[3,4,1,"","InvalidArgumentsError"],[3,4,1,"","InvalidArtifactsDirectoryPathError"],[3,4,1,"","InvalidRecipeDirectoryPathError"],[3,4,1,"","InvalidTokenError"],[3,1,1,"","IoTCoreMessage"],[3,1,1,"","JsonMessage"],[3,1,1,"","LifecycleState"],[3,1,1,"","ListComponentsRequest"],[3,1,1,"","ListComponentsResponse"],[3,1,1,"","ListLocalDeploymentsRequest"],[3,1,1,"","ListLocalDeploymentsResponse"],[3,1,1,"","ListNamedShadowsForThingRequest"],[3,1,1,"","ListNamedShadowsForThingResponse"],[3,1,1,"","LocalDeployment"],[3,1,1,"","MQTTMessage"],[3,1,1,"","PauseComponentRequest"],[3,1,1,"","PauseComponentResponse"],[3,1,1,"","PostComponentUpdateEvent"],[3,1,1,"","PreComponentUpdateEvent"],[3,1,1,"","PublishMessage"],[3,1,1,"","PublishToIoTCoreRequest"],[3,1,1,"","PublishToIoTCoreResponse"],[3,1,1,"","PublishToTopicRequest"],[3,1,1,"","PublishToTopicResponse"],[3,1,1,"","QOS"],[3,1,1,"","ReportedLifecycleState"],[3,1,1,"","RequestStatus"],[3,4,1,"","ResourceNotFoundError"],[3,1,1,"","RestartComponentRequest"],[3,1,1,"","RestartComponentResponse"],[3,1,1,"","ResumeComponentRequest"],[3,1,1,"","ResumeComponentResponse"],[3,1,1,"","RunWithInfo"],[3,1,1,"","SecretValue"],[3,1,1,"","SendConfigurationValidityReportRequest"],[3,1,1,"","SendConfigurationValidityReportResponse"],[3,4,1,"","ServiceError"],[3,1,1,"","StopComponentRequest"],[3,1,1,"","StopComponentResponse"],[3,1,1,"","SubscribeToComponentUpdatesRequest"],[3,1,1,"","SubscribeToComponentUpdatesResponse"],[3,1,1,"","SubscribeToConfigurationUpdateRequest"],[3,1,1,"","SubscribeToConfigurationUpdateResponse"],[3,1,1,"","SubscribeToIoTCoreRequest"],[3,1,1,"","SubscribeToIoTCoreResponse"],[3,1,1,"","SubscribeToTopicRequest"],[3,1,1,"","SubscribeToTopicResponse"],[3,1,1,"","SubscribeToValidateConfigurationUpdatesRequest"],[3,1,1,"","SubscribeToValidateConfigurationUpdatesResponse"],[3,1,1,"","SubscriptionResponseMessage"],[3,1,1,"","SystemResourceLimits"],[3,4,1,"","UnauthorizedError"],[3,1,1,"","UpdateConfigurationRequest"],[3,1,1,"","UpdateConfigurationResponse"],[3,1,1,"","UpdateStateRequest"],[3,1,1,"","UpdateStateResponse"],[3,1,1,"","UpdateThingShadowRequest"],[3,1,1,"","UpdateThingShadowResponse"],[3,1,1,"","ValidateAuthorizationTokenRequest"],[3,1,1,"","ValidateAuthorizationTokenResponse"],[3,1,1,"","ValidateConfigurationUpdateEvent"],[3,1,1,"","ValidateConfigurationUpdateEvents"]],"awsiot.greengrasscoreipc.model.BinaryMessage":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.ComponentDetails":[[3,5,1,"","component_name"],[3,5,1,"","configuration"],[3,5,1,"","state"],[3,5,1,"","version"]],"awsiot.greengrasscoreipc.model.ComponentNotFoundError":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.ComponentUpdatePolicyEvents":[[3,5,1,"","post_update_event"],[3,5,1,"","pre_update_event"]],"awsiot.greengrasscoreipc.model.ConfigurationUpdateEvent":[[3,5,1,"","component_name"],[3,5,1,"","key_path"]],"awsiot.greengrasscoreipc.model.ConfigurationUpdateEvents":[[3,5,1,"","configuration_update_event"]],"awsiot.greengrasscoreipc.model.ConfigurationValidityReport":[[3,5,1,"","deployment_id"],[3,5,1,"","message"],[3,5,1,"","status"]],"awsiot.greengrasscoreipc.model.ConflictError":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.CreateDebugPasswordResponse":[[3,5,1,"","certificate_sha1_hash"],[3,5,1,"","certificate_sha256_hash"],[3,5,1,"","password"],[3,5,1,"","password_expiration"],[3,5,1,"","username"]],"awsiot.greengrasscoreipc.model.CreateLocalDeploymentRequest":[[3,5,1,"","artifacts_directory_path"],[3,5,1,"","component_to_configuration"],[3,5,1,"","component_to_run_with_info"],[3,5,1,"","group_name"],[3,5,1,"","recipe_directory_path"],[3,5,1,"","root_component_versions_to_add"],[3,5,1,"","root_components_to_remove"]],"awsiot.greengrasscoreipc.model.CreateLocalDeploymentResponse":[[3,5,1,"","deployment_id"]],"awsiot.greengrasscoreipc.model.DeferComponentUpdateRequest":[[3,5,1,"","deployment_id"],[3,5,1,"","message"],[3,5,1,"","recheck_after_ms"]],"awsiot.greengrasscoreipc.model.DeleteThingShadowRequest":[[3,5,1,"","shadow_name"],[3,5,1,"","thing_name"]],"awsiot.greengrasscoreipc.model.DeleteThingShadowResponse":[[3,5,1,"","payload"]],"awsiot.greengrasscoreipc.model.FailedUpdateConditionCheckError":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.GetComponentDetailsRequest":[[3,5,1,"","component_name"]],"awsiot.greengrasscoreipc.model.GetComponentDetailsResponse":[[3,5,1,"","component_details"]],"awsiot.greengrasscoreipc.model.GetConfigurationRequest":[[3,5,1,"","component_name"],[3,5,1,"","key_path"]],"awsiot.greengrasscoreipc.model.GetConfigurationResponse":[[3,5,1,"","component_name"],[3,5,1,"","value"]],"awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusRequest":[[3,5,1,"","deployment_id"]],"awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusResponse":[[3,5,1,"","deployment"]],"awsiot.greengrasscoreipc.model.GetSecretValueRequest":[[3,5,1,"","secret_id"],[3,5,1,"","version_id"],[3,5,1,"","version_stage"]],"awsiot.greengrasscoreipc.model.GetSecretValueResponse":[[3,5,1,"","secret_id"],[3,5,1,"","secret_value"],[3,5,1,"","version_id"],[3,5,1,"","version_stage"]],"awsiot.greengrasscoreipc.model.GetThingShadowRequest":[[3,5,1,"","shadow_name"],[3,5,1,"","thing_name"]],"awsiot.greengrasscoreipc.model.GetThingShadowResponse":[[3,5,1,"","payload"]],"awsiot.greengrasscoreipc.model.InvalidArgumentsError":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.InvalidArtifactsDirectoryPathError":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.InvalidRecipeDirectoryPathError":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.InvalidTokenError":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.IoTCoreMessage":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.JsonMessage":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.ListComponentsResponse":[[3,5,1,"","components"]],"awsiot.greengrasscoreipc.model.ListLocalDeploymentsResponse":[[3,5,1,"","local_deployments"]],"awsiot.greengrasscoreipc.model.ListNamedShadowsForThingRequest":[[3,5,1,"","next_token"],[3,5,1,"","page_size"],[3,5,1,"","thing_name"]],"awsiot.greengrasscoreipc.model.ListNamedShadowsForThingResponse":[[3,5,1,"","next_token"],[3,5,1,"","results"],[3,5,1,"","timestamp"]],"awsiot.greengrasscoreipc.model.LocalDeployment":[[3,5,1,"","deployment_id"],[3,5,1,"","status"]],"awsiot.greengrasscoreipc.model.MQTTMessage":[[3,5,1,"","payload"],[3,5,1,"","topic_name"]],"awsiot.greengrasscoreipc.model.PauseComponentRequest":[[3,5,1,"","component_name"]],"awsiot.greengrasscoreipc.model.PostComponentUpdateEvent":[[3,5,1,"","deployment_id"]],"awsiot.greengrasscoreipc.model.PreComponentUpdateEvent":[[3,5,1,"","deployment_id"],[3,5,1,"","is_ggc_restarting"]],"awsiot.greengrasscoreipc.model.PublishMessage":[[3,5,1,"","binary_message"],[3,5,1,"","json_message"]],"awsiot.greengrasscoreipc.model.PublishToIoTCoreRequest":[[3,5,1,"","payload"],[3,5,1,"","qos"],[3,5,1,"","topic_name"]],"awsiot.greengrasscoreipc.model.PublishToTopicRequest":[[3,5,1,"","publish_message"],[3,5,1,"","topic"]],"awsiot.greengrasscoreipc.model.ResourceNotFoundError":[[3,5,1,"","message"],[3,5,1,"","resource_name"],[3,5,1,"","resource_type"]],"awsiot.greengrasscoreipc.model.RestartComponentRequest":[[3,5,1,"","component_name"]],"awsiot.greengrasscoreipc.model.RestartComponentResponse":[[3,5,1,"","message"],[3,5,1,"","restart_status"]],"awsiot.greengrasscoreipc.model.ResumeComponentRequest":[[3,5,1,"","component_name"]],"awsiot.greengrasscoreipc.model.RunWithInfo":[[3,5,1,"","posix_user"],[3,5,1,"","system_resource_limits"]],"awsiot.greengrasscoreipc.model.SecretValue":[[3,5,1,"","secret_binary"],[3,5,1,"","secret_string"]],"awsiot.greengrasscoreipc.model.SendConfigurationValidityReportRequest":[[3,5,1,"","configuration_validity_report"]],"awsiot.greengrasscoreipc.model.ServiceError":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.StopComponentRequest":[[3,5,1,"","component_name"]],"awsiot.greengrasscoreipc.model.StopComponentResponse":[[3,5,1,"","message"],[3,5,1,"","stop_status"]],"awsiot.greengrasscoreipc.model.SubscribeToConfigurationUpdateRequest":[[3,5,1,"","component_name"],[3,5,1,"","key_path"]],"awsiot.greengrasscoreipc.model.SubscribeToIoTCoreRequest":[[3,5,1,"","qos"],[3,5,1,"","topic_name"]],"awsiot.greengrasscoreipc.model.SubscribeToTopicRequest":[[3,5,1,"","topic"]],"awsiot.greengrasscoreipc.model.SubscribeToTopicResponse":[[3,5,1,"","topic_name"]],"awsiot.greengrasscoreipc.model.SubscriptionResponseMessage":[[3,5,1,"","binary_message"],[3,5,1,"","json_message"]],"awsiot.greengrasscoreipc.model.SystemResourceLimits":[[3,5,1,"","cpus"],[3,5,1,"","memory"]],"awsiot.greengrasscoreipc.model.UnauthorizedError":[[3,5,1,"","message"]],"awsiot.greengrasscoreipc.model.UpdateConfigurationRequest":[[3,5,1,"","key_path"],[3,5,1,"","timestamp"],[3,5,1,"","value_to_merge"]],"awsiot.greengrasscoreipc.model.UpdateStateRequest":[[3,5,1,"","state"]],"awsiot.greengrasscoreipc.model.UpdateThingShadowRequest":[[3,5,1,"","payload"],[3,5,1,"","shadow_name"],[3,5,1,"","thing_name"]],"awsiot.greengrasscoreipc.model.UpdateThingShadowResponse":[[3,5,1,"","payload"]],"awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenRequest":[[3,5,1,"","token"]],"awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenResponse":[[3,5,1,"","is_valid"]],"awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvent":[[3,5,1,"","configuration"],[3,5,1,"","deployment_id"]],"awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvents":[[3,5,1,"","validate_configuration_update_event"]],"awsiot.iotidentity":[[4,1,1,"","CreateCertificateFromCsrRequest"],[4,1,1,"","CreateCertificateFromCsrResponse"],[4,1,1,"","CreateCertificateFromCsrSubscriptionRequest"],[4,1,1,"","CreateKeysAndCertificateRequest"],[4,1,1,"","CreateKeysAndCertificateResponse"],[4,1,1,"","CreateKeysAndCertificateSubscriptionRequest"],[4,1,1,"","ErrorResponse"],[4,1,1,"","IotIdentityClient"],[4,1,1,"","RegisterThingRequest"],[4,1,1,"","RegisterThingResponse"],[4,1,1,"","RegisterThingSubscriptionRequest"]],"awsiot.iotidentity.CreateCertificateFromCsrRequest":[[4,5,1,"","certificate_signing_request"]],"awsiot.iotidentity.CreateCertificateFromCsrResponse":[[4,5,1,"","certificate_id"],[4,5,1,"","certificate_ownership_token"],[4,5,1,"","certificate_pem"]],"awsiot.iotidentity.CreateKeysAndCertificateResponse":[[4,5,1,"","certificate_id"],[4,5,1,"","certificate_ownership_token"],[4,5,1,"","certificate_pem"],[4,5,1,"","private_key"]],"awsiot.iotidentity.ErrorResponse":[[4,5,1,"","error_code"],[4,5,1,"","error_message"],[4,5,1,"","status_code"]],"awsiot.iotidentity.IotIdentityClient":[[4,3,1,"","publish_create_certificate_from_csr"],[4,3,1,"","publish_create_keys_and_certificate"],[4,3,1,"","publish_register_thing"],[4,3,1,"","subscribe_to_create_certificate_from_csr_accepted"],[4,3,1,"","subscribe_to_create_certificate_from_csr_rejected"],[4,3,1,"","subscribe_to_create_keys_and_certificate_accepted"],[4,3,1,"","subscribe_to_create_keys_and_certificate_rejected"],[4,3,1,"","subscribe_to_register_thing_accepted"],[4,3,1,"","subscribe_to_register_thing_rejected"]],"awsiot.iotidentity.RegisterThingRequest":[[4,5,1,"","certificate_ownership_token"],[4,5,1,"","parameters"],[4,5,1,"","template_name"]],"awsiot.iotidentity.RegisterThingResponse":[[4,5,1,"","device_configuration"],[4,5,1,"","thing_name"]],"awsiot.iotidentity.RegisterThingSubscriptionRequest":[[4,5,1,"","template_name"]],"awsiot.iotjobs":[[5,1,1,"","DescribeJobExecutionRequest"],[5,1,1,"","DescribeJobExecutionResponse"],[5,1,1,"","DescribeJobExecutionSubscriptionRequest"],[5,1,1,"","GetPendingJobExecutionsRequest"],[5,1,1,"","GetPendingJobExecutionsResponse"],[5,1,1,"","GetPendingJobExecutionsSubscriptionRequest"],[5,1,1,"","IotJobsClient"],[5,1,1,"","JobExecutionData"],[5,1,1,"","JobExecutionState"],[5,1,1,"","JobExecutionSummary"],[5,1,1,"","JobExecutionsChangedEvent"],[5,1,1,"","JobExecutionsChangedSubscriptionRequest"],[5,1,1,"","JobStatus"],[5,1,1,"","NextJobExecutionChangedEvent"],[5,1,1,"","NextJobExecutionChangedSubscriptionRequest"],[5,1,1,"","RejectedError"],[5,1,1,"","RejectedErrorCode"],[5,1,1,"","StartNextJobExecutionResponse"],[5,1,1,"","StartNextPendingJobExecutionRequest"],[5,1,1,"","StartNextPendingJobExecutionSubscriptionRequest"],[5,1,1,"","UpdateJobExecutionRequest"],[5,1,1,"","UpdateJobExecutionResponse"],[5,1,1,"","UpdateJobExecutionSubscriptionRequest"]],"awsiot.iotjobs.DescribeJobExecutionRequest":[[5,5,1,"","client_token"],[5,5,1,"","execution_number"],[5,5,1,"","include_job_document"],[5,5,1,"","job_id"],[5,5,1,"","thing_name"]],"awsiot.iotjobs.DescribeJobExecutionResponse":[[5,5,1,"","client_token"],[5,5,1,"","execution"],[5,5,1,"","timestamp"]],"awsiot.iotjobs.DescribeJobExecutionSubscriptionRequest":[[5,5,1,"","job_id"],[5,5,1,"","thing_name"]],"awsiot.iotjobs.GetPendingJobExecutionsRequest":[[5,5,1,"","client_token"],[5,5,1,"","thing_name"]],"awsiot.iotjobs.GetPendingJobExecutionsResponse":[[5,5,1,"","client_token"],[5,5,1,"","in_progress_jobs"],[5,5,1,"","queued_jobs"],[5,5,1,"","timestamp"]],"awsiot.iotjobs.GetPendingJobExecutionsSubscriptionRequest":[[5,5,1,"","thing_name"]],"awsiot.iotjobs.IotJobsClient":[[5,3,1,"","publish_describe_job_execution"],[5,3,1,"","publish_get_pending_job_executions"],[5,3,1,"","publish_start_next_pending_job_execution"],[5,3,1,"","publish_update_job_execution"],[5,3,1,"","subscribe_to_describe_job_execution_accepted"],[5,3,1,"","subscribe_to_describe_job_execution_rejected"],[5,3,1,"","subscribe_to_get_pending_job_executions_accepted"],[5,3,1,"","subscribe_to_get_pending_job_executions_rejected"],[5,3,1,"","subscribe_to_job_executions_changed_events"],[5,3,1,"","subscribe_to_next_job_execution_changed_events"],[5,3,1,"","subscribe_to_start_next_pending_job_execution_accepted"],[5,3,1,"","subscribe_to_start_next_pending_job_execution_rejected"],[5,3,1,"","subscribe_to_update_job_execution_accepted"],[5,3,1,"","subscribe_to_update_job_execution_rejected"]],"awsiot.iotjobs.JobExecutionData":[[5,5,1,"","execution_number"],[5,5,1,"","job_document"],[5,5,1,"","job_id"],[5,5,1,"","last_updated_at"],[5,5,1,"","queued_at"],[5,5,1,"","started_at"],[5,5,1,"","status"],[5,5,1,"","status_details"],[5,5,1,"","thing_name"],[5,5,1,"","version_number"]],"awsiot.iotjobs.JobExecutionState":[[5,5,1,"","status"],[5,5,1,"","status_details"],[5,5,1,"","version_number"]],"awsiot.iotjobs.JobExecutionSummary":[[5,5,1,"","execution_number"],[5,5,1,"","job_id"],[5,5,1,"","last_updated_at"],[5,5,1,"","queued_at"],[5,5,1,"","started_at"],[5,5,1,"","version_number"]],"awsiot.iotjobs.JobExecutionsChangedEvent":[[5,5,1,"","jobs"],[5,5,1,"","timestamp"]],"awsiot.iotjobs.JobExecutionsChangedSubscriptionRequest":[[5,5,1,"","thing_name"]],"awsiot.iotjobs.JobStatus":[[5,5,1,"","CANCELED"],[5,5,1,"","FAILED"],[5,5,1,"","IN_PROGRESS"],[5,5,1,"","QUEUED"],[5,5,1,"","REJECTED"],[5,5,1,"","REMOVED"],[5,5,1,"","SUCCEEDED"],[5,5,1,"","TIMED_OUT"]],"awsiot.iotjobs.NextJobExecutionChangedEvent":[[5,5,1,"","execution"],[5,5,1,"","timestamp"]],"awsiot.iotjobs.NextJobExecutionChangedSubscriptionRequest":[[5,5,1,"","thing_name"]],"awsiot.iotjobs.RejectedError":[[5,5,1,"","client_token"],[5,5,1,"","code"],[5,5,1,"","execution_state"],[5,5,1,"","message"],[5,5,1,"","timestamp"]],"awsiot.iotjobs.RejectedErrorCode":[[5,5,1,"","INTERNAL_ERROR"],[5,5,1,"","INVALID_JSON"],[5,5,1,"","INVALID_REQUEST"],[5,5,1,"","INVALID_STATE_TRANSITION"],[5,5,1,"","INVALID_TOPIC"],[5,5,1,"","REQUEST_THROTTLED"],[5,5,1,"","RESOURCE_NOT_FOUND"],[5,5,1,"","TERMINAL_STATE_REACHED"],[5,5,1,"","VERSION_MISMATCH"]],"awsiot.iotjobs.StartNextJobExecutionResponse":[[5,5,1,"","client_token"],[5,5,1,"","execution"],[5,5,1,"","timestamp"]],"awsiot.iotjobs.StartNextPendingJobExecutionRequest":[[5,5,1,"","client_token"],[5,5,1,"","status_details"],[5,5,1,"","step_timeout_in_minutes"],[5,5,1,"","thing_name"]],"awsiot.iotjobs.StartNextPendingJobExecutionSubscriptionRequest":[[5,5,1,"","thing_name"]],"awsiot.iotjobs.UpdateJobExecutionRequest":[[5,5,1,"","client_token"],[5,5,1,"","execution_number"],[5,5,1,"","expected_version"],[5,5,1,"","include_job_document"],[5,5,1,"","include_job_execution_state"],[5,5,1,"","job_id"],[5,5,1,"","status"],[5,5,1,"","status_details"],[5,5,1,"","step_timeout_in_minutes"],[5,5,1,"","thing_name"]],"awsiot.iotjobs.UpdateJobExecutionResponse":[[5,5,1,"","client_token"],[5,5,1,"","execution_state"],[5,5,1,"","job_document"],[5,5,1,"","timestamp"]],"awsiot.iotjobs.UpdateJobExecutionSubscriptionRequest":[[5,5,1,"","job_id"],[5,5,1,"","thing_name"]],"awsiot.iotshadow":[[6,1,1,"","DeleteNamedShadowRequest"],[6,1,1,"","DeleteNamedShadowSubscriptionRequest"],[6,1,1,"","DeleteShadowRequest"],[6,1,1,"","DeleteShadowResponse"],[6,1,1,"","DeleteShadowSubscriptionRequest"],[6,1,1,"","ErrorResponse"],[6,1,1,"","GetNamedShadowRequest"],[6,1,1,"","GetNamedShadowSubscriptionRequest"],[6,1,1,"","GetShadowRequest"],[6,1,1,"","GetShadowResponse"],[6,1,1,"","GetShadowSubscriptionRequest"],[6,1,1,"","IotShadowClient"],[6,1,1,"","NamedShadowDeltaUpdatedSubscriptionRequest"],[6,1,1,"","NamedShadowUpdatedSubscriptionRequest"],[6,1,1,"","ShadowDeltaUpdatedEvent"],[6,1,1,"","ShadowDeltaUpdatedSubscriptionRequest"],[6,1,1,"","ShadowMetadata"],[6,1,1,"","ShadowState"],[6,1,1,"","ShadowStateWithDelta"],[6,1,1,"","ShadowUpdatedEvent"],[6,1,1,"","ShadowUpdatedSnapshot"],[6,1,1,"","ShadowUpdatedSubscriptionRequest"],[6,1,1,"","UpdateNamedShadowRequest"],[6,1,1,"","UpdateNamedShadowSubscriptionRequest"],[6,1,1,"","UpdateShadowRequest"],[6,1,1,"","UpdateShadowResponse"],[6,1,1,"","UpdateShadowSubscriptionRequest"]],"awsiot.iotshadow.DeleteNamedShadowRequest":[[6,5,1,"","client_token"],[6,5,1,"","shadow_name"],[6,5,1,"","thing_name"]],"awsiot.iotshadow.DeleteNamedShadowSubscriptionRequest":[[6,5,1,"","shadow_name"],[6,5,1,"","thing_name"]],"awsiot.iotshadow.DeleteShadowRequest":[[6,5,1,"","client_token"],[6,5,1,"","thing_name"]],"awsiot.iotshadow.DeleteShadowResponse":[[6,5,1,"","client_token"],[6,5,1,"","timestamp"],[6,5,1,"","version"]],"awsiot.iotshadow.DeleteShadowSubscriptionRequest":[[6,5,1,"","thing_name"]],"awsiot.iotshadow.ErrorResponse":[[6,5,1,"","client_token"],[6,5,1,"","code"],[6,5,1,"","message"],[6,5,1,"","timestamp"]],"awsiot.iotshadow.GetNamedShadowRequest":[[6,5,1,"","client_token"],[6,5,1,"","shadow_name"],[6,5,1,"","thing_name"]],"awsiot.iotshadow.GetNamedShadowSubscriptionRequest":[[6,5,1,"","shadow_name"],[6,5,1,"","thing_name"]],"awsiot.iotshadow.GetShadowRequest":[[6,5,1,"","client_token"],[6,5,1,"","thing_name"]],"awsiot.iotshadow.GetShadowResponse":[[6,5,1,"","client_token"],[6,5,1,"","metadata"],[6,5,1,"","state"],[6,5,1,"","timestamp"],[6,5,1,"","version"]],"awsiot.iotshadow.GetShadowSubscriptionRequest":[[6,5,1,"","thing_name"]],"awsiot.iotshadow.IotShadowClient":[[6,3,1,"","publish_delete_named_shadow"],[6,3,1,"","publish_delete_shadow"],[6,3,1,"","publish_get_named_shadow"],[6,3,1,"","publish_get_shadow"],[6,3,1,"","publish_update_named_shadow"],[6,3,1,"","publish_update_shadow"],[6,3,1,"","subscribe_to_delete_named_shadow_accepted"],[6,3,1,"","subscribe_to_delete_named_shadow_rejected"],[6,3,1,"","subscribe_to_delete_shadow_accepted"],[6,3,1,"","subscribe_to_delete_shadow_rejected"],[6,3,1,"","subscribe_to_get_named_shadow_accepted"],[6,3,1,"","subscribe_to_get_named_shadow_rejected"],[6,3,1,"","subscribe_to_get_shadow_accepted"],[6,3,1,"","subscribe_to_get_shadow_rejected"],[6,3,1,"","subscribe_to_named_shadow_delta_updated_events"],[6,3,1,"","subscribe_to_named_shadow_updated_events"],[6,3,1,"","subscribe_to_shadow_delta_updated_events"],[6,3,1,"","subscribe_to_shadow_updated_events"],[6,3,1,"","subscribe_to_update_named_shadow_accepted"],[6,3,1,"","subscribe_to_update_named_shadow_rejected"],[6,3,1,"","subscribe_to_update_shadow_accepted"],[6,3,1,"","subscribe_to_update_shadow_rejected"]],"awsiot.iotshadow.NamedShadowDeltaUpdatedSubscriptionRequest":[[6,5,1,"","shadow_name"],[6,5,1,"","thing_name"]],"awsiot.iotshadow.NamedShadowUpdatedSubscriptionRequest":[[6,5,1,"","shadow_name"],[6,5,1,"","thing_name"]],"awsiot.iotshadow.ShadowDeltaUpdatedEvent":[[6,5,1,"","metadata"],[6,5,1,"","state"],[6,5,1,"","timestamp"],[6,5,1,"","version"]],"awsiot.iotshadow.ShadowDeltaUpdatedSubscriptionRequest":[[6,5,1,"","thing_name"]],"awsiot.iotshadow.ShadowMetadata":[[6,5,1,"","desired"],[6,5,1,"","reported"]],"awsiot.iotshadow.ShadowState":[[6,5,1,"","desired"],[6,5,1,"","reported"]],"awsiot.iotshadow.ShadowStateWithDelta":[[6,5,1,"","delta"],[6,5,1,"","desired"],[6,5,1,"","reported"]],"awsiot.iotshadow.ShadowUpdatedEvent":[[6,5,1,"","current"],[6,5,1,"","previous"],[6,5,1,"","timestamp"]],"awsiot.iotshadow.ShadowUpdatedSnapshot":[[6,5,1,"","metadata"],[6,5,1,"","state"],[6,5,1,"","version"]],"awsiot.iotshadow.ShadowUpdatedSubscriptionRequest":[[6,5,1,"","thing_name"]],"awsiot.iotshadow.UpdateNamedShadowRequest":[[6,5,1,"","client_token"],[6,5,1,"","shadow_name"],[6,5,1,"","state"],[6,5,1,"","thing_name"],[6,5,1,"","version"]],"awsiot.iotshadow.UpdateNamedShadowSubscriptionRequest":[[6,5,1,"","shadow_name"],[6,5,1,"","thing_name"]],"awsiot.iotshadow.UpdateShadowRequest":[[6,5,1,"","client_token"],[6,5,1,"","state"],[6,5,1,"","thing_name"],[6,5,1,"","version"]],"awsiot.iotshadow.UpdateShadowResponse":[[6,5,1,"","client_token"],[6,5,1,"","metadata"],[6,5,1,"","state"],[6,5,1,"","timestamp"],[6,5,1,"","version"]],"awsiot.iotshadow.UpdateShadowSubscriptionRequest":[[6,5,1,"","thing_name"]],"awsiot.mqtt_connection_builder":[[7,6,1,"","mtls_from_bytes"],[7,6,1,"","mtls_from_path"],[7,6,1,"","websockets_with_custom_handshake"],[7,6,1,"","websockets_with_default_aws_signing"]],awsiot:[[0,1,1,"","ModeledClass"],[0,1,1,"","MqttServiceClient"],[1,0,0,"-","eventstreamrpc"],[2,0,0,"-","greengrass_discovery"],[3,0,0,"-","greengrasscoreipc"],[4,0,0,"-","iotidentity"],[5,0,0,"-","iotjobs"],[6,0,0,"-","iotshadow"],[7,0,0,"-","mqtt_connection_builder"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","property","Python property"],"3":["py","method","Python method"],"4":["py","exception","Python exception"],"5":["py","attribute","Python attribute"],"6":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:property","3":"py:method","4":"py:exception","5":"py:attribute","6":"py:function"},terms:{"0":[1,3,7],"1":[4,5,6,7],"10":3,"1200sec":7,"20":7,"3":7,"3000m":7,"443":7,"5":7,"5000m":7,"5x":7,"8":5,"8883":7,"byte":[1,3,7],"case":5,"class":[0,1,2,3,4,5,6,7],"default":[1,3,4,5,6,7],"do":1,"enum":3,"float":3,"function":[1,7],"int":[1,2,3,4,5,6,7],"new":[3,4,5,7],"public":1,"return":[0,1,2,3,4,5,6,7],"static":1,"true":[1,3,5,7],"while":[5,7],A:[1,4,5,6,7],For:1,If:[1,5,7],In:5,It:[5,6,7],Or:5,The:[1,3,4,5,6,7],There:5,These:1,Will:7,_base:[0,1,2,3,4,5,6],_createdebugpasswordoper:3,_createlocaldeploymentoper:3,_defercomponentupdateoper:3,_deletethingshadowoper:3,_getcomponentdetailsoper:3,_getconfigurationoper:3,_getlocaldeploymentstatusoper:3,_getsecretvalueoper:3,_getthingshadowoper:3,_listcomponentsoper:3,_listlocaldeploymentsoper:3,_listnamedshadowsforthingoper:3,_pausecomponentoper:3,_publishtoiotcoreoper:3,_publishtotopicoper:3,_restartcomponentoper:3,_resumecomponentoper:3,_sendconfigurationvalidityreportoper:3,_stopcomponentoper:3,_subscribetocomponentupdatesoper:3,_subscribetoconfigurationupdateoper:3,_subscribetoiotcoreoper:3,_subscribetotopicoper:3,_subscribetovalidateconfigurationupdatesoper:3,_updateconfigurationoper:3,_updatestateoper:3,_updatethingshadowoper:3,_validateauthorizationtokenoper:3,about:[4,5,6],accept:[4,5,6],access:1,accessdeniederror:1,acknowledg:[0,4,5,6],across:[1,7],activ:[3,4],ad:5,add:[1,6],addit:[5,6],address:2,affect:6,after:[1,6,7],again:[1,5],aliv:7,all:[1,3,4,5,6,7],alpn:7,alreadi:[1,7],also:5,alwai:1,amazon:[4,5,6,8],amend:1,amount:[5,7],an:[0,1,2,3,4,5,6,7],ani:[3,5,6],anoth:1,anyth:[4,5,6],api:[1,4,5,6],app:6,appli:[6,7],applic:1,appropri:1,ar:[1,3,4,5,6,7],arbitrari:[5,6],arg:[1,4,5,6],argument:[3,4,5,6,7],arn:2,arriv:[1,4,5,6],artifacts_directory_path:3,assign:5,assist:4,associ:5,assum:7,asynchron:[1,2],attempt:[1,3,5,7],attribut:[3,4,5,6],auth:7,authent:3,author:4,authtoken:[1,3],automat:7,avail:6,avoid:1,aw:[0,2,4,5,6,7],aws_gg_nucleus_domain_socket_filepath_for_compon:3,awscredentialsprovid:7,awscrt:[0,1,2,4,5,6,7],awscrterror:7,awsiot:8,awsiotsdk:8,b:1,base:[0,1,2,3,4,5,6],becaus:5,been:[1,5],befor:[1,4,5,6,7],being:[1,7],between:[6,7],binari:1,binary_messag:3,binarymessag:3,bind:8,bodi:5,bool:[1,3,5,7],bootstrap:[1,2,7],build:1,builder:7,ca:[4,7],ca_byt:7,ca_dirpath:7,ca_filepath:7,call:[1,3,4,5,7],callabl:[1,4,5,6,7],callback:[1,3,4,5,6,7],can:[5,6,7],cancel:5,cannot:[4,5,6],catalog:1,caus:[1,7],cert:4,cert_byt:7,cert_filepath:7,certif:[4,7],certificate_author:2,certificate_id:4,certificate_ownership_token:4,certificate_pem:4,certificate_sha1_hash:3,certificate_sha256_hash:3,certificate_signing_request:4,chang:[4,5,6],child:1,classic:6,clean:[1,7],clean_sess:7,client:[0,1,2,3,4,5,6,7],client_bootstrap:7,client_id:7,client_token:[5,6],clientbootstrap:[1,2,7],clientoper:1,clienttlscontext:2,close:[1,3],code:[2,4,5,6,7],collect:5,com:[4,5,6,8],come:1,command:5,common:7,compat:7,complet:[1,3,6,7],compon:3,component_detail:3,component_nam:3,component_to_configur:3,component_to_run_with_info:3,componentdetail:3,componentnotfounderror:3,componentupdatepolicyev:3,concurr:[0,1,2,3,4,5,6],configur:[3,4,7],configuration_update_ev:3,configuration_validity_report:3,configurationupdateev:3,configurationvalidityreport:3,configurationvaliditystatu:3,conflicterror:3,connect:[0,1,2,3,4,5,6,7],connect_message_amend:1,connectionclosederror:1,connectivityinfo:2,connectreturncod:7,constructor:[3,4,5,6],contain:[1,2,4,5,6,7],content:5,context:2,continut:1,core:[2,7],correl:[5,6],could:5,cours:[1,3],cpu:3,creat:[1,3,4,5,7],create_static_authtoken_amend:1,createcertificatefromcsr:4,createcertificatefromcsrrequest:4,createcertificatefromcsrrespons:4,createcertificatefromcsrsubscriptionrequest:4,createdebugpasswordoper:3,createdebugpasswordrequest:3,createdebugpasswordrespons:3,createjob:5,createkeysandcertif:4,createkeysandcertificaterequest:4,createkeysandcertificaterespons:4,createkeysandcertificatesubscriptionrequest:4,createlocaldeploymentoper:3,createlocaldeploymentrequest:3,createlocaldeploymentrespons:3,credenti:7,credentials_provid:7,csr:4,current:[5,6],custom:7,data:[1,3,4,5,6],date:[5,6],datetim:[3,5,6],deal:1,defercomponentupdateoper:3,defercomponentupdaterequest:3,defercomponentupdaterespons:3,defin:[4,5],delet:6,deletenamedshadow:6,deletenamedshadowrequest:6,deletenamedshadowsubscriptionrequest:6,deleteshadow:6,deleteshadowrequest:6,deleteshadowrespons:6,deleteshadowsubscriptionrequest:6,deletethingshadowoper:3,deletethingshadowrequest:3,deletethingshadowrespons:3,delta:6,deni:1,deploy:3,deployment_id:3,deploymentstatu:3,deprec:7,describ:[4,5,7],describejobexecut:5,describejobexecutionrequest:5,describejobexecutionrespons:5,describejobexecutionsubscriptionrequest:5,descript:6,deseri:1,deserializeerror:1,desir:6,detail:[4,5,6],determin:6,develop:8,developerguid:[4,5,6,8],devic:[4,5,6,7],device_configur:4,dict:[3,4,5,6,7],directori:7,disabl:7,disconnect:[1,7],discov:2,discoveri:2,discoverrespons:2,discoverycli:2,discoveryexcept:2,doc:[4,5,6,7,8],document:[1,4,5,6],doe:[1,5],domain:3,don:5,done:[1,7],doubl:7,durat:7,dure:[3,4,5],each:[1,4,5,6,7],effect:[1,5],enable_metrics_collect:7,encod:5,encount:5,end:1,endpoint:7,enqueu:5,enter:[5,6],environ:3,error:[1,2,3,4,5,6,7],error_cod:4,error_messag:4,errorrespons:[4,5,6],errorshap:[1,3],establish:[1,3,7],evalu:4,even:1,event:[1,3,4,5,6],eventstream:1,eventstreamerror:1,eventstreamoperationerror:1,eventstreamrpc:[3,8],everi:5,except:[1,2,3,4,5,6,7],execut:5,execution_numb:5,execution_st:5,executionst:5,exist:[5,7],expect:[4,5,6],expected_vers:5,expir:5,explain:1,extern:6,fail:[1,3,4,5,6,7],failedupdateconditioncheckerror:3,failur:[1,2],fals:[1,5,7],field:[5,6],file:7,filepath:7,find_shape_typ:1,finish:[1,5],fire:3,first:[1,4,5,6],fleet:4,follow:7,forget:7,forgotten:7,format:[4,7],forward:7,from:[0,1,3,4,5,6,7],fulli:1,futur:[0,1,2,3,4,5,6],gener:[0,4,5,6],get:[5,6,7],get_respons:3,getcomponentdetailsoper:3,getcomponentdetailsrequest:3,getcomponentdetailsrespons:3,getconfigurationoper:3,getconfigurationrequest:3,getconfigurationrespons:3,getlocaldeploymentstatusoper:3,getlocaldeploymentstatusrequest:3,getlocaldeploymentstatusrespons:3,getnamedshadow:6,getnamedshadowrequest:6,getnamedshadowsubscriptionrequest:6,getpendingjobexecut:5,getpendingjobexecutionsrequest:5,getpendingjobexecutionsrespons:5,getpendingjobexecutionssubscriptionrequest:5,getpendingjobsexecut:5,getsecretvalueoper:3,getsecretvaluerequest:3,getsecretvaluerespons:3,getshadow:6,getshadowrequest:6,getshadowrespons:6,getshadowsubscriptionrequest:6,getthingshadowoper:3,getthingshadowrequest:3,getthingshadowrespons:3,gg_group:2,gg_group_id:2,ggcore:2,gggroup:2,github:8,given:[1,5],grant:[4,5,6],greengrass:[2,3],greengrass_discoveri:8,greengrasscoreipc:8,greengrasscoreipccli:3,greengrasscoreipcerror:3,group:2,group_nam:3,guarante:[4,5,6],guid:8,ha:[0,1,3,4,5,7],handl:[1,3],handler:[1,3],handshak:7,happen:3,have:[1,5],header:1,here:[5,6],higher:7,hook:4,host:[1,7],host_address:2,host_nam:1,html:[4,5,6],http:[2,4,5,6,7,8],http_proxy_opt:7,http_response_cod:2,httpproxyopt:7,id:[2,4,5,7],identifi:5,in_progress:5,in_progress_job:5,inact:4,includ:[5,6],include_job_docu:5,include_job_execution_st:5,increas:6,increment:5,index:8,indic:[5,6],info:[1,2,3,7],inform:[5,6,7],inherit:[1,3],init:1,initi:[1,3],input:0,instal:4,instanc:[4,5,6],interact:1,intern:5,internal_error:5,internalerror:5,interpret:5,interv:7,invalid:[5,7],invalid_json:5,invalid_request:5,invalid_state_transit:5,invalid_top:5,invalidargumentserror:3,invalidartifactsdirectorypatherror:3,invalidjson:5,invalidrecipedirectorypatherror:3,invalidrequest:5,invalidstatetransit:5,invalidtokenerror:3,invalidtop:5,invok:[1,3,4,5,6,7],io:[1,2,7],iot:[4,5,6,7],iotcoremessag:3,iotident:8,iotidentitycli:4,iotjob:8,iotjobscli:5,iotshadow:8,iotshadowcli:6,ipc:3,ipc_socket:3,is_ggc_restart:3,is_valid:3,its:[5,7],job:5,job_docu:5,job_id:5,jobdocu:5,jobexecut:5,jobexecutiondata:5,jobexecutionschang:5,jobexecutionschangedev:5,jobexecutionschangedsubscriptionrequest:5,jobexecutionst:5,jobexecutionsummari:5,jobid:5,jobstatu:5,json:5,json_messag:3,jsonmessag:3,keep:7,keep_alive_sec:7,kei:[4,7],key_path:3,keyword:[3,4,5,6,7],kind:5,known:1,kwarg:[4,5,6,7],last:[1,5,6],last_updated_at:5,later:5,latest:[4,5,6,8],leak:1,level:1,life:1,lifecycle_handl:[1,3],lifecyclehandl:[1,3],lifecyclest:3,list:[2,3,5],listcomponentsoper:3,listcomponentsrequest:3,listcomponentsrespons:3,listen:[4,6],listlocaldeploymentsoper:3,listlocaldeploymentsrequest:3,listlocaldeploymentsrespons:3,listnamedshadowsforthingoper:3,listnamedshadowsforthingrequest:3,listnamedshadowsforthingrespons:3,load:7,local_deploy:3,localdeploy:3,longer:7,loss:7,lost:7,mai:[1,3,4,5,6,7],make:[5,6],map:[1,5],match:[5,6],max:7,maximum:7,memori:[3,7],mesag:7,messag:[0,1,2,3,4,5,6],messageamend:1,metadata:[2,6],method:[1,3],might:5,millisecond:7,min:7,minimum:7,minut:7,model:[0,1,3],model_nam:1,modeledclass:[0,2,4,5,6],modifi:7,modul:8,more:[1,3,5,7],mqtt:[0,4,5,6,7],mqtt_connect:[0,4,5,6],mqtt_connection_build:8,mqttmessag:3,mqttservicecli:[0,4,5,6],mtl:7,mtls_from_byt:7,mtls_from_path:7,multipl:1,must:[1,5,7],name:[1,4,5,6,7],namedshadowdelta:6,namedshadowdeltaupdatedsubscriptionrequest:6,namedshadowupd:6,namedshadowupdatedsubscriptionrequest:6,namespac:5,nearli:1,necessarili:1,need:[4,5,6],network:[1,3],new_create_debug_password:3,new_create_local_deploy:3,new_defer_component_upd:3,new_delete_thing_shadow:3,new_get_component_detail:3,new_get_configur:3,new_get_local_deployment_statu:3,new_get_secret_valu:3,new_get_thing_shadow:3,new_list_compon:3,new_list_local_deploy:3,new_list_named_shadows_for_th:3,new_pause_compon:3,new_publish_to_iot_cor:3,new_publish_to_top:3,new_restart_compon:3,new_resume_compon:3,new_send_configuration_validity_report:3,new_stop_compon:3,new_subscribe_to_component_upd:3,new_subscribe_to_configuration_upd:3,new_subscribe_to_iot_cor:3,new_subscribe_to_top:3,new_subscribe_to_validate_configuration_upd:3,new_update_configur:3,new_update_st:3,new_update_thing_shadow:3,new_validate_authorization_token:3,next:5,next_token:3,nextjobexecutionchang:5,nextjobexecutionchangedev:5,nextjobexecutionchangedsubscriptionrequest:5,none:[0,1,3,4,5,6,7],note:[1,4,5,6,7],noth:7,notif:5,now:7,nucleu:3,number:[3,5,7],object:[0,1,2,3,5,6],occur:[1,3,5],offlin:7,omit:7,on_connect:1,on_connection_interrupt:7,on_connection_resum:7,on_disconnect:1,on_error:1,on_p:1,on_stream_clos:3,on_stream_error:3,on_stream_ev:3,one:[3,5,6],onli:[1,3,5,6,7],opaqu:[5,6],open:1,oper:[1,2,3,4,5,6,7],option:[1,2,3,4,5,6,7],order:5,org:8,origin:5,other:[3,6,7],otherwis:[1,7],out:5,output:0,over:[1,3,4,6,7],overrid:[1,3,7],ownership:4,packet:7,page:8,page_s:3,pair:[4,5],paramet:[0,1,2,3,4,5,6],partial:6,pass:[1,4,5,6,7],password:[3,7],password_expir:3,path:[3,7],pausecomponentoper:3,pausecomponentrequest:3,pausecomponentrespons:3,payload:[1,3,4,5,6],pem:[4,7],pend:5,pending_activ:4,perform:[2,4,5],ping:[1,7],ping_timeout_m:7,place:7,plain:1,port:[1,2,7],posix_us:3,possibl:1,post_update_ev:3,postcomponentupdateev:3,potenti:6,pre:4,pre_update_ev:3,precomponentupdateev:3,present:6,previou:[6,7],pri_key_byt:7,pri_key_filepath:7,privat:[1,4,7],private_kei:4,process:[1,5,6],project:8,properli:1,properti:[0,5,6],protect:1,protocol:[1,7],protocol_operation_timeout_m:7,prove:4,provid:[1,4,5,6,7],provis:4,proxi:7,pub:6,publish:[4,5,6,7],publish_create_certificate_from_csr:4,publish_create_keys_and_certif:4,publish_delete_named_shadow:6,publish_delete_shadow:6,publish_describe_job_execut:5,publish_get_named_shadow:6,publish_get_pending_job_execut:5,publish_get_shadow:6,publish_messag:3,publish_register_th:4,publish_start_next_pending_job_execut:5,publish_update_job_execut:5,publish_update_named_shadow:6,publish_update_shadow:6,publishmessag:3,publishtoiotcoreoper:3,publishtoiotcorerequest:3,publishtoiotcorerespons:3,publishtotopicoper:3,publishtotopicrequest:3,publishtotopicrespons:3,pypi:8,qo:[3,4,5,6,7],qos1:7,qualiti:[4,5,6],queu:5,queued_at:5,queued_job:5,re:[3,7],reach:7,readi:3,reason:1,receiv:[1,3,4,5,6,7],recheck_after_m:3,recipe_directory_path:3,reconnect:[1,7],reconnect_max_timeout_sec:7,reconnect_min_timeout_sec:7,reflect:[5,6],region:[2,7],registerth:4,registerthingrequest:4,registerthingrespons:4,registerthingsubscriptionrequest:4,registr:4,reject:[4,5,6],rejectederror:5,rejectederrorcod:5,rel:5,rememb:7,remot:[1,5],remov:5,report:6,reportedlifecyclest:3,request:[3,4,5,6,7],request_throttl:5,requeststatu:3,requestthrottl:5,requir:7,reset:5,resourc:1,resource_nam:3,resource_not_found:5,resource_typ:3,resourcenotfound:5,resourcenotfounderror:3,respons:[1,2,3,4,5,6,7],response_cod:2,restart_statu:3,restartcomponentoper:3,restartcomponentrequest:3,restartcomponentrespons:3,resubscribe_existing_top:7,result:[0,1,2,3,4,5,6],resum:7,resumecomponentoper:3,resumecomponentrequest:3,resumecomponentrespons:3,return_cod:7,rewrit:1,root:4,root_component_versions_to_add:3,root_components_to_remov:3,rpc:1,run:5,runtimeerror:1,runwithinfo:3,s:[1,4,5,6],same:1,sdk:7,search:8,second:[3,4,5,6,7],secret_binari:3,secret_id:3,secret_str:3,secret_valu:3,secretvalu:3,section:6,see:[1,3,7],send:[0,1,3,7],sendconfigurationvalidityreportoper:3,sendconfigurationvalidityreportrequest:3,sendconfigurationvalidityreportrespons:3,sent:[3,5,7],sequenc:1,serial:1,serializeerror:1,server:[0,3,4,5,6,7],servic:[0,1,3,4,5,6],serviceerror:3,session:7,session_pres:7,set:[1,3,4,5,6,7],shadow:6,shadow_nam:[3,6],shadowdelta:6,shadowdeltaupdatedev:6,shadowdeltaupdatedsubscriptionrequest:6,shadowmetadata:6,shadowst:6,shadowstatewithdelta:6,shadowupd:6,shadowupdatedev:6,shadowupdatedsnapshot:6,shadowupdatedsubscriptionrequest:6,shape:[1,3],shape_index:[1,3],shape_typ:1,shapeindex:[1,3],share:6,shorter:7,should:[1,3,4,5,6,7],shutdown:1,sign:[4,7],simpl:6,so:[1,6],socket:[1,2,3,7],socket_opt:[1,2],socketopt:[1,2],sourc:7,specifi:[5,6],start:[5,7],started_at:5,startnextjobexecut:5,startnextjobexecutionrespons:5,startnextpendingjobexecut:5,startnextpendingjobexecutionrequest:5,startnextpendingjobexecutionsubscriptionrequest:5,state:[3,5,6],statu:[3,4,5],status_cod:4,status_detail:5,statusdetail:5,step:5,step_timeout_in_minut:5,steptimeoutinminut:5,stop:[0,4,5,6],stop_statu:3,stopcomponentoper:3,stopcomponentrequest:3,stopcomponentrespons:3,store:[5,6,7],str:[0,1,2,3,4,5,6,7],stream:[1,3],stream_handl:[1,3],streamclosederror:1,streamresponsehandl:[1,3],string:[2,5],sub:6,subscrib:[4,5,6],subscribe_to_create_certificate_from_csr_accept:4,subscribe_to_create_certificate_from_csr_reject:4,subscribe_to_create_keys_and_certificate_accept:4,subscribe_to_create_keys_and_certificate_reject:4,subscribe_to_delete_named_shadow_accept:6,subscribe_to_delete_named_shadow_reject:6,subscribe_to_delete_shadow_accept:6,subscribe_to_delete_shadow_reject:6,subscribe_to_describe_job_execution_accept:5,subscribe_to_describe_job_execution_reject:5,subscribe_to_get_named_shadow_accept:6,subscribe_to_get_named_shadow_reject:6,subscribe_to_get_pending_job_executions_accept:5,subscribe_to_get_pending_job_executions_reject:5,subscribe_to_get_shadow_accept:6,subscribe_to_get_shadow_reject:6,subscribe_to_job_executions_changed_ev:5,subscribe_to_named_shadow_delta_updated_ev:6,subscribe_to_named_shadow_updated_ev:6,subscribe_to_next_job_execution_changed_ev:5,subscribe_to_register_thing_accept:4,subscribe_to_register_thing_reject:4,subscribe_to_shadow_delta_updated_ev:6,subscribe_to_shadow_updated_ev:6,subscribe_to_start_next_pending_job_execution_accept:5,subscribe_to_start_next_pending_job_execution_reject:5,subscribe_to_update_job_execution_accept:5,subscribe_to_update_job_execution_reject:5,subscribe_to_update_named_shadow_accept:6,subscribe_to_update_named_shadow_reject:6,subscribe_to_update_shadow_accept:6,subscribe_to_update_shadow_reject:6,subscribetocomponentupdatesoper:3,subscribetocomponentupdatesrequest:3,subscribetocomponentupdatesrespons:3,subscribetocomponentupdatesstreamhandl:3,subscribetoconfigurationupdateoper:3,subscribetoconfigurationupdaterequest:3,subscribetoconfigurationupdaterespons:3,subscribetoconfigurationupdatestreamhandl:3,subscribetoiotcoreoper:3,subscribetoiotcorerequest:3,subscribetoiotcorerespons:3,subscribetoiotcorestreamhandl:3,subscribetotopicoper:3,subscribetotopicrequest:3,subscribetotopicrespons:3,subscribetotopicstreamhandl:3,subscribetovalidateconfigurationupdatesoper:3,subscribetovalidateconfigurationupdatesrequest:3,subscribetovalidateconfigurationupdatesrespons:3,subscribetovalidateconfigurationupdatesstreamhandl:3,subscript:[4,5,6,7],subscriptionresponsemessag:3,subset:5,succe:[1,3],succeed:5,success:[1,2],successfulli:[3,4,5,6,7],support:7,svcuid:3,system:7,system_resource_limit:3,systemresourcelimit:3,t:5,tag:3,take:[4,5,6,7],tcp:7,tcp_connect_timeout_m:7,tell:0,templat:4,template_nam:4,termin:[1,5],terminal_state_reach:5,terminalstatereach:5,text:[1,5,6],than:7,thei:[1,5],thi:[0,1,2,3,4,5,6,7],thing:[2,4,5,6],thing_arn:2,thing_nam:[2,3,4,5,6],thread:1,throttl:5,time:[1,4,5,6,7],timed_out:5,timeout:[3,5,7],timeoutconfig:5,timer:5,timestamp:[3,5,6],tl:[1,2,7],tls_connection_opt:1,tls_context:2,tlsconnectionopt:1,token:[3,4,5,6],top:7,topic:[0,3,4,5,6],topic_nam:3,transform:7,transform_arg:7,transit:5,trust:7,tupl:[4,5,6],two:[4,5,6],type:[0,1,2,3,4,5,6,7],unauthorizederror:3,unchang:5,unexpectedli:7,union:3,uniqu:[4,5,7],unix:[3,7],unless:[1,5],unmappeddataerror:1,unsubscrib:[0,4,5,6,7],until:[3,7],updat:[5,6],updateconfigurationoper:3,updateconfigurationrequest:3,updateconfigurationrespons:3,updatejobexecut:5,updatejobexecutionrequest:5,updatejobexecutionrespons:5,updatejobexecutionsubscriptionrequest:5,updatenamedshadow:6,updatenamedshadowrequest:6,updatenamedshadowsubscriptionrequest:6,updateshadow:6,updateshadowrequest:6,updateshadowrespons:6,updateshadowsubscriptionrequest:6,updatestateoper:3,updatestaterequest:3,updatestaterespons:3,updatethingshadowoper:3,updatethingshadowrequest:3,updatethingshadowrespons:3,us:[0,1,3,4,5,6,7],user:1,usernam:[3,7],utf:5,valid:5,validate_configuration_update_ev:3,validateauthorizationtokenoper:3,validateauthorizationtokenrequest:3,validateauthorizationtokenrespons:3,validateconfigurationupdateev:3,valu:[1,3,4,5,6,7],value_to_merg:3,variabl:3,version:[3,5,6,7],version_id:3,version_mismatch:5,version_numb:5,version_stag:3,versionmismatch:5,via:[1,7],wa:[1,2,5,6,7],wait:[3,7],want:5,websocket:7,websocket_handshake_transform:7,websocket_proxy_opt:7,websockethandshaketransformarg:7,websockets_with_custom_handshak:7,websockets_with_default_aws_sign:7,well:7,were:[5,6,7],when:[0,1,3,4,5,6,7],whenev:[1,5,7],whether:[3,6,7],which:[1,2,3,4,5,6,7],whose:[0,4,5,6],wire:[1,3],within:7,wo:4,would:5,written:[3,7],you:[3,4,5,6],your:5,zero:7},titles:["awsiot","awsiot.eventstreamrpc","awsiot.greengrass_discovery","awsiot.greengrasscoreipc","awsiot.iotidentity","awsiot.iotjobs","awsiot.iotshadow","awsiot.mqtt_connection_builder","AWS IoT Device SDK v2 for Python"],titleterms:{api:8,aw:8,awsiot:[0,1,2,3,4,5,6,7],devic:8,eventstreamrpc:1,greengrass_discoveri:2,greengrasscoreipc:3,indic:8,iot:8,iotident:4,iotjob:5,iotshadow:6,mqtt_connection_build:7,python:8,refer:8,sdk:8,tabl:8,v2:8}}) \ No newline at end of file