Skip to content

SendConnectorEventRequest

Source code in docs_src/capo_iot_managed_integrations/types/send_connector_event_request.py
class SendConnectorEventRequest(TypedDict, closed=True):
    connector_id: "capo_iot_managed_integrations.types.connector_id.ConnectorId"
    """<p>The id of the connector between the third-party cloud provider and IoT managed integrations.</p>"""
    user_id: NotRequired[
        "capo_iot_managed_integrations.types.third_party_user_id.ThirdPartyUserId"
    ]
    """<p>The id of the third-party cloud provider.</p>"""
    operation: "capo_iot_managed_integrations.types.connector_event_operation.ConnectorEventOperation"
    """<p>The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.</p> <note> <p>The field op can have a value of "I" or "U". The field "cn" will contain the capability types.</p> </note>"""
    operation_version: NotRequired[
        "capo_iot_managed_integrations.types.connector_event_operation_version.ConnectorEventOperationVersion"
    ]
    """<p>The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see <a href="https://openconnectivity.org/specs/OCF_Security_Specification_v1.0.0.pdf">OCF Security Specification</a>.</p>"""
    status_code: NotRequired[
        "capo_iot_managed_integrations.types.connector_event_status_code.ConnectorEventStatusCode"
    ]
    """<p>The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.</p>"""
    message: NotRequired[
        "capo_iot_managed_integrations.types.connector_event_message.ConnectorEventMessage"
    ]
    """<p>The device state change event payload.</p> <p>This parameter will include the following three fields:</p> <ul> <li> <p> <code>uri</code>: <code>schema auc://&lt;PARTNER-DEVICE-ID&gt;/ResourcePath</code> (The <code>Resourcepath</code> corresponds to an OCF resource.)</p> </li> <li> <p> <code>op</code>: For device state changes, this field must populate as <code>n+d</code>.</p> </li> <li> <p> <code>cn</code>: The content depends on the OCF resource referenced in <code>ResourcePath</code>.</p> </li> </ul>"""
    device_discovery_id: NotRequired[
        "capo_iot_managed_integrations.types.device_discovery_id.DeviceDiscoveryId"
    ]
    """<p>The id for the device discovery job.</p>"""
    connector_device_id: NotRequired[
        "capo_iot_managed_integrations.types.connector_device_id.ConnectorDeviceId"
    ]
    """<p>The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).</p> <note> <p>This parameter is used for cloud-to-cloud devices only.</p> </note>"""
    trace_id: NotRequired["capo_iot_managed_integrations.types.trace_id.TraceId"]
    """<p>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.</p>"""
    devices: NotRequired["capo_iot_managed_integrations.types.devices.Devices"]
    """<p>The list of devices.</p>"""
    matter_endpoint: NotRequired[
        "capo_iot_managed_integrations.types.matter_endpoint.MatterEndpoint"
    ]
    """<p>The device endpoint.</p>"""

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.

devices instance-attribute

devices: NotRequired[Devices]

The list of devices.

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 (The Resourcepath corresponds to an OCF resource.)

  • op: For device state changes, this field must populate as n+d.

  • cn: The content depends on the OCF resource referenced in ResourcePath.

operation instance-attribute

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.