ManagedintegrationsforIoTDeviceManagement / Client / send_connector_event

send_connector_event¶

ManagedintegrationsforIoTDeviceManagement.Client.send_connector_event(**kwargs)¶

Relays third-party device events for a connector such as a new device or a device state change event.

Request Syntax

response = client.send_connector_event(
    ConnectorId='string',
    UserId='string',
    Operation='DEVICE_COMMAND_RESPONSE'|'DEVICE_DISCOVERY'|'DEVICE_EVENT'|'DEVICE_COMMAND_REQUEST',
    OperationVersion='string',
    StatusCode=123,
    Message='string',
    DeviceDiscoveryId='string',
    ConnectorDeviceId='string',
    TraceId='string',
    Devices=[
        {
            'ConnectorDeviceId': 'string',
            'ConnectorDeviceName': 'string',
            'CapabilityReport': {
                'version': 'string',
                'nodeId': 'string',
                'endpoints': [
                    {
                        'id': 'string',
                        'deviceTypes': [
                            'string',
                        ],
                        'clusters': [
                            {
                                'id': 'string',
                                'revision': 123,
                                'publicId': 'string',
                                'name': 'string',
                                'specVersion': 'string',
                                'attributes': [
                                    {
                                        'id': 'string',
                                        'name': 'string',
                                        'value': {...}|[...]|123|123.4|'string'|True|None
                                    },
                                ],
                                'commands': [
                                    'string',
                                ],
                                'events': [
                                    'string',
                                ],
                                'featureMap': 123,
                                'generatedCommands': [
                                    'string',
                                ],
                                'fabricIndex': 123
                            },
                        ],
                        'parts': [
                            'string',
                        ],
                        'semanticTags': [
                            'string',
                        ],
                        'clientClusters': [
                            'string',
                        ]
                    },
                ]
            },
            'CapabilitySchemas': [
                {
                    'Format': 'AWS'|'ZCL'|'CONNECTOR',
                    'CapabilityId': 'string',
                    'ExtrinsicId': 'string',
                    'ExtrinsicVersion': 123,
                    'Schema': {...}|[...]|123|123.4|'string'|True|None
                },
            ],
            'DeviceMetadata': {...}|[...]|123|123.4|'string'|True|None
        },
    ],
    MatterEndpoint={
        'id': 'string',
        'clusters': [
            {
                'id': 'string',
                'attributes': {...}|[...]|123|123.4|'string'|True|None,
                'commands': {
                    'string': {...}|[...]|123|123.4|'string'|True|None
                },
                'events': {
                    'string': {...}|[...]|123|123.4|'string'|True|None
                }
            },
        ]
    }
)

Parameters:

ConnectorId (string) –
[REQUIRED]

The id of the connector between the third-party cloud provider and IoT managed integrations.
UserId (string) – The id of the third-party cloud provider.
Operation (string) –
[REQUIRED]

The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.

Note
The field op can have a value of “I” or “U”. The field “cn” will contain the capability types.
OperationVersion (string) – The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.
StatusCode (integer) – The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.
Message (string) –
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.
DeviceDiscoveryId (string) – The id for the device discovery job.
ConnectorDeviceId (string) –
The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).

Note
This parameter is used for cloud-to-cloud devices only.
TraceId (string) – The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.
Devices (list) –
The list of devices.
- (dict) –
  
  Describe the device using the relevant metadata and supported clusters for device discovery.
  - ConnectorDeviceId (string) – [REQUIRED]
    
    The device id as defined by the connector.
    
    Note
    This parameter is used for cloud-to-cloud devices only.
  - ConnectorDeviceName (string) –
    
    The name of the device as defined by the connector.
  - CapabilityReport (dict) – [REQUIRED]
    
    The capability report for the device.
    - version (string) – [REQUIRED]
      
      The version of the capability report.
    - nodeId (string) –
      
      The numeric identifier of the node.
    - endpoints (list) – [REQUIRED]
      
      The endpoints used in the capability report.
      - (dict) –
        
        Matter endpoint used in capability report.
        
        id (string) – [REQUIRED]
        
        The id of the Amazon Web Services Matter capability report endpoint.
        
        deviceTypes (list) – [REQUIRED]
        
        The type of device.
        
        (string) –
        
        clusters (list) – [REQUIRED]
        
        Matter clusters used in capability report.
        
        (dict) –
        
        Capability used in Matter capability report.
        
        id (string) – [REQUIRED]
        
        The id of the Amazon Web Services Matter capability report cluster.
        
        revision (integer) – [REQUIRED]
        
        The id of the revision for the Amazon Web Services Matter capability report.
        
        publicId (string) –
        
        The id of the schema version.
        
        name (string) –
        
        The capability name used in the Amazon Web Services Matter capability report.
        
        specVersion (string) –
        
        The spec version used in the Amazon Web Services Matter capability report.
        
        attributes (list) –
        
        The attributes of the Amazon Web Services Matter capability report.
        
        (dict) –
        
        Matter attribute used in capability report.
        
        id (string) –
        
        The id of the Matter attribute.
        
        name (string) –
        
        Name for the Amazon Web Services Matter capability report attribute.
        
        value (document) –
        
        Value for the Amazon Web Services Matter capability report attribute.
        
        commands (list) –
        
        The commands used with the Amazon Web Services Matter capability report.
        
        (string) –
        
        events (list) –
        
        The events used with the Amazon Web Services Matter capability report.
        
        (string) –
        
        featureMap (integer) –
        
        32 bit-map used to indicate which features a cluster supports.
        
        generatedCommands (list) –
        
        Matter clusters used in capability report.
        
        (string) –
        
        fabricIndex (integer) –
        
        The fabric index for the Amazon Web Services Matter capability report.
        
        parts (list) –
        
        Heirachy of child endpoints contained in the given endpoint.
        
        (string) –
        
        semanticTags (list) –
        
        Semantic information related to endpoint.
        
        (string) –
        
        clientClusters (list) –
        
        Semantic information related to endpoint.
        
        (string) –
  - CapabilitySchemas (list) –
    
    Report of all capabilities supported by the device.
    - (dict) –
      
      Structure representing a capability schema item that defines the functionality and features supported by a managed thing.
      - Format (string) – [REQUIRED]
        
        The format of the capability schema, which defines how the schema is structured and interpreted.
      - CapabilityId (string) – [REQUIRED]
        
        The unique identifier of the capability defined in the schema.
      - ExtrinsicId (string) – [REQUIRED]
        
        The external identifier for the capability, used when referencing the capability outside of the AWS ecosystem.
      - ExtrinsicVersion (integer) – [REQUIRED]
        
        The version of the external capability definition, used to track compatibility with external systems.
      - Schema (document) – [REQUIRED]
        
        The actual schema definition that describes the capability’s properties, actions, and events.
  - DeviceMetadata (document) –
    
    The metadata attributes for a device.
MatterEndpoint (dict) –
The device endpoint.
- id (string) –
  
  The Matter endpoint id.
- clusters (list) –
  
  A list of Matter clusters for a managed thing.
  - (dict) –
    
    Describe a Matter cluster with an id, and the relevant attributes, commands, and events.
    - id (string) –
      
      The cluster id.
    - attributes (document) –
      
      The Matter attributes.
    - commands (dict) –
      
      Describe the Matter commands with the Matter command identifier mapped to the command fields.
      - (string) –
        
        (document) –
    - events (dict) –
      
      Describe the Matter events with the Matter event identifier mapped to the event fields.
      - (string) –
        
        (document) –

Return type:

dict

Returns:

Response Syntax

{
    'ConnectorId': 'string'
}

Response Structure

(dict) –
- ConnectorId (string) –
  
  The id of the connector between the third-party cloud provider and IoT managed integrations.

send_connector_event¶

Request Syntax

Note

Note

Note

Response Syntax

Response Structure

Exceptions