awsiot.greengrasscoreipc¶
- awsiot.greengrasscoreipc.connect(*, ipc_socket=None, authtoken=None, lifecycle_handler=None, timeout=10.0)¶
Creates an IPC client and connects to the GreengrassCoreIPC service. When finished with the client, you must call close() to free the client’s native resources.
- Parameters:
ipc_socket (str | None) – Path to the Unix domain socket of Greengrass Nucleus, defaults to environment variable AWS_GG_NUCLEUS_DOMAIN_SOCKET_FILEPATH_FOR_COMPONENT
authtoken (str | None) – Authentication token, defaults to environment variable SVCUID
lifecycle_handler (LifecycleHandler | None) – Handler for events over the course of this network connection. See
awsiot.eventstreamrpc.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.
- Returns:
Client for the GreengrassCoreIPC service.
- Return type:
- class awsiot.greengrasscoreipc.client.AuthorizeClientDeviceActionOperation(stream_handler, shape_index, connection)¶
Bases:
_AuthorizeClientDeviceActionOperation
Create with GreengrassCoreIPCClient.new_authorize_client_device_action()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- activate(request)¶
Activate this operation by sending the initial AuthorizeClientDeviceActionRequest 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 (AuthorizeClientDeviceActionRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of AuthorizeClientDeviceActionResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.CancelLocalDeploymentOperation(stream_handler, shape_index, connection)¶
Bases:
_CancelLocalDeploymentOperation
Create with GreengrassCoreIPCClient.new_cancel_local_deployment()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- activate(request)¶
Activate this operation by sending the initial CancelLocalDeploymentRequest 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 (CancelLocalDeploymentRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of CancelLocalDeploymentResponse, when the initial response is received, or an exception.
- Return type:
concurrent.futures.Future[model.CancelLocalDeploymentResponse]
- 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:
- class awsiot.greengrasscoreipc.client.CreateDebugPasswordOperation(stream_handler, shape_index, connection)¶
Bases:
_CreateDebugPasswordOperation
Create with GreengrassCoreIPCClient.new_create_debug_password()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (CreateDebugPasswordRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of CreateDebugPasswordResponse, when the initial response is received, or an exception.
- Return type:
concurrent.futures.Future[model.CreateDebugPasswordResponse]
- 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:
- class awsiot.greengrasscoreipc.client.CreateLocalDeploymentOperation(stream_handler, shape_index, connection)¶
Bases:
_CreateLocalDeploymentOperation
Create with GreengrassCoreIPCClient.new_create_local_deployment()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- activate(request)¶
Activate this operation by sending the initial CreateLocalDeploymentRequest 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 (CreateLocalDeploymentRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of CreateLocalDeploymentResponse, when the initial response is received, or an exception.
- Return type:
concurrent.futures.Future[model.CreateLocalDeploymentResponse]
- 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:
- class awsiot.greengrasscoreipc.client.DeferComponentUpdateOperation(stream_handler, shape_index, connection)¶
Bases:
_DeferComponentUpdateOperation
Create with GreengrassCoreIPCClient.new_defer_component_update()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (DeferComponentUpdateRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of DeferComponentUpdateResponse, when the initial response is received, or an exception.
- Return type:
concurrent.futures.Future[model.DeferComponentUpdateResponse]
- 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:
- class awsiot.greengrasscoreipc.client.DeleteThingShadowOperation(stream_handler, shape_index, connection)¶
Bases:
_DeleteThingShadowOperation
Create with GreengrassCoreIPCClient.new_delete_thing_shadow()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (DeleteThingShadowRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of DeleteThingShadowResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.GetClientDeviceAuthTokenOperation(stream_handler, shape_index, connection)¶
Bases:
_GetClientDeviceAuthTokenOperation
Create with GreengrassCoreIPCClient.new_get_client_device_auth_token()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- activate(request)¶
Activate this operation by sending the initial GetClientDeviceAuthTokenRequest 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 (GetClientDeviceAuthTokenRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of GetClientDeviceAuthTokenResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.GetComponentDetailsOperation(stream_handler, shape_index, connection)¶
Bases:
_GetComponentDetailsOperation
Create with GreengrassCoreIPCClient.new_get_component_details()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (GetComponentDetailsRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of GetComponentDetailsResponse, when the initial response is received, or an exception.
- Return type:
concurrent.futures.Future[model.GetComponentDetailsResponse]
- 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:
- class awsiot.greengrasscoreipc.client.GetConfigurationOperation(stream_handler, shape_index, connection)¶
Bases:
_GetConfigurationOperation
Create with GreengrassCoreIPCClient.new_get_configuration()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (GetConfigurationRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of GetConfigurationResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.GetLocalDeploymentStatusOperation(stream_handler, shape_index, connection)¶
Bases:
_GetLocalDeploymentStatusOperation
Create with GreengrassCoreIPCClient.new_get_local_deployment_status()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (GetLocalDeploymentStatusRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of GetLocalDeploymentStatusResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.GetSecretValueOperation(stream_handler, shape_index, connection)¶
Bases:
_GetSecretValueOperation
Create with GreengrassCoreIPCClient.new_get_secret_value()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (GetSecretValueRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of GetSecretValueResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.GetThingShadowOperation(stream_handler, shape_index, connection)¶
Bases:
_GetThingShadowOperation
Create with GreengrassCoreIPCClient.new_get_thing_shadow()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (GetThingShadowRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of GetThingShadowResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.ListComponentsOperation(stream_handler, shape_index, connection)¶
Bases:
_ListComponentsOperation
Create with GreengrassCoreIPCClient.new_list_components()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (ListComponentsRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of ListComponentsResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.ListLocalDeploymentsOperation(stream_handler, shape_index, connection)¶
Bases:
_ListLocalDeploymentsOperation
Create with GreengrassCoreIPCClient.new_list_local_deployments()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (ListLocalDeploymentsRequest) –
- Return type:
- 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.Future[model.ListLocalDeploymentsResponse]
- 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:
- class awsiot.greengrasscoreipc.client.ListNamedShadowsForThingOperation(stream_handler, shape_index, connection)¶
Bases:
_ListNamedShadowsForThingOperation
Create with GreengrassCoreIPCClient.new_list_named_shadows_for_thing()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (ListNamedShadowsForThingRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of ListNamedShadowsForThingResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.PauseComponentOperation(stream_handler, shape_index, connection)¶
Bases:
_PauseComponentOperation
Create with GreengrassCoreIPCClient.new_pause_component()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (PauseComponentRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of PauseComponentResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.PublishToIoTCoreOperation(stream_handler, shape_index, connection)¶
Bases:
_PublishToIoTCoreOperation
Create with GreengrassCoreIPCClient.new_publish_to_iot_core()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- activate(request)¶
Activate this operation by sending the initial PublishToIoTCoreRequest 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 (PublishToIoTCoreRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of PublishToIoTCoreResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.PublishToTopicOperation(stream_handler, shape_index, connection)¶
Bases:
_PublishToTopicOperation
Create with GreengrassCoreIPCClient.new_publish_to_topic()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (PublishToTopicRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of PublishToTopicResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.PutComponentMetricOperation(stream_handler, shape_index, connection)¶
Bases:
_PutComponentMetricOperation
Create with GreengrassCoreIPCClient.new_put_component_metric()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- activate(request)¶
Activate this operation by sending the initial PutComponentMetricRequest 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 (PutComponentMetricRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of PutComponentMetricResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.RestartComponentOperation(stream_handler, shape_index, connection)¶
Bases:
_RestartComponentOperation
Create with GreengrassCoreIPCClient.new_restart_component()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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:
request (RestartComponentRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of RestartComponentResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.ResumeComponentOperation(stream_handler, shape_index, connection)¶
Bases:
_ResumeComponentOperation
Create with GreengrassCoreIPCClient.new_resume_component()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (ResumeComponentRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of ResumeComponentResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.SendConfigurationValidityReportOperation(stream_handler, shape_index, connection)¶
Bases:
_SendConfigurationValidityReportOperation
Create with GreengrassCoreIPCClient.new_send_configuration_validity_report()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (SendConfigurationValidityReportRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of SendConfigurationValidityReportResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.StopComponentOperation(stream_handler, shape_index, connection)¶
Bases:
_StopComponentOperation
Create with GreengrassCoreIPCClient.new_stop_component()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (StopComponentRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of StopComponentResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.SubscribeToCertificateUpdatesStreamHandler¶
Bases:
StreamResponseHandler
Event handler for SubscribeToCertificateUpdatesOperation
Inherit from this class and override methods to handle stream events during a SubscribeToCertificateUpdatesOperation.
- on_stream_event(event)¶
Invoked when a CertificateUpdateEvent is received.
- Parameters:
event (CertificateUpdateEvent) –
- 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,
- on_stream_closed()¶
Invoked when the stream for this operation is closed.
- Return type:
None
- class awsiot.greengrasscoreipc.client.SubscribeToCertificateUpdatesOperation(stream_handler, shape_index, connection)¶
Bases:
_SubscribeToCertificateUpdatesOperation
Create with GreengrassCoreIPCClient.new_subscribe_to_certificate_updates()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- activate(request)¶
Activate this operation by sending the initial SubscribeToCertificateUpdatesRequest 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 (SubscribeToCertificateUpdatesRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of SubscribeToCertificateUpdatesResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.SubscribeToComponentUpdatesStreamHandler¶
Bases:
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 (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,
- 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:
_SubscribeToComponentUpdatesOperation
Create with GreengrassCoreIPCClient.new_subscribe_to_component_updates()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (SubscribeToComponentUpdatesRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of SubscribeToComponentUpdatesResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.SubscribeToConfigurationUpdateStreamHandler¶
Bases:
StreamResponseHandler
Event handler for SubscribeToConfigurationUpdateOperation
Inherit from this class and override methods to handle stream events during a SubscribeToConfigurationUpdateOperation.
- on_stream_event(event)¶
Invoked when a ConfigurationUpdateEvents is received.
- Parameters:
event (ConfigurationUpdateEvents) –
- 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,
- on_stream_closed()¶
Invoked when the stream for this operation is closed.
- Return type:
None
- class awsiot.greengrasscoreipc.client.SubscribeToConfigurationUpdateOperation(stream_handler, shape_index, connection)¶
Bases:
_SubscribeToConfigurationUpdateOperation
Create with GreengrassCoreIPCClient.new_subscribe_to_configuration_update()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- activate(request)¶
Activate this operation by sending the initial SubscribeToConfigurationUpdateRequest 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 (SubscribeToConfigurationUpdateRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of SubscribeToConfigurationUpdateResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.SubscribeToIoTCoreStreamHandler¶
Bases:
StreamResponseHandler
Event handler for SubscribeToIoTCoreOperation
Inherit from this class and override methods to handle stream events during a SubscribeToIoTCoreOperation.
- on_stream_event(event)¶
Invoked when a IoTCoreMessage is received.
- Parameters:
event (IoTCoreMessage) –
- 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,
- on_stream_closed()¶
Invoked when the stream for this operation is closed.
- Return type:
None
- class awsiot.greengrasscoreipc.client.SubscribeToIoTCoreOperation(stream_handler, shape_index, connection)¶
Bases:
_SubscribeToIoTCoreOperation
Create with GreengrassCoreIPCClient.new_subscribe_to_iot_core()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- activate(request)¶
Activate this operation by sending the initial SubscribeToIoTCoreRequest 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 (SubscribeToIoTCoreRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of SubscribeToIoTCoreResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.SubscribeToTopicStreamHandler¶
Bases:
StreamResponseHandler
Event handler for SubscribeToTopicOperation
Inherit from this class and override methods to handle stream events during a SubscribeToTopicOperation.
- on_stream_event(event)¶
Invoked when a SubscriptionResponseMessage is received.
- Parameters:
event (SubscriptionResponseMessage) –
- 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,
- on_stream_closed()¶
Invoked when the stream for this operation is closed.
- Return type:
None
- class awsiot.greengrasscoreipc.client.SubscribeToTopicOperation(stream_handler, shape_index, connection)¶
Bases:
_SubscribeToTopicOperation
Create with GreengrassCoreIPCClient.new_subscribe_to_topic()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (SubscribeToTopicRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of SubscribeToTopicResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesStreamHandler¶
Bases:
StreamResponseHandler
Event handler for SubscribeToValidateConfigurationUpdatesOperation
Inherit from this class and override methods to handle stream events during a SubscribeToValidateConfigurationUpdatesOperation.
- on_stream_event(event)¶
Invoked when a ValidateConfigurationUpdateEvents is received.
- Parameters:
event (ValidateConfigurationUpdateEvents) –
- 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,
- on_stream_closed()¶
Invoked when the stream for this operation is closed.
- Return type:
None
- class awsiot.greengrasscoreipc.client.SubscribeToValidateConfigurationUpdatesOperation(stream_handler, shape_index, connection)¶
Bases:
_SubscribeToValidateConfigurationUpdatesOperation
Create with GreengrassCoreIPCClient.new_subscribe_to_validate_configuration_updates()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (SubscribeToValidateConfigurationUpdatesRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of SubscribeToValidateConfigurationUpdatesResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.UpdateConfigurationOperation(stream_handler, shape_index, connection)¶
Bases:
_UpdateConfigurationOperation
Create with GreengrassCoreIPCClient.new_update_configuration()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (UpdateConfigurationRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of UpdateConfigurationResponse, when the initial response is received, or an exception.
- Return type:
concurrent.futures.Future[model.UpdateConfigurationResponse]
- 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:
- class awsiot.greengrasscoreipc.client.UpdateStateOperation(stream_handler, shape_index, connection)¶
Bases:
_UpdateStateOperation
Create with GreengrassCoreIPCClient.new_update_state()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (UpdateStateRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of UpdateStateResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.UpdateThingShadowOperation(stream_handler, shape_index, connection)¶
Bases:
_UpdateThingShadowOperation
Create with GreengrassCoreIPCClient.new_update_thing_shadow()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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:
request (UpdateThingShadowRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of UpdateThingShadowResponse, when the initial response is received, or an exception.
- Return type:
- 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:
- class awsiot.greengrasscoreipc.client.ValidateAuthorizationTokenOperation(stream_handler, shape_index, connection)¶
Bases:
_ValidateAuthorizationTokenOperation
Create with GreengrassCoreIPCClient.new_validate_authorization_token()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- 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 (ValidateAuthorizationTokenRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of ValidateAuthorizationTokenResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.VerifyClientDeviceIdentityOperation(stream_handler, shape_index, connection)¶
Bases:
_VerifyClientDeviceIdentityOperation
Create with GreengrassCoreIPCClient.new_verify_client_device_identity()
- Parameters:
stream_handler (StreamResponseHandler) –
shape_index (ShapeIndex) –
connection (Connection) –
- activate(request)¶
Activate this operation by sending the initial VerifyClientDeviceIdentityRequest 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 (VerifyClientDeviceIdentityRequest) –
- Return type:
- get_response()¶
Returns a Future which completes with a result of VerifyClientDeviceIdentityResponse, when the initial response is received, or an exception.
- 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:
- class awsiot.greengrasscoreipc.client.GreengrassCoreIPCClient(connection)¶
Bases:
Client
Client for the GreengrassCoreIPC service. When finished with the client, you must call close() to free the client’s native resources.
There is a new V2 client which should be preferred. See the GreengrassCoreIPCClientV2 class in the clientv2 subpackage.
- Parameters:
connection (Connection) – Connection that this client will use.
- new_authorize_client_device_action()¶
Create a new AuthorizeClientDeviceActionOperation.
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:
- new_cancel_local_deployment()¶
Create a new CancelLocalDeploymentOperation.
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:
- new_create_debug_password()¶
Create a new CreateDebugPasswordOperation.
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:
- new_create_local_deployment()¶
Create a new CreateLocalDeploymentOperation.
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:
- 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:
- 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:
- new_get_client_device_auth_token()¶
Create a new GetClientDeviceAuthTokenOperation.
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:
- 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:
- 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:
- new_get_local_deployment_status()¶
Create a new GetLocalDeploymentStatusOperation.
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:
- new_get_secret_value()¶
Create a new GetSecretValueOperation.
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:
- 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:
- new_list_components()¶
Create a new ListComponentsOperation.
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:
- new_list_local_deployments()¶
Create a new ListLocalDeploymentsOperation.
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:
- 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:
- 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:
- new_publish_to_iot_core()¶
Create a new PublishToIoTCoreOperation.
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:
- 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:
- new_put_component_metric()¶
Create a new PutComponentMetricOperation.
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:
- new_restart_component()¶
Create a new RestartComponentOperation.
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:
- 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:
- new_send_configuration_validity_report()¶
Create a new SendConfigurationValidityReportOperation.
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:
- new_stop_component()¶
Create a new StopComponentOperation.
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:
- new_subscribe_to_certificate_updates(stream_handler)¶
Create a new SubscribeToCertificateUpdatesOperation.
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 (SubscribeToCertificateUpdatesStreamHandler) – Methods on this object will be called as stream events happen on this operation.
- Return type:
- new_subscribe_to_component_updates(stream_handler)¶
Create a new SubscribeToComponentUpdatesOperation.
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 (SubscribeToComponentUpdatesStreamHandler) – Methods on this object will be called as stream events happen on this operation.
- Return type:
- new_subscribe_to_configuration_update(stream_handler)¶
Create a new SubscribeToConfigurationUpdateOperation.
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 (SubscribeToConfigurationUpdateStreamHandler) – Methods on this object will be called as stream events happen on this operation.
- Return type:
- new_subscribe_to_iot_core(stream_handler)¶
Create a new SubscribeToIoTCoreOperation.
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 (SubscribeToIoTCoreStreamHandler) – Methods on this object will be called as stream events happen on this operation.
- Return type:
- 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 (SubscribeToTopicStreamHandler) – Methods on this object will be called as stream events happen on this operation.
- Return type:
- 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 (SubscribeToValidateConfigurationUpdatesStreamHandler) – Methods on this object will be called as stream events happen on this operation.
- Return type:
- 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.
- Return type:
- new_update_state()¶
Create a new UpdateStateOperation.
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:
- 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:
- new_validate_authorization_token()¶
Create a new ValidateAuthorizationTokenOperation.
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:
- new_verify_client_device_identity()¶
Create a new VerifyClientDeviceIdentityOperation.
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:
- class awsiot.greengrasscoreipc.clientv2.GreengrassCoreIPCClientV2(client=None, executor=True)¶
Bases:
object
V2 client for the GreengrassCoreIPC service. When finished with the client, you must call close() to free the client’s native resources.
- Parameters:
client (GreengrassCoreIPCClient | None) – Connection that this client will use. If you do not provide one, it will be made automatically.
executor (Executor | None) – Executor used to run on_stream_event and on_stream_closed callbacks to avoid blocking the networking thread. By default, a ThreadPoolExecutor will be created and used. Use None to run callbacks in the networking thread, but understand that your code can deadlock the networking thread if it performs a synchronous network call.
- close(*, executor_wait=True)¶
Close the underlying connection and shutdown the event executor (if any)
- Parameters:
executor_wait – If true (default), then this method will block until the executor finishes running all tasks and shuts down.
- Returns:
The future which will complete when the shutdown process is done. The future will have an exception if shutdown was caused by an error, or a result of None if the shutdown was clean and user-initiated.
- Return type:
Future
- authorize_client_device_action(*, client_device_auth_token=None, operation=None, resource=None)¶
Perform the AuthorizeClientDeviceAction operation synchronously.
- Parameters:
- Return type:
- authorize_client_device_action_async(*, client_device_auth_token=None, operation=None, resource=None)¶
Perform the AuthorizeClientDeviceAction operation asynchronously.
- Parameters:
- Return type:
concurrent.futures.Future[model.AuthorizeClientDeviceActionResponse]
- cancel_local_deployment(*, deployment_id=None)¶
Perform the CancelLocalDeployment operation synchronously.
- Parameters:
deployment_id (str | None) –
- Return type:
- cancel_local_deployment_async(*, deployment_id=None)¶
Perform the CancelLocalDeployment operation asynchronously.
- Parameters:
deployment_id (str | None) –
- Return type:
concurrent.futures.Future[model.CancelLocalDeploymentResponse]
- create_debug_password()¶
Perform the CreateDebugPassword operation synchronously.
- Return type:
- create_debug_password_async()¶
Perform the CreateDebugPassword operation asynchronously.
- Return type:
concurrent.futures.Future[model.CreateDebugPasswordResponse]
- create_local_deployment(*, 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, failure_handling_policy=None)¶
Perform the CreateLocalDeployment operation synchronously.
- Parameters:
- Return type:
- create_local_deployment_async(*, 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, failure_handling_policy=None)¶
Perform the CreateLocalDeployment operation asynchronously.
- Parameters:
- Return type:
concurrent.futures.Future[model.CreateLocalDeploymentResponse]
- defer_component_update(*, deployment_id=None, message=None, recheck_after_ms=None)¶
Perform the DeferComponentUpdate operation synchronously.
- Parameters:
- Return type:
- defer_component_update_async(*, deployment_id=None, message=None, recheck_after_ms=None)¶
Perform the DeferComponentUpdate operation asynchronously.
- Parameters:
- Return type:
concurrent.futures.Future[model.DeferComponentUpdateResponse]
- delete_thing_shadow(*, thing_name=None, shadow_name=None)¶
Perform the DeleteThingShadow operation synchronously.
- Parameters:
- Return type:
- delete_thing_shadow_async(*, thing_name=None, shadow_name=None)¶
Perform the DeleteThingShadow operation asynchronously.
- Parameters:
- Return type:
- get_client_device_auth_token(*, credential=None)¶
Perform the GetClientDeviceAuthToken operation synchronously.
- Parameters:
credential (CredentialDocument | None) –
- Return type:
- get_client_device_auth_token_async(*, credential=None)¶
Perform the GetClientDeviceAuthToken operation asynchronously.
- Parameters:
credential (CredentialDocument | None) –
- Return type:
concurrent.futures.Future[model.GetClientDeviceAuthTokenResponse]
- get_component_details(*, component_name=None)¶
Perform the GetComponentDetails operation synchronously.
- Parameters:
component_name (str | None) –
- Return type:
- get_component_details_async(*, component_name=None)¶
Perform the GetComponentDetails operation asynchronously.
- Parameters:
component_name (str | None) –
- Return type:
concurrent.futures.Future[model.GetComponentDetailsResponse]
- get_configuration(*, component_name=None, key_path=None)¶
Perform the GetConfiguration operation synchronously.
- Parameters:
- Return type:
- get_configuration_async(*, component_name=None, key_path=None)¶
Perform the GetConfiguration operation asynchronously.
- Parameters:
- Return type:
- get_local_deployment_status(*, deployment_id=None)¶
Perform the GetLocalDeploymentStatus operation synchronously.
- Parameters:
deployment_id (str | None) –
- Return type:
- get_local_deployment_status_async(*, deployment_id=None)¶
Perform the GetLocalDeploymentStatus operation asynchronously.
- Parameters:
deployment_id (str | None) –
- Return type:
concurrent.futures.Future[model.GetLocalDeploymentStatusResponse]
- get_secret_value(*, secret_id=None, version_id=None, version_stage=None, refresh=None)¶
Perform the GetSecretValue operation synchronously.
- Parameters:
- Return type:
- get_secret_value_async(*, secret_id=None, version_id=None, version_stage=None, refresh=None)¶
Perform the GetSecretValue operation asynchronously.
- Parameters:
- Return type:
- get_thing_shadow(*, thing_name=None, shadow_name=None)¶
Perform the GetThingShadow operation synchronously.
- Parameters:
- Return type:
- get_thing_shadow_async(*, thing_name=None, shadow_name=None)¶
Perform the GetThingShadow operation asynchronously.
- Parameters:
- Return type:
- list_components()¶
Perform the ListComponents operation synchronously.
- Return type:
- list_components_async()¶
Perform the ListComponents operation asynchronously.
- Return type:
- list_local_deployments()¶
Perform the ListLocalDeployments operation synchronously.
- Return type:
- list_local_deployments_async()¶
Perform the ListLocalDeployments operation asynchronously.
- Return type:
concurrent.futures.Future[model.ListLocalDeploymentsResponse]
- list_named_shadows_for_thing(*, thing_name=None, next_token=None, page_size=None)¶
Perform the ListNamedShadowsForThing operation synchronously.
- Parameters:
- Return type:
- list_named_shadows_for_thing_async(*, thing_name=None, next_token=None, page_size=None)¶
Perform the ListNamedShadowsForThing operation asynchronously.
- Parameters:
- Return type:
concurrent.futures.Future[model.ListNamedShadowsForThingResponse]
- pause_component(*, component_name=None)¶
Perform the PauseComponent operation synchronously.
- Parameters:
component_name (str | None) –
- Return type:
- pause_component_async(*, component_name=None)¶
Perform the PauseComponent operation asynchronously.
- Parameters:
component_name (str | None) –
- Return type:
- publish_to_iot_core(*, topic_name=None, qos=None, payload=None, retain=None, user_properties=None, message_expiry_interval_seconds=None, correlation_data=None, response_topic=None, payload_format=None, content_type=None)¶
Perform the PublishToIoTCore operation synchronously.
- Parameters:
- Return type:
- publish_to_iot_core_async(*, topic_name=None, qos=None, payload=None, retain=None, user_properties=None, message_expiry_interval_seconds=None, correlation_data=None, response_topic=None, payload_format=None, content_type=None)¶
Perform the PublishToIoTCore operation asynchronously.
- Parameters:
- Return type:
- publish_to_topic(*, topic=None, publish_message=None)¶
Perform the PublishToTopic operation synchronously.
- Parameters:
topic (str | None) –
publish_message (PublishMessage | None) –
- Return type:
- publish_to_topic_async(*, topic=None, publish_message=None)¶
Perform the PublishToTopic operation asynchronously.
- Parameters:
topic (str | None) –
publish_message (PublishMessage | None) –
- Return type:
- put_component_metric(*, metrics=None)¶
Perform the PutComponentMetric operation synchronously.
- Parameters:
- Return type:
- put_component_metric_async(*, metrics=None)¶
Perform the PutComponentMetric operation asynchronously.
- Parameters:
- Return type:
- restart_component(*, component_name=None)¶
Perform the RestartComponent operation synchronously.
- Parameters:
component_name (str | None) –
- Return type:
- restart_component_async(*, component_name=None)¶
Perform the RestartComponent operation asynchronously.
- Parameters:
component_name (str | None) –
- Return type:
- resume_component(*, component_name=None)¶
Perform the ResumeComponent operation synchronously.
- Parameters:
component_name (str | None) –
- Return type:
- resume_component_async(*, component_name=None)¶
Perform the ResumeComponent operation asynchronously.
- Parameters:
component_name (str | None) –
- Return type:
- send_configuration_validity_report(*, configuration_validity_report=None)¶
Perform the SendConfigurationValidityReport operation synchronously.
- Parameters:
configuration_validity_report (ConfigurationValidityReport | None) –
- Return type:
- send_configuration_validity_report_async(*, configuration_validity_report=None)¶
Perform the SendConfigurationValidityReport operation asynchronously.
- Parameters:
configuration_validity_report (ConfigurationValidityReport | None) –
- Return type:
concurrent.futures.Future[model.SendConfigurationValidityReportResponse]
- stop_component(*, component_name=None)¶
Perform the StopComponent operation synchronously.
- Parameters:
component_name (str | None) –
- Return type:
- stop_component_async(*, component_name=None)¶
Perform the StopComponent operation asynchronously.
- Parameters:
component_name (str | None) –
- Return type:
- subscribe_to_certificate_updates(*, certificate_options=None, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToCertificateUpdates operation synchronously. The initial response or error will be returned synchronously, further events will arrive via the streaming callbacks
- Parameters:
certificate_options (CertificateOptions | None) –
stream_handler (SubscribeToCertificateUpdatesStreamHandler | None) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[CertificateUpdateEvent], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[SubscribeToCertificateUpdatesResponse, SubscribeToCertificateUpdatesOperation]
- subscribe_to_certificate_updates_async(*, certificate_options=None, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToCertificateUpdates operation asynchronously. The initial response or error will be returned as the result of the asynchronous future, further events will arrive via the streaming callbacks
- Parameters:
certificate_options (CertificateOptions | None) –
stream_handler (SubscribeToCertificateUpdatesStreamHandler) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[CertificateUpdateEvent], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[concurrent.futures.Future[model.SubscribeToCertificateUpdatesResponse], client.SubscribeToCertificateUpdatesOperation]
- subscribe_to_component_updates(*, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToComponentUpdates operation synchronously. The initial response or error will be returned synchronously, further events will arrive via the streaming callbacks
- Parameters:
stream_handler (SubscribeToComponentUpdatesStreamHandler | None) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[ComponentUpdatePolicyEvents], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[SubscribeToComponentUpdatesResponse, SubscribeToComponentUpdatesOperation]
- subscribe_to_component_updates_async(*, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToComponentUpdates operation asynchronously. The initial response or error will be returned as the result of the asynchronous future, further events will arrive via the streaming callbacks
- Parameters:
stream_handler (SubscribeToComponentUpdatesStreamHandler) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[ComponentUpdatePolicyEvents], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[concurrent.futures.Future[model.SubscribeToComponentUpdatesResponse], client.SubscribeToComponentUpdatesOperation]
- subscribe_to_configuration_update(*, component_name=None, key_path=None, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToConfigurationUpdate operation synchronously. The initial response or error will be returned synchronously, further events will arrive via the streaming callbacks
- Parameters:
component_name (str | None) –
stream_handler (SubscribeToConfigurationUpdateStreamHandler | None) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[ConfigurationUpdateEvents], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[SubscribeToConfigurationUpdateResponse, SubscribeToConfigurationUpdateOperation]
- subscribe_to_configuration_update_async(*, component_name=None, key_path=None, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToConfigurationUpdate operation asynchronously. The initial response or error will be returned as the result of the asynchronous future, further events will arrive via the streaming callbacks
- Parameters:
component_name (str | None) –
stream_handler (SubscribeToConfigurationUpdateStreamHandler) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[ConfigurationUpdateEvents], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[concurrent.futures.Future[model.SubscribeToConfigurationUpdateResponse], client.SubscribeToConfigurationUpdateOperation]
- subscribe_to_iot_core(*, topic_name=None, qos=None, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToIoTCore operation synchronously. The initial response or error will be returned synchronously, further events will arrive via the streaming callbacks
- Parameters:
topic_name (str | None) –
qos (str | None) – QOS enum value
stream_handler (SubscribeToIoTCoreStreamHandler | None) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[IoTCoreMessage], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[SubscribeToIoTCoreResponse, SubscribeToIoTCoreOperation]
- subscribe_to_iot_core_async(*, topic_name=None, qos=None, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToIoTCore operation asynchronously. The initial response or error will be returned as the result of the asynchronous future, further events will arrive via the streaming callbacks
- Parameters:
topic_name (str | None) –
qos (str | None) – QOS enum value
stream_handler (SubscribeToIoTCoreStreamHandler) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[IoTCoreMessage], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[concurrent.futures.Future[model.SubscribeToIoTCoreResponse], client.SubscribeToIoTCoreOperation]
- subscribe_to_topic(*, topic=None, receive_mode=None, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToTopic operation synchronously. The initial response or error will be returned synchronously, further events will arrive via the streaming callbacks
- Parameters:
topic (str | None) –
receive_mode (str | None) – ReceiveMode enum value
stream_handler (SubscribeToTopicStreamHandler | None) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[SubscriptionResponseMessage], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
- subscribe_to_topic_async(*, topic=None, receive_mode=None, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToTopic operation asynchronously. The initial response or error will be returned as the result of the asynchronous future, further events will arrive via the streaming callbacks
- Parameters:
topic (str | None) –
receive_mode (str | None) – ReceiveMode enum value
stream_handler (SubscribeToTopicStreamHandler) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[SubscriptionResponseMessage], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[concurrent.futures.Future[model.SubscribeToTopicResponse], client.SubscribeToTopicOperation]
- subscribe_to_validate_configuration_updates(*, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToValidateConfigurationUpdates operation synchronously. The initial response or error will be returned synchronously, further events will arrive via the streaming callbacks
- Parameters:
stream_handler (SubscribeToValidateConfigurationUpdatesStreamHandler | None) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[ValidateConfigurationUpdateEvents], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[SubscribeToValidateConfigurationUpdatesResponse, SubscribeToValidateConfigurationUpdatesOperation]
- subscribe_to_validate_configuration_updates_async(*, stream_handler=None, on_stream_event=None, on_stream_error=None, on_stream_closed=None)¶
Perform the SubscribeToValidateConfigurationUpdates operation asynchronously. The initial response or error will be returned as the result of the asynchronous future, further events will arrive via the streaming callbacks
- Parameters:
stream_handler (SubscribeToValidateConfigurationUpdatesStreamHandler) – Methods on this object will be called as stream events happen on this operation. If an executor is provided, the on_stream_event and on_stream_closed methods will run in the executor.
on_stream_event (Callable[[ValidateConfigurationUpdateEvents], None] | None) – Callback for stream events. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
on_stream_error (Callable[[Exception], bool] | None) – Callback for stream errors. Return true to close the stream, return false to keep the stream open. Mutually exclusive with stream_handler. Even if an executor is provided, this method will not run in the executor.
on_stream_closed (Callable[[], None] | None) – Callback for when the stream closes. Mutually exclusive with stream_handler. If an executor is provided, this method will run in the executor.
- Return type:
Tuple[concurrent.futures.Future[model.SubscribeToValidateConfigurationUpdatesResponse], client.SubscribeToValidateConfigurationUpdatesOperation]
- update_configuration(*, key_path=None, timestamp=None, value_to_merge=None)¶
Perform the UpdateConfiguration operation synchronously.
- update_configuration_async(*, key_path=None, timestamp=None, value_to_merge=None)¶
Perform the UpdateConfiguration operation asynchronously.
- Parameters:
- Return type:
concurrent.futures.Future[model.UpdateConfigurationResponse]
- update_state(*, state=None)¶
Perform the UpdateState operation synchronously.
- Parameters:
state (str | None) – ReportedLifecycleState enum value
- Return type:
- update_state_async(*, state=None)¶
Perform the UpdateState operation asynchronously.
- Parameters:
state (str | None) – ReportedLifecycleState enum value
- Return type:
- update_thing_shadow(*, thing_name=None, shadow_name=None, payload=None)¶
Perform the UpdateThingShadow operation synchronously.
- Parameters:
- Return type:
- update_thing_shadow_async(*, thing_name=None, shadow_name=None, payload=None)¶
Perform the UpdateThingShadow operation asynchronously.
- Parameters:
- Return type:
- validate_authorization_token(*, token=None)¶
Perform the ValidateAuthorizationToken operation synchronously.
- Parameters:
token (str | None) –
- Return type:
- validate_authorization_token_async(*, token=None)¶
Perform the ValidateAuthorizationToken operation asynchronously.
- Parameters:
token (str | None) –
- Return type:
concurrent.futures.Future[model.ValidateAuthorizationTokenResponse]
- verify_client_device_identity(*, credential=None)¶
Perform the VerifyClientDeviceIdentity operation synchronously.
- Parameters:
credential (ClientDeviceCredential | None) –
- Return type:
- verify_client_device_identity_async(*, credential=None)¶
Perform the VerifyClientDeviceIdentity operation asynchronously.
- Parameters:
credential (ClientDeviceCredential | None) –
- Return type:
concurrent.futures.Future[model.VerifyClientDeviceIdentityResponse]
- exception awsiot.greengrasscoreipc.model.GreengrassCoreIPCError¶
Bases:
ErrorShape
Base for all error messages sent by server.
- class awsiot.greengrasscoreipc.model.DetailedDeploymentStatus¶
Bases:
object
DetailedDeploymentStatus enum
- class awsiot.greengrasscoreipc.model.UserProperty(*, key=None, value=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- key¶
- value¶
- class awsiot.greengrasscoreipc.model.SystemResourceLimits(*, memory=None, cpus=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
memory – (Optional) The maximum amount of RAM (in kilobytes) that this component’s processes can use on the core device.
cpus – (Optional) The maximum amount of CPU time that this component’s processes can use on the core device.
- Parameters:
- memory¶
(Optional) The maximum amount of RAM (in kilobytes) that this component’s processes can use on the core device.
- cpus¶
(Optional) The maximum amount of CPU time that this component’s processes can use on the core device.
- class awsiot.greengrasscoreipc.model.DeploymentStatusDetails(*, detailed_deployment_status=None, deployment_error_stack=None, deployment_error_types=None, deployment_failure_cause=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
detailed_deployment_status – DetailedDeploymentStatus enum value. The detailed deployment status of the local deployment.
deployment_error_stack – (Optional) The list of local deployment errors
deployment_error_types – (Optional) The list of local deployment error types
deployment_failure_cause – (Optional) The cause of local deployment failure
- Parameters:
- detailed_deployment_status¶
DetailedDeploymentStatus enum value. The detailed deployment status of the local deployment.
- deployment_error_stack¶
(Optional) The list of local deployment errors
- deployment_error_types¶
(Optional) The list of local deployment error types
- deployment_failure_cause¶
(Optional) The cause of local deployment failure
- class awsiot.greengrasscoreipc.model.MessageContext(*, topic=None)¶
Bases:
Shape
Contextual information about the message. NOTE The context is ignored if used in PublishMessage.
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
topic – The topic where the message was published.
- Parameters:
topic (str | None) –
- topic¶
The topic where the message was published.
- class awsiot.greengrasscoreipc.model.RunWithInfo(*, posix_user=None, windows_user=None, system_resource_limits=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
posix_user – (Optional) The POSIX system user and, optionally, group to use to run this component on Linux core devices.
windows_user – (Optional) The Windows user to use to run this component on Windows core devices.
system_resource_limits – (Optional) The system resource limits to apply to this component’s processes.
- Parameters:
posix_user (str | None) –
windows_user (str | None) –
system_resource_limits (SystemResourceLimits | None) –
- posix_user¶
(Optional) The POSIX system user and, optionally, group to use to run this component on Linux core devices.
- windows_user¶
(Optional) The Windows user to use to run this component on Windows core devices.
- system_resource_limits¶
(Optional) The system resource limits to apply to this component’s processes.
- class awsiot.greengrasscoreipc.model.LocalDeployment(*, deployment_id=None, status=None, created_on=None, deployment_status_details=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
deployment_id – The ID of the local deployment.
status – DeploymentStatus enum value. The status of the local deployment.
created_on – (Optional) The timestamp at which the local deployment was created in MM/dd/yyyy hh:mm:ss format
deployment_status_details – (Optional) The status details of the local deployment.
- Parameters:
deployment_id (str | None) –
status (str | None) –
created_on (str | None) –
deployment_status_details (DeploymentStatusDetails | None) –
- deployment_id¶
The ID of the local deployment.
- status¶
DeploymentStatus enum value. The status of the local deployment.
- created_on¶
(Optional) The timestamp at which the local deployment was created in MM/dd/yyyy hh:mm:ss format
- deployment_status_details¶
(Optional) The status details of the local deployment.
- class awsiot.greengrasscoreipc.model.PostComponentUpdateEvent(*, deployment_id=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
deployment_id – The ID of the AWS IoT Greengrass deployment that updated the component.
- Parameters:
deployment_id (str | None) –
- deployment_id¶
The ID of the AWS IoT Greengrass deployment that updated the component.
- class awsiot.greengrasscoreipc.model.PreComponentUpdateEvent(*, deployment_id=None, is_ggc_restarting=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
deployment_id – The ID of the AWS IoT Greengrass deployment that updates the component.
is_ggc_restarting – Whether or not Greengrass needs to restart to apply the update.
- Parameters:
- deployment_id¶
The ID of the AWS IoT Greengrass deployment that updates the component.
- is_ggc_restarting¶
Whether or not Greengrass needs to restart to apply the update.
- class awsiot.greengrasscoreipc.model.ConfigurationValidityStatus¶
Bases:
object
ConfigurationValidityStatus enum
- class awsiot.greengrasscoreipc.model.ComponentDetails(*, component_name=None, version=None, state=None, configuration=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_name – The name of the component.
version – The version of the component.
state – LifecycleState enum value. The state of the component.
configuration – The component’s configuration as a JSON object.
- Parameters:
- component_name¶
The name of the component.
- version¶
The version of the component.
- state¶
LifecycleState enum value. The state of the component.
- configuration¶
The component’s configuration as a JSON object.
- class awsiot.greengrasscoreipc.model.CertificateUpdate(*, private_key=None, public_key=None, certificate=None, ca_certificates=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
private_key – The private key in pem format.
public_key – The public key in pem format.
certificate – The certificate in pem format.
ca_certificates – List of CA certificates in pem format.
- Parameters:
- private_key¶
The private key in pem format.
- public_key¶
The public key in pem format.
- certificate¶
The certificate in pem format.
- ca_certificates¶
List of CA certificates in pem format.
- class awsiot.greengrasscoreipc.model.BinaryMessage(*, message=None, context=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message – The binary message as a blob.
context – The context of the message, such as the topic where the message was published.
- Parameters:
context (MessageContext | None) –
- message¶
The binary message as a blob.
- context¶
The context of the message, such as the topic where the message was published.
- class awsiot.greengrasscoreipc.model.JsonMessage(*, message=None, context=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message – The JSON message as an object.
context – The context of the message, such as the topic where the message was published.
- Parameters:
context (MessageContext | None) –
- message¶
The JSON message as an object.
- context¶
The context of the message, such as the topic where the message was published.
- class awsiot.greengrasscoreipc.model.MQTTCredential(*, client_id=None, certificate_pem=None, username=None, password=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
client_id – The client ID to used to connect.
certificate_pem – The client certificate in pem format.
username – The username. (unused).
password – The password. (unused).
- Parameters:
- client_id¶
The client ID to used to connect.
- certificate_pem¶
The client certificate in pem format.
- username¶
The username. (unused).
- password¶
The password. (unused).
- class awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvent(*, configuration=None, deployment_id=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
configuration – The object that contains the new configuration.
deployment_id – The ID of the AWS IoT Greengrass deployment that updates the component.
- Parameters:
- configuration¶
The object that contains the new configuration.
- deployment_id¶
The ID of the AWS IoT Greengrass deployment that updates the component.
- class awsiot.greengrasscoreipc.model.Metric(*, name=None, unit=None, value=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
name –
unit – MetricUnitType enum value.
value –
- Parameters:
- name¶
- unit¶
MetricUnitType enum value.
- value¶
- class awsiot.greengrasscoreipc.model.ConfigurationUpdateEvent(*, component_name=None, key_path=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_name – The name of the component.
key_path – The key path to the configuration value that updated.
- Parameters:
- component_name¶
The name of the component.
- key_path¶
The key path to the configuration value that updated.
- class awsiot.greengrasscoreipc.model.MQTTMessage(*, topic_name=None, payload=None, retain=None, user_properties=None, message_expiry_interval_seconds=None, correlation_data=None, response_topic=None, payload_format=None, content_type=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
topic_name – The topic to which the message was published.
payload – (Optional) The message payload as a blob.
retain – (Optional) The value of the retain flag.
user_properties – (Optional) MQTT user properties associated with the message.
message_expiry_interval_seconds – (Optional) Message expiry interval in seconds.
correlation_data – (Optional) Correlation data blob for request/response.
response_topic – (Optional) Response topic for request/response.
payload_format – PayloadFormat enum value. (Optional) Message payload format.
content_type – (Optional) Message content type.
- Parameters:
- topic_name¶
The topic to which the message was published.
- payload¶
(Optional) The message payload as a blob.
- retain¶
(Optional) The value of the retain flag.
- user_properties¶
(Optional) MQTT user properties associated with the message.
- message_expiry_interval_seconds¶
(Optional) Message expiry interval in seconds.
- correlation_data¶
(Optional) Correlation data blob for request/response.
- response_topic¶
(Optional) Response topic for request/response.
- payload_format¶
PayloadFormat enum value. (Optional) Message payload format.
- content_type¶
(Optional) Message content type.
- class awsiot.greengrasscoreipc.model.FailureHandlingPolicy¶
Bases:
object
FailureHandlingPolicy enum
- class awsiot.greengrasscoreipc.model.ComponentUpdatePolicyEvents(*, pre_update_event=None, post_update_event=None)¶
Bases:
Shape
ComponentUpdatePolicyEvents 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:
pre_update_event – An event that indicates that the Greengrass wants to update a component.
post_update_event – An event that indicates that the nucleus updated a component.
- Parameters:
pre_update_event (PreComponentUpdateEvent | None) –
post_update_event (PostComponentUpdateEvent | None) –
- pre_update_event¶
An event that indicates that the Greengrass wants to update a component.
- post_update_event¶
An event that indicates that the nucleus updated a component.
- class awsiot.greengrasscoreipc.model.ReportedLifecycleState¶
Bases:
object
ReportedLifecycleState enum
- class awsiot.greengrasscoreipc.model.SecretValue(*, secret_string=None, secret_binary=None)¶
Bases:
Shape
SecretValue 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:
secret_string – The decrypted part of the protected secret information that you provided to Secrets Manager as a string.
secret_binary – (Optional) The decrypted part of the protected secret information that you provided to Secrets Manager as binary data in the form of a byte array.
- Parameters:
- secret_string¶
The decrypted part of the protected secret information that you provided to Secrets Manager as a string.
- secret_binary¶
(Optional) The decrypted part of the protected secret information that you provided to Secrets Manager as binary data in the form of a byte array.
- class awsiot.greengrasscoreipc.model.ConfigurationValidityReport(*, status=None, deployment_id=None, message=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
status – ConfigurationValidityStatus enum value. The validity status.
deployment_id – The ID of the AWS IoT Greengrass deployment that requested the configuration update.
message – (Optional) A message that reports why the configuration isn’t valid.
- Parameters:
- status¶
ConfigurationValidityStatus enum value. The validity status.
- deployment_id¶
The ID of the AWS IoT Greengrass deployment that requested the configuration update.
- message¶
(Optional) A message that reports why the configuration isn’t valid.
- class awsiot.greengrasscoreipc.model.ClientDeviceCredential(*, client_device_certificate=None)¶
Bases:
Shape
ClientDeviceCredential 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:
client_device_certificate – The client device’s X.509 device certificate.
- Parameters:
client_device_certificate (str | None) –
- client_device_certificate¶
The client device’s X.509 device certificate.
- class awsiot.greengrasscoreipc.model.CertificateUpdateEvent(*, certificate_update=None)¶
Bases:
Shape
CertificateUpdateEvent 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:
certificate_update – The information about the new certificate.
- Parameters:
certificate_update (CertificateUpdate | None) –
- certificate_update¶
The information about the new certificate.
- class awsiot.greengrasscoreipc.model.CertificateOptions(*, certificate_type=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
certificate_type – CertificateType enum value. The types of certificate updates to subscribe to.
- Parameters:
certificate_type (str | None) –
- certificate_type¶
CertificateType enum value. The types of certificate updates to subscribe to.
- class awsiot.greengrasscoreipc.model.PublishMessage(*, json_message=None, binary_message=None)¶
Bases:
Shape
PublishMessage 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 – (Optional) A JSON message.
binary_message – (Optional) A binary message.
- Parameters:
json_message (JsonMessage | None) –
binary_message (BinaryMessage | None) –
- json_message¶
(Optional) A JSON message.
- binary_message¶
(Optional) A binary message.
- class awsiot.greengrasscoreipc.model.CredentialDocument(*, mqtt_credential=None)¶
Bases:
Shape
CredentialDocument 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:
mqtt_credential – The client device’s MQTT credentials. Specify the client ID and certificate that the client device uses to connect.
- Parameters:
mqtt_credential (MQTTCredential | None) –
- mqtt_credential¶
The client device’s MQTT credentials. Specify the client ID and certificate that the client device uses to connect.
- class awsiot.greengrasscoreipc.model.SubscriptionResponseMessage(*, json_message=None, binary_message=None)¶
Bases:
Shape
SubscriptionResponseMessage 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 – (Optional) A JSON message.
binary_message – (Optional) A binary message.
- Parameters:
json_message (JsonMessage | None) –
binary_message (BinaryMessage | None) –
- json_message¶
(Optional) A JSON message.
- binary_message¶
(Optional) A binary message.
- class awsiot.greengrasscoreipc.model.ValidateConfigurationUpdateEvents(*, validate_configuration_update_event=None)¶
Bases:
Shape
ValidateConfigurationUpdateEvents 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 – The configuration update event.
- Parameters:
validate_configuration_update_event (ValidateConfigurationUpdateEvent | None) –
- validate_configuration_update_event¶
The configuration update event.
- class awsiot.greengrasscoreipc.model.ConfigurationUpdateEvents(*, configuration_update_event=None)¶
Bases:
Shape
ConfigurationUpdateEvents 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 – The configuration update event.
- Parameters:
configuration_update_event (ConfigurationUpdateEvent | None) –
- configuration_update_event¶
The configuration update event.
- class awsiot.greengrasscoreipc.model.IoTCoreMessage(*, message=None)¶
Bases:
Shape
IoTCoreMessage 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:
message – The MQTT message.
- Parameters:
message (MQTTMessage | None) –
- message¶
The MQTT message.
- exception awsiot.greengrasscoreipc.model.InvalidArgumentsError(*, message=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- exception awsiot.greengrasscoreipc.model.InvalidArtifactsDirectoryPathError(*, message=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- exception awsiot.greengrasscoreipc.model.InvalidRecipeDirectoryPathError(*, message=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- exception awsiot.greengrasscoreipc.model.ServiceError(*, message=None, context=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
context –
- Parameters:
- message¶
- context¶
- class awsiot.greengrasscoreipc.model.CreateLocalDeploymentResponse(*, deployment_id=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
deployment_id – The ID of the local deployment that the request created.
- Parameters:
deployment_id (str | None) –
- deployment_id¶
The ID of the local deployment that the request created.
- 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, failure_handling_policy=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
group_name – The thing group name the deployment is targeting. If the group name is not specified, “LOCAL_DEPLOYMENT” will be used.
root_component_versions_to_add – Map of component name to version. Components will be added to the group’s existing root components.
root_components_to_remove – List of components that need to be removed from the group, for example if new artifacts were loaded in this request but recipe version did not change.
component_to_configuration – Map of component names to configuration.
component_to_run_with_info – Map of component names to component run as info.
recipe_directory_path – All recipes files in this directory will be copied over to the Greengrass package store.
artifacts_directory_path – All artifact files in this directory will be copied over to the Greengrass package store.
failure_handling_policy – FailureHandlingPolicy enum value. Deployment failure handling policy.
- Parameters:
- group_name¶
The thing group name the deployment is targeting. If the group name is not specified, “LOCAL_DEPLOYMENT” will be used.
- root_component_versions_to_add¶
Map of component name to version. Components will be added to the group’s existing root components.
- root_components_to_remove¶
List of components that need to be removed from the group, for example if new artifacts were loaded in this request but recipe version did not change.
- component_to_configuration¶
Map of component names to configuration.
- component_to_run_with_info¶
Map of component names to component run as info.
- recipe_directory_path¶
All recipes files in this directory will be copied over to the Greengrass package store.
- artifacts_directory_path¶
All artifact files in this directory will be copied over to the Greengrass package store.
- failure_handling_policy¶
FailureHandlingPolicy enum value. Deployment failure handling policy.
- exception awsiot.greengrasscoreipc.model.ResourceNotFoundError(*, message=None, resource_type=None, resource_name=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
resource_type –
resource_name –
- Parameters:
- message¶
- resource_type¶
- resource_name¶
- exception awsiot.greengrasscoreipc.model.UnauthorizedError(*, message=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- class awsiot.greengrasscoreipc.model.PauseComponentRequest(*, component_name=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_name – The name of the component to pause, which must be a generic component.
- Parameters:
component_name (str | None) –
- component_name¶
The name of the component to pause, which must be a generic component.
- exception awsiot.greengrasscoreipc.model.ComponentNotFoundError(*, message=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- class awsiot.greengrasscoreipc.model.StopComponentResponse(*, stop_status=None, message=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
stop_status – RequestStatus enum value. The status of the stop request.
message – A message about why the component failed to stop, if the request failed.
- Parameters:
- stop_status¶
RequestStatus enum value. The status of the stop request.
- message¶
A message about why the component failed to stop, if the request failed.
- class awsiot.greengrasscoreipc.model.StopComponentRequest(*, component_name=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_name – The name of the component.
- Parameters:
component_name (str | None) –
- component_name¶
The name of the component.
- class awsiot.greengrasscoreipc.model.ListLocalDeploymentsResponse(*, local_deployments=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
local_deployments – The list of local deployments.
- Parameters:
local_deployments (List[LocalDeployment] | None) –
- local_deployments¶
The list of local deployments.
- class awsiot.greengrasscoreipc.model.ListNamedShadowsForThingResponse(*, results=None, timestamp=None, next_token=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
results – The list of shadow names.
timestamp – (Optional) The date and time that the response was generated.
next_token – (Optional) The token value to use in paged requests to retrieve the next page in the sequence. This token isn’t present when there are no more shadow names to return.
- Parameters:
- results¶
The list of shadow names.
- timestamp¶
(Optional) The date and time that the response was generated.
- next_token¶
(Optional) The token value to use in paged requests to retrieve the next page in the sequence. This token isn’t present when there are no more shadow names to return.
- class awsiot.greengrasscoreipc.model.ListNamedShadowsForThingRequest(*, thing_name=None, next_token=None, page_size=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
thing_name – The name of the thing.
next_token – (Optional) The token to retrieve the next set of results. This value is returned on paged results and is used in the call that returns the next page.
page_size – (Optional) The number of shadow names to return in each call. Value must be between 1 and 100. Default is 25.
- Parameters:
- thing_name¶
The name of the thing.
- next_token¶
(Optional) The token to retrieve the next set of results. This value is returned on paged results and is used in the call that returns the next page.
- page_size¶
(Optional) The number of shadow names to return in each call. Value must be between 1 and 100. Default is 25.
- class awsiot.greengrasscoreipc.model.CancelLocalDeploymentResponse(*, message=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- class awsiot.greengrasscoreipc.model.CancelLocalDeploymentRequest(*, deployment_id=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
deployment_id – (Optional) The ID of the local deployment to cancel.
- Parameters:
deployment_id (str | None) –
- deployment_id¶
(Optional) The ID of the local deployment to cancel.
- class awsiot.greengrasscoreipc.model.UpdateStateRequest(*, state=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
state – ReportedLifecycleState enum value. The state to set this component to.
- Parameters:
state (str | None) –
- state¶
ReportedLifecycleState enum value. The state to set this component to.
- class awsiot.greengrasscoreipc.model.GetSecretValueResponse(*, secret_id=None, version_id=None, version_stage=None, secret_value=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
secret_id – The ID of the secret.
version_id – The ID of this version of the secret.
version_stage – The list of staging labels attached to this version of the secret.
secret_value – The value of this version of the secret.
- Parameters:
secret_id (str | None) –
version_id (str | None) –
secret_value (SecretValue | None) –
- secret_id¶
The ID of the secret.
- version_id¶
The ID of this version of the secret.
- version_stage¶
The list of staging labels attached to this version of the secret.
- secret_value¶
The value of this version of the secret.
- class awsiot.greengrasscoreipc.model.GetSecretValueRequest(*, secret_id=None, version_id=None, version_stage=None, refresh=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
secret_id – The name of the secret to get. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
version_id – (Optional) The ID of the version to get. If you don’t specify versionId or versionStage, this operation defaults to the version with the AWSCURRENT label.
version_stage – (Optional) The staging label of the version to get. If you don’t specify versionId or versionStage, this operation defaults to the version with the AWSCURRENT label.
refresh – (Optional) Whether to fetch the latest secret from cloud when the request is handled. Defaults to false.
- Parameters:
- secret_id¶
The name of the secret to get. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
- version_id¶
(Optional) The ID of the version to get. If you don’t specify versionId or versionStage, this operation defaults to the version with the AWSCURRENT label.
- version_stage¶
(Optional) The staging label of the version to get. If you don’t specify versionId or versionStage, this operation defaults to the version with the AWSCURRENT label.
- refresh¶
(Optional) Whether to fetch the latest secret from cloud when the request is handled. Defaults to false.
- class awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusResponse(*, deployment=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
deployment – The local deployment.
- Parameters:
deployment (LocalDeployment | None) –
- deployment¶
The local deployment.
- class awsiot.greengrasscoreipc.model.GetLocalDeploymentStatusRequest(*, deployment_id=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
deployment_id – The ID of the local deployment to get.
- Parameters:
deployment_id (str | None) –
- deployment_id¶
The ID of the local deployment to get.
- class awsiot.greengrasscoreipc.model.RestartComponentResponse(*, restart_status=None, message=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
restart_status – RequestStatus enum value. The status of the restart request.
message – A message about why the component failed to restart, if the request failed.
- Parameters:
- restart_status¶
RequestStatus enum value. The status of the restart request.
- message¶
A message about why the component failed to restart, if the request failed.
- class awsiot.greengrasscoreipc.model.RestartComponentRequest(*, component_name=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_name – The name of the component.
- Parameters:
component_name (str | None) –
- component_name¶
The name of the component.
- exception awsiot.greengrasscoreipc.model.InvalidTokenError(*, message=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- class awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenResponse(*, is_valid=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
is_valid –
- Parameters:
is_valid (bool | None) –
- is_valid¶
- class awsiot.greengrasscoreipc.model.ValidateAuthorizationTokenRequest(*, token=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
token –
- Parameters:
token (str | None) –
- token¶
- exception awsiot.greengrasscoreipc.model.FailedUpdateConditionCheckError(*, message=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- exception awsiot.greengrasscoreipc.model.ConflictError(*, message=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- class awsiot.greengrasscoreipc.model.UpdateConfigurationRequest(*, key_path=None, timestamp=None, value_to_merge=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
key_path – (Optional) The key path to the container node (the object) to update. Specify a list where each entry is the key for a single level in the configuration object. Defaults to the root of the configuration object.
timestamp – The current Unix epoch time in milliseconds. This operation uses this timestamp to resolve concurrent updates to the key. If the key in the component configuration has a greater timestamp than the timestamp in the request, then the request fails.
value_to_merge – The configuration object to merge at the location that you specify in keyPath.
- Parameters:
- key_path¶
(Optional) The key path to the container node (the object) to update. Specify a list where each entry is the key for a single level in the configuration object. Defaults to the root of the configuration object.
- timestamp¶
The current Unix epoch time in milliseconds. This operation uses this timestamp to resolve concurrent updates to the key. If the key in the component configuration has a greater timestamp than the timestamp in the request, then the request fails.
- value_to_merge¶
The configuration object to merge at the location that you specify in keyPath.
- class awsiot.greengrasscoreipc.model.UpdateThingShadowResponse(*, payload=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
payload – The response state document as a JSON encoded blob.
- Parameters:
- payload¶
The response state document as a JSON encoded blob.
- class awsiot.greengrasscoreipc.model.UpdateThingShadowRequest(*, thing_name=None, shadow_name=None, payload=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
thing_name – The name of the thing.
shadow_name – The name of the shadow. To specify the thing’s classic shadow, set this parameter to an empty string (“”).
payload – The request state document as a JSON encoded blob.
- Parameters:
- thing_name¶
The name of the thing.
- shadow_name¶
The name of the shadow. To specify the thing’s classic shadow, set this parameter to an empty string (“”).
- payload¶
The request state document as a JSON encoded blob.
- class awsiot.greengrasscoreipc.model.SendConfigurationValidityReportRequest(*, configuration_validity_report=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
configuration_validity_report – The report that tells Greengrass whether or not the configuration update is valid.
- Parameters:
configuration_validity_report (ConfigurationValidityReport | None) –
- configuration_validity_report¶
The report that tells Greengrass whether or not the configuration update is valid.
- class awsiot.greengrasscoreipc.model.GetThingShadowResponse(*, payload=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
payload – The response state document as a JSON encoded blob.
- Parameters:
- payload¶
The response state document as a JSON encoded blob.
- class awsiot.greengrasscoreipc.model.GetThingShadowRequest(*, thing_name=None, shadow_name=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
thing_name – The name of the thing.
shadow_name – The name of the shadow. To specify the thing’s classic shadow, set this parameter to an empty string (“”).
- Parameters:
- thing_name¶
The name of the thing.
- shadow_name¶
The name of the shadow. To specify the thing’s classic shadow, set this parameter to an empty string (“”).
- class awsiot.greengrasscoreipc.model.CreateDebugPasswordResponse(*, password=None, username=None, password_expiration=None, certificate_sha256_hash=None, certificate_sha1_hash=None)¶
Bases:
Shape
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 –
- Parameters:
- password¶
- username¶
- password_expiration¶
- certificate_sha256_hash¶
- certificate_sha1_hash¶
- class awsiot.greengrasscoreipc.model.ListComponentsResponse(*, components=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
components – The list of components.
- Parameters:
components (List[ComponentDetails] | None) –
- components¶
The list of components.
- exception awsiot.greengrasscoreipc.model.InvalidClientDeviceAuthTokenError(*, message=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- class awsiot.greengrasscoreipc.model.AuthorizeClientDeviceActionResponse(*, is_authorized=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
is_authorized – Whether the client device is authorized to perform the operation on the resource.
- Parameters:
is_authorized (bool | None) –
- is_authorized¶
Whether the client device is authorized to perform the operation on the resource.
- class awsiot.greengrasscoreipc.model.AuthorizeClientDeviceActionRequest(*, client_device_auth_token=None, operation=None, resource=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
client_device_auth_token – The session token for the client device from GetClientDeviceAuthToken.
operation – The operation to authorize.
resource – The resource the client device performs the operation on.
- Parameters:
- client_device_auth_token¶
The session token for the client device from GetClientDeviceAuthToken.
- operation¶
The operation to authorize.
- resource¶
The resource the client device performs the operation on.
- class awsiot.greengrasscoreipc.model.VerifyClientDeviceIdentityResponse(*, is_valid_client_device=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
is_valid_client_device – Whether the client device’s identity is valid.
- Parameters:
is_valid_client_device (bool | None) –
- is_valid_client_device¶
Whether the client device’s identity is valid.
- class awsiot.greengrasscoreipc.model.VerifyClientDeviceIdentityRequest(*, credential=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
credential – The client device’s credentials.
- Parameters:
credential (ClientDeviceCredential | None) –
- credential¶
The client device’s credentials.
- class awsiot.greengrasscoreipc.model.SubscribeToCertificateUpdatesRequest(*, certificate_options=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
certificate_options –
- Parameters:
certificate_options (CertificateOptions | None) –
- certificate_options¶
- class awsiot.greengrasscoreipc.model.PublishToTopicRequest(*, topic=None, publish_message=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
topic – The topic to publish the message.
publish_message – The message to publish.
- Parameters:
topic (str | None) –
publish_message (PublishMessage | None) –
- topic¶
The topic to publish the message.
- publish_message¶
The message to publish.
- exception awsiot.greengrasscoreipc.model.InvalidCredentialError(*, message=None)¶
Bases:
GreengrassCoreIPCError
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
message –
- Parameters:
message (str | None) –
- message¶
- class awsiot.greengrasscoreipc.model.GetClientDeviceAuthTokenResponse(*, client_device_auth_token=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
client_device_auth_token – The session token for the client device. You can use this session token in subsequent requests to authorize this client device’s actions.
- Parameters:
client_device_auth_token (str | None) –
- client_device_auth_token¶
The session token for the client device. You can use this session token in subsequent requests to authorize this client device’s actions.
- class awsiot.greengrasscoreipc.model.GetClientDeviceAuthTokenRequest(*, credential=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
credential – The client device’s credentials.
- Parameters:
credential (CredentialDocument | None) –
- credential¶
The client device’s credentials.
- class awsiot.greengrasscoreipc.model.GetComponentDetailsResponse(*, component_details=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_details – The component’s details.
- Parameters:
component_details (ComponentDetails | None) –
- component_details¶
The component’s details.
- class awsiot.greengrasscoreipc.model.GetComponentDetailsRequest(*, component_name=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_name – The name of the component to get.
- Parameters:
component_name (str | None) –
- component_name¶
The name of the component to get.
- class awsiot.greengrasscoreipc.model.SubscribeToTopicResponse(*, topic_name=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
topic_name – Deprecated No longer used
- Parameters:
topic_name (str | None) –
- topic_name¶
Deprecated No longer used
- class awsiot.greengrasscoreipc.model.SubscribeToTopicRequest(*, topic=None, receive_mode=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
topic – The topic to subscribe to. Supports MQTT-style wildcards.
receive_mode – ReceiveMode enum value. (Optional) The behavior that specifies whether the component receives messages from itself.
- Parameters:
- topic¶
The topic to subscribe to. Supports MQTT-style wildcards.
- receive_mode¶
ReceiveMode enum value. (Optional) The behavior that specifies whether the component receives messages from itself.
- class awsiot.greengrasscoreipc.model.GetConfigurationResponse(*, component_name=None, value=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_name – The name of the component.
value – The requested configuration as an object.
- Parameters:
- component_name¶
The name of the component.
- value¶
The requested configuration as an object.
- class awsiot.greengrasscoreipc.model.GetConfigurationRequest(*, component_name=None, key_path=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_name – (Optional) The name of the component. Defaults to the name of the component that makes the request.
key_path – The key path to the configuration value. Specify a list where each entry is the key for a single level in the configuration object.
- Parameters:
- component_name¶
(Optional) The name of the component. Defaults to the name of the component that makes the request.
- key_path¶
The key path to the configuration value. Specify a list where each entry is the key for a single level in the configuration object.
- class awsiot.greengrasscoreipc.model.DeferComponentUpdateRequest(*, deployment_id=None, message=None, recheck_after_ms=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
deployment_id – The ID of the AWS IoT Greengrass deployment to defer.
message – (Optional) The name of the component for which to defer updates. Defaults to the name of the component that makes the request.
recheck_after_ms – The amount of time in milliseconds for which to defer the update. Greengrass waits for this amount of time and then sends another PreComponentUpdateEvent
- Parameters:
- deployment_id¶
The ID of the AWS IoT Greengrass deployment to defer.
- message¶
(Optional) The name of the component for which to defer updates. Defaults to the name of the component that makes the request.
- recheck_after_ms¶
The amount of time in milliseconds for which to defer the update. Greengrass waits for this amount of time and then sends another PreComponentUpdateEvent
- class awsiot.greengrasscoreipc.model.PutComponentMetricRequest(*, metrics=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- metrics¶
- class awsiot.greengrasscoreipc.model.DeleteThingShadowResponse(*, payload=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
payload – An empty response state document.
- Parameters:
- payload¶
An empty response state document.
- class awsiot.greengrasscoreipc.model.DeleteThingShadowRequest(*, thing_name=None, shadow_name=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
thing_name – The name of the thing.
shadow_name – The name of the shadow. To specify the thing’s classic shadow, set this parameter to an empty string (“”).
- Parameters:
- thing_name¶
The name of the thing.
- shadow_name¶
The name of the shadow. To specify the thing’s classic shadow, set this parameter to an empty string (“”).
- class awsiot.greengrasscoreipc.model.SubscribeToConfigurationUpdateRequest(*, component_name=None, key_path=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_name – (Optional) The name of the component. Defaults to the name of the component that makes the request.
key_path – The key path to the configuration value for which to subscribe. Specify a list where each entry is the key for a single level in the configuration object.
- Parameters:
- component_name¶
(Optional) The name of the component. Defaults to the name of the component that makes the request.
- key_path¶
The key path to the configuration value for which to subscribe. Specify a list where each entry is the key for a single level in the configuration object.
- class awsiot.greengrasscoreipc.model.PublishToIoTCoreRequest(*, topic_name=None, qos=None, payload=None, retain=None, user_properties=None, message_expiry_interval_seconds=None, correlation_data=None, response_topic=None, payload_format=None, content_type=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
topic_name – The topic to which to publish the message.
qos – QOS enum value. The MQTT QoS to use.
payload – (Optional) The message payload as a blob.
retain – (Optional) Whether to set MQTT retain option to true when publishing.
user_properties – (Optional) MQTT user properties associated with the message.
message_expiry_interval_seconds – (Optional) Message expiry interval in seconds.
correlation_data – (Optional) Correlation data blob for request/response.
response_topic – (Optional) Response topic for request/response.
payload_format – PayloadFormat enum value. (Optional) Message payload format.
content_type – (Optional) Message content type.
- Parameters:
- topic_name¶
The topic to which to publish the message.
- qos¶
QOS enum value. The MQTT QoS to use.
- payload¶
(Optional) The message payload as a blob.
- retain¶
(Optional) Whether to set MQTT retain option to true when publishing.
- user_properties¶
(Optional) MQTT user properties associated with the message.
- message_expiry_interval_seconds¶
(Optional) Message expiry interval in seconds.
- correlation_data¶
(Optional) Correlation data blob for request/response.
- response_topic¶
(Optional) Response topic for request/response.
- payload_format¶
PayloadFormat enum value. (Optional) Message payload format.
- content_type¶
(Optional) Message content type.
- class awsiot.greengrasscoreipc.model.ResumeComponentRequest(*, component_name=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
component_name – The name of the component to resume.
- Parameters:
component_name (str | None) –
- component_name¶
The name of the component to resume.
- class awsiot.greengrasscoreipc.model.SubscribeToIoTCoreRequest(*, topic_name=None, qos=None)¶
Bases:
Shape
All attributes are None by default, and may be set by keyword in the constructor.
- Keyword Arguments:
topic_name – The topic to which to subscribe. Supports MQTT wildcards.
qos – QOS enum value. The MQTT QoS to use.
- Parameters:
- topic_name¶
The topic to which to subscribe. Supports MQTT wildcards.
- qos¶
QOS enum value. The MQTT QoS to use.