ManagedintegrationsforIoTDeviceManagement / Client / send_managed_thing_command

send_managed_thing_command#

ManagedintegrationsforIoTDeviceManagement.Client.send_managed_thing_command(**kwargs)#

Send the command to the device represented by the managed thing.

See also: AWS API Documentation

Request Syntax

response = client.send_managed_thing_command(
    ManagedThingId='string',
    Endpoints=[
        {
            'endpointId': 'string',
            'capabilities': [
                {
                    'id': 'string',
                    'name': 'string',
                    'version': 'string',
                    'actions': [
                        {
                            'name': 'string',
                            'ref': 'string',
                            'actionTraceId': 'string',
                            'parameters': {...}|[...]|123|123.4|'string'|True|None
                        },
                    ]
                },
            ]
        },
    ],
    ConnectorAssociationId='string'
)
Parameters:

  • ManagedThingId (string) –

    [REQUIRED]

    The id of the device.

  • Endpoints (list) –

    [REQUIRED]

    The device endpoint.

    • (dict) –

      The endpoint for a managed thing when sending a command.

      • endpointId (string) – [REQUIRED]

        The id of the endpoint for a managed thing.

      • capabilities (list) – [REQUIRED]

        Describe the endpoint with an id, a name, and the relevant capabilities for sending commands.

        • (dict) –

          The command capabilities added for the managed thing

          • id (string) – [REQUIRED]

            Describe the capability with an id.

          • name (string) – [REQUIRED]

            Describe the capability with an name.

          • version (string) – [REQUIRED]

            Describe the capability with a version.

          • actions (list) – [REQUIRED]

            Describe the command capability with the actions it supports.

            • (dict) –

              Action for an Amazon Web Services capability, containing the action parameters for control.

              • name (string) – [REQUIRED]

                Describe a capability action with a name.

              • ref (string) –

                Describe a capability action with an reference.

              • actionTraceId (string) –

                Describe a capability action with an actionTraceId for a response command.

              • parameters (document) –

                Describe a capability action with a capability property.

  • ConnectorAssociationId (string) – The ID tracking the current discovery process for one connector association.

Return type:

dict

Returns:

Response Syntax

{
    'TraceId': 'string'
}

Response Structure

  • (dict) –

    • TraceId (string) –

      The trace request identifier. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.

Exceptions