SendConnectorEventRequest
¶
Source code in docs_src/capo_iot_managed_integrations/types/send_connector_event_request.py
connector_device_id
instance-attribute
¶
connector_device_id: NotRequired[ConnectorDeviceId]
The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).
This parameter is used for cloud-to-cloud devices only.
connector_id
instance-attribute
¶
connector_id: ConnectorId
The id of the connector between the third-party cloud provider and IoT managed integrations.
device_discovery_id
instance-attribute
¶
device_discovery_id: NotRequired[DeviceDiscoveryId]
The id for the device discovery job.
matter_endpoint
instance-attribute
¶
matter_endpoint: NotRequired[MatterEndpoint]
The device endpoint.
message
instance-attribute
¶
message: NotRequired[ConnectorEventMessage]
The device state change event payload.
This parameter will include the following three fields:
-
uri:schema auc://<PARTNER-DEVICE-ID>/ResourcePath(TheResourcepathcorresponds to an OCF resource.) -
op: For device state changes, this field must populate asn+d. -
cn: The content depends on the OCF resource referenced inResourcePath.
operation
instance-attribute
¶
operation: ConnectorEventOperation
The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.
The field op can have a value of "I" or "U". The field "cn" will contain the capability types.
operation_version
instance-attribute
¶
operation_version: NotRequired[ConnectorEventOperationVersion]
The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.
status_code
instance-attribute
¶
status_code: NotRequired[ConnectorEventStatusCode]
The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.
trace_id
instance-attribute
¶
trace_id: NotRequired[TraceId]
The trace request identifier. This is generated by IoT managed integrations and can be used to trace this command and its related operations in CloudWatch.
user_id
instance-attribute
¶
user_id: NotRequired[ThirdPartyUserId]
The id of the third-party cloud provider.