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:

GreengrassCoreIPCClient

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.AuthorizeClientDeviceActionResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.DeleteThingShadowResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.GetClientDeviceAuthTokenResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.GetConfigurationResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.GetLocalDeploymentStatusResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.GetSecretValueResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.GetThingShadowResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.ListComponentsResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.ListNamedShadowsForThingResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.PauseComponentResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.PublishToIoTCoreResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.PublishToTopicResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.PutComponentMetricResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.RestartComponentResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.ResumeComponentResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.SendConfigurationValidityReportResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.StopComponentResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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,

Parameters:: error (Exception) –
Return type:: bool

on_stream_closed()¶

Invoked when the stream for this operation is closed.

Return type:: None

class awsiot.greengrasscoreipc.client.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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.SubscribeToCertificateUpdatesResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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,

Parameters:: error (Exception) –
Return type:: bool

on_stream_closed()¶

Invoked when the stream for this operation is closed.

Return type:: None

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

Bases: _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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.SubscribeToComponentUpdatesResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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,

Parameters:: error (Exception) –
Return type:: bool

on_stream_closed()¶

Invoked when the stream for this operation is closed.

Return type:: None

class awsiot.greengrasscoreipc.client.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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.SubscribeToConfigurationUpdateResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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,

Parameters:: error (Exception) –
Return type:: bool

on_stream_closed()¶

Invoked when the stream for this operation is closed.

Return type:: None

class awsiot.greengrasscoreipc.client.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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.SubscribeToIoTCoreResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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,

Parameters:: error (Exception) –
Return type:: bool

on_stream_closed()¶

Invoked when the stream for this operation is closed.

Return type:: None

class awsiot.greengrasscoreipc.client.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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.SubscribeToTopicResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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,

Parameters:: error (Exception) –
Return type:: bool

on_stream_closed()¶

Invoked when the stream for this operation is closed.

Return type:: None

class awsiot.greengrasscoreipc.client.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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.SubscribeToValidateConfigurationUpdatesResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.UpdateStateResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.UpdateThingShadowResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.ValidateAuthorizationTokenResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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:: concurrent.futures.Future[None]

get_response()¶

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

Return type:: concurrent.futures.Future[model.VerifyClientDeviceIdentityResponse]

close()¶

Close the operation, whether or not it has completed.

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

Return type:: concurrent.futures.Future[None]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

new_update_configuration()¶

Create a new UpdateConfigurationOperation.

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

Return type:: UpdateConfigurationOperation

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

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

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

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

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:

client_device_auth_token (str | None) –
operation (str | None) –
resource (str | None) –

Return type:

AuthorizeClientDeviceActionResponse

authorize_client_device_action_async(*, client_device_auth_token=None, operation=None, resource=None)¶

Perform the AuthorizeClientDeviceAction operation asynchronously.

Parameters:

client_device_auth_token (str | None) –
operation (str | None) –
resource (str | None) –

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

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

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:

group_name (str | None) –
root_component_versions_to_add (Dict[str, str] | None) –
root_components_to_remove (List[str] | None) –
component_to_configuration (Dict[str, Dict[str, Any]] | None) –
component_to_run_with_info (Dict[str, RunWithInfo] | None) –
recipe_directory_path (str | None) –
artifacts_directory_path (str | None) –
failure_handling_policy (str | None) – FailureHandlingPolicy enum value

Return type:

CreateLocalDeploymentResponse

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:

group_name (str | None) –
root_component_versions_to_add (Dict[str, str] | None) –
root_components_to_remove (List[str] | None) –
component_to_configuration (Dict[str, Dict[str, Any]] | None) –
component_to_run_with_info (Dict[str, RunWithInfo] | None) –
recipe_directory_path (str | None) –
artifacts_directory_path (str | None) –
failure_handling_policy (str | None) – FailureHandlingPolicy enum value

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:

deployment_id (str | None) –
message (str | None) –
recheck_after_ms (int | None) –

Return type:

DeferComponentUpdateResponse

defer_component_update_async(*, deployment_id=None, message=None, recheck_after_ms=None)¶

Perform the DeferComponentUpdate operation asynchronously.

Parameters:

deployment_id (str | None) –
message (str | None) –
recheck_after_ms (int | None) –

Return type:

concurrent.futures.Future[model.DeferComponentUpdateResponse]

delete_thing_shadow(*, thing_name=None, shadow_name=None)¶

Perform the DeleteThingShadow operation synchronously.

Parameters:

thing_name (str | None) –
shadow_name (str | None) –

Return type:

DeleteThingShadowResponse

delete_thing_shadow_async(*, thing_name=None, shadow_name=None)¶

Perform the DeleteThingShadow operation asynchronously.

Parameters:

thing_name (str | None) –
shadow_name (str | None) –

Return type:

concurrent.futures.Future[model.DeleteThingShadowResponse]

get_client_device_auth_token(*, credential=None)¶

Perform the GetClientDeviceAuthToken operation synchronously.

Parameters:: credential (CredentialDocument | None) –
Return type:: GetClientDeviceAuthTokenResponse

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

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:

component_name (str | None) –
key_path (List[str] | None) –

Return type:

GetConfigurationResponse

get_configuration_async(*, component_name=None, key_path=None)¶

Perform the GetConfiguration operation asynchronously.

Parameters:

component_name (str | None) –
key_path (List[str] | None) –

Return type:

concurrent.futures.Future[model.GetConfigurationResponse]

get_local_deployment_status(*, deployment_id=None)¶

Perform the GetLocalDeploymentStatus operation synchronously.

Parameters:: deployment_id (str | None) –
Return type:: GetLocalDeploymentStatusResponse

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:

secret_id (str | None) –
version_id (str | None) –
version_stage (str | None) –
refresh (bool | None) –

Return type:

GetSecretValueResponse

get_secret_value_async(*, secret_id=None, version_id=None, version_stage=None, refresh=None)¶

Perform the GetSecretValue operation asynchronously.

Parameters:

secret_id (str | None) –
version_id (str | None) –
version_stage (str | None) –
refresh (bool | None) –

Return type:

concurrent.futures.Future[model.GetSecretValueResponse]

get_thing_shadow(*, thing_name=None, shadow_name=None)¶

Perform the GetThingShadow operation synchronously.

Parameters:

thing_name (str | None) –
shadow_name (str | None) –

Return type:

GetThingShadowResponse

get_thing_shadow_async(*, thing_name=None, shadow_name=None)¶

Perform the GetThingShadow operation asynchronously.

Parameters:

thing_name (str | None) –
shadow_name (str | None) –

Return type:

concurrent.futures.Future[model.GetThingShadowResponse]

list_components()¶

Perform the ListComponents operation synchronously.

Return type:: ListComponentsResponse

list_components_async()¶

Perform the ListComponents operation asynchronously.

Return type:: concurrent.futures.Future[model.ListComponentsResponse]

list_local_deployments()¶

Perform the ListLocalDeployments operation synchronously.

Return type:: ListLocalDeploymentsResponse

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:

thing_name (str | None) –
next_token (str | None) –
page_size (int | None) –

Return type:

ListNamedShadowsForThingResponse

list_named_shadows_for_thing_async(*, thing_name=None, next_token=None, page_size=None)¶

Perform the ListNamedShadowsForThing operation asynchronously.

Parameters:

thing_name (str | None) –
next_token (str | None) –
page_size (int | None) –

Return type:

concurrent.futures.Future[model.ListNamedShadowsForThingResponse]

pause_component(*, component_name=None)¶

Perform the PauseComponent operation synchronously.

Parameters:: component_name (str | None) –
Return type:: PauseComponentResponse

pause_component_async(*, component_name=None)¶

Perform the PauseComponent operation asynchronously.

Parameters:: component_name (str | None) –
Return type:: concurrent.futures.Future[model.PauseComponentResponse]

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:

topic_name (str | None) –
qos (str | None) – QOS enum value
payload (bytes | str | None) –
retain (bool | None) –
user_properties (List[UserProperty] | None) –
message_expiry_interval_seconds (int | None) –
correlation_data (bytes | str | None) –
response_topic (str | None) –
payload_format (str | None) – PayloadFormat enum value
content_type (str | None) –

Return type:

PublishToIoTCoreResponse

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:

topic_name (str | None) –
qos (str | None) – QOS enum value
payload (bytes | str | None) –
retain (bool | None) –
user_properties (List[UserProperty] | None) –
message_expiry_interval_seconds (int | None) –
correlation_data (bytes | str | None) –
response_topic (str | None) –
payload_format (str | None) – PayloadFormat enum value
content_type (str | None) –

Return type:

concurrent.futures.Future[model.PublishToIoTCoreResponse]

publish_to_topic(*, topic=None, publish_message=None)¶

Perform the PublishToTopic operation synchronously.

Parameters:

topic (str | None) –
publish_message (PublishMessage | None) –

Return type:

PublishToTopicResponse

publish_to_topic_async(*, topic=None, publish_message=None)¶

Perform the PublishToTopic operation asynchronously.

Parameters:

topic (str | None) –
publish_message (PublishMessage | None) –

Return type:

concurrent.futures.Future[model.PublishToTopicResponse]

put_component_metric(*, metrics=None)¶

Perform the PutComponentMetric operation synchronously.

Parameters:: metrics (List[Metric] | None) –
Return type:: PutComponentMetricResponse

put_component_metric_async(*, metrics=None)¶

Perform the PutComponentMetric operation asynchronously.

Parameters:: metrics (List[Metric] | None) –
Return type:: concurrent.futures.Future[model.PutComponentMetricResponse]

restart_component(*, component_name=None)¶

Perform the RestartComponent operation synchronously.

Parameters:: component_name (str | None) –
Return type:: RestartComponentResponse

restart_component_async(*, component_name=None)¶

Perform the RestartComponent operation asynchronously.

Parameters:: component_name (str | None) –
Return type:: concurrent.futures.Future[model.RestartComponentResponse]

resume_component(*, component_name=None)¶

Perform the ResumeComponent operation synchronously.

Parameters:: component_name (str | None) –
Return type:: ResumeComponentResponse

resume_component_async(*, component_name=None)¶

Perform the ResumeComponent operation asynchronously.

Parameters:: component_name (str | None) –
Return type:: concurrent.futures.Future[model.ResumeComponentResponse]

send_configuration_validity_report(*, configuration_validity_report=None)¶

Perform the SendConfigurationValidityReport operation synchronously.

Parameters:: configuration_validity_report (ConfigurationValidityReport | None) –
Return type:: SendConfigurationValidityReportResponse

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

stop_component_async(*, component_name=None)¶

Perform the StopComponent operation asynchronously.

Parameters:: component_name (str | None) –
Return type:: concurrent.futures.Future[model.StopComponentResponse]

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) –
key_path (List[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) –
key_path (List[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:

Tuple[SubscribeToTopicResponse, SubscribeToTopicOperation]

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: