IoTDataPlane / Client / send_direct_message

send_direct_message

IoTDataPlane.Client.send_direct_message(**kwargs)

Sends an MQTT message directly to a specific client identified by its client ID.

SendDirectMessage targets a single client ID. The receiving client does not need to subscribe to the topic, but the receiver’s policy must allow iot:Receive on the specified topic.

Requires permission to access the SendDirectMessage action.

For more information about messaging costs, see Amazon Web Services IoT Core pricing.

See also: AWS API Documentation

Request Syntax

response = client.send_direct_message(
    clientId='string',
    topic='string',
    contentType='string',
    responseTopic='string',
    confirmation=True|False,
    timeout=123,
    payload=b'bytes'|file,
    userProperties={...}|[...]|123|123.4|'string'|True|None,
    payloadFormatIndicator='UNSPECIFIED_BYTES'|'UTF8_DATA',
    correlationData='string'
)
Parameters:

  • clientId (string) –

    [REQUIRED]

    The unique identifier of the MQTT client to send the message to.

    Client IDs must not exceed 128 characters and can’t start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

  • topic (string) –

    [REQUIRED]

    The topic of the outbound MQTT Publish message to the receiving client. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

  • contentType (string) – The MQTT5 content type property forwarded to the receiving client (for example, application/json).

  • responseTopic (string) – A UTF-8 encoded string that’s used as the topic name for a response message. The response topic describes the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

  • confirmation (boolean) –

    A Boolean value that specifies whether to wait for delivery confirmation from the receiving client.

    When set to true, the API delivers the message at QoS 1 and waits for the client to send a delivery confirmation (PUBACK) before returning a successful response. If delivery confirmation is not received within the specified timeout period, the API returns HTTP 504.

    When set to false, the API delivers the message at QoS 0 and returns after Amazon Web Services IoT Core attempts to deliver the message.

    Valid values: true | false

    Default value: false

  • timeout (integer) –

    An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when confirmation is set to true. If confirmation is false, this parameter is ignored.

    The total API response time may be higher than this value due to internal processing. Set your HTTP client timeout to a value greater than this parameter.

    Valid range: 1 to 15 seconds.

    Default value: 5 seconds.

  • payload (bytes or seekable file-like object) – The message body. MQTT accepts text, binary, and empty (null) message payloads.

  • userProperties (JSON serializable) –

    A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.

    For MQTT 3.1.1 clients, user properties are silently dropped.

    The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:

    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]

  • payloadFormatIndicator (string) – An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.

  • correlationData (string) – The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it’s received. correlationData is an HTTP header value in the API.

Return type:

dict

Returns:

Response Syntax

{
    'message': 'string',
    'traceId': 'string'
}

Response Structure

  • (dict) –

    The output from the SendDirectMessage operation.

    • message (string) –

      The status message indicating the result of the operation.

    • traceId (string) –

      A unique identifier for the request. Include this value when contacting Amazon Web Services Support for troubleshooting.

Exceptions

  • IoTDataPlane.Client.exceptions.InternalFailureException

  • IoTDataPlane.Client.exceptions.InvalidRequestException

  • IoTDataPlane.Client.exceptions.ResourceNotFoundException

  • IoTDataPlane.Client.exceptions.UnauthorizedException

  • IoTDataPlane.Client.exceptions.ForbiddenException

  • IoTDataPlane.Client.exceptions.ThrottlingException

  • IoTDataPlane.Client.exceptions.RequestEntityTooLargeException

  • IoTDataPlane.Client.exceptions.GatewayTimeoutException