Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

函数

您可以使用 SQL 表达式的 SELECT 或 WHERE 子句中的以下内置函数。

abs(Decimal)

返回数字的绝对值。SQL 版本 2015-10-08 及更高版本支持。

示例：abs(-5) 返回 5。

accountid()

以 String 形式返回拥有该规则的账户的 ID。SQL 版本 2015-10-08 及更高版本支持。

示例：

accountid() = "123456789012"

acos(Decimal)

以弧度为单位返回数字的反余弦值。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：acos(0) = 1.5707963267948966

asin(Decimal)

以弧度为单位返回数字的反正弦值。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：asin(0) = 0.0

atan(Decimal)

以弧度为单位返回数字的反正切值。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：atan(0) = 0.0

atan2(Decimal, Decimal)

以弧度的形式返回 x 轴正方向与由两个参数定义的 (x,y) 点之间的角度。 逆时针的角，角度为正数（上半平面，y > 0），顺时针的角，角度为负数（下半平面，y < 0）。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：atan2(1, 0) = 1.5707963267948966

aws_lambda(functionArn, inputJson)

调用指定的 Lambda 函数并将 inputJson 传递给 Lambda 函数，并且返回 Lambda 函数生成的 JSON。

您必须授予 Amazon IoT lambda:InvokeFunction 权限，以便调用指定的 Lambda 函数。以下示例说明如何使用 Amazon CLI 授予 lambda:InvokeFunction 权限：

aws lambda add-permission --function-name "function_name"
--region "region"
--principal iot.amazonaws.com 
--source-arn arn:aws:iot:us-east-1:account_id:rule/rule_name
--source-account "account_id"
--statement-id "unique_id" 
--action "lambda:InvokeFunction"

add-permission 命令的参数如下：

假设 JSON 消息负载如下所示：

{
    "attribute1": 21,
    "attribute2": "value"
}

aws_lambda 函数可用于调用 Lambda 函数，如下所示。

SELECT
aws_lambda("arn:aws:lambda:us-east-1:account_id:function:lambda_function", {"payload":attribute1}) as output FROM 'topic-filter'

如果您想要传递完整的 MQTT 消息负载，您可以使用“*”指定 JSON 负载，如下示例所示。

SELECT
aws_lambda("arn:aws:lambda:us-east-1:account_id:function:lambda_function", *) as output FROM 'topic-filter'

payload.inner.element从主题'主题/副主题'上发布的消息中选择数据。

some.value从 Lambda 函数生成的输出中选择数据。

bitand(Int, Int)

在两个 Int (转换成的) 参数的位表示之间逐位执行与运算。SQL 版本 2015-10-08 及更高版本支持。

示例：bitand(13, 5) = 5

bitor(Int, Int)

在两个参数的位表示之间逐位执行或运算。SQL 版本 2015-10-08 及更高版本支持。

示例：bitor(8, 5) = 13

bitxor(Int, Int)

在两个 Int (转换成的) 参数的位表示之间逐位执行异或运算。SQL 版本 2015-10-08 及更高版本支持。

示例：bitor(13, 5) = 8

bitnot(Int)

对 Int (转换成的) 参数的位表示逐位执行非运算。SQL 版本 2015-10-08 及更高版本支持。

示例：bitnot(13) = 2

cast()

将值从一个数据类型转换为另一个数据类型。强制转换与标准转换大体相同，但是增加了在数字与布尔值之间进行强制转换的能力。如果 Amazon IoT 无法确定如何将一个数据类型强制转换为另一个数据类型，则结果为 Undefined。SQL 版本 2015-10-08 及更高版本支持。格式：cast(值 as 类型)。

示例：

cast(true as Int) = 1

在调用 cast 时，“as”后面可能出现以下关键字：

强制转换规则：

ceil(Decimal)

将给定的 Decimal 向上舍入到最近的 Int。SQL 版本 2015-10-08 及更高版本支持。

示例：

ceil(1.2) = 2

ceil(-1.2) = -1

chr(String)

返回给定 Int 参数对应的 ASCII 字符。SQL 版本 2015-10-08 及更高版本支持。

示例：

chr(65) = "A"。

chr(49) = "1"。

clientid()

返回发送消息的 MQTT 客户端的 ID，如果未通过 MQTT 发送消息，则返回 n/a。SQL 版本 2015-10-08 及更高版本支持。

示例：

clientid() = "123456789012"

concat()

联接数组或字符串。该函数可接受任意数量的参数，并返回 String 或 Array。SQL 版本 2015-10-08 及更高版本支持。

示例：

concat() = Undefined.

concat(1) = "1"。

concat([1, 2, 3], 4) = [1, 2, 3, 4]。

concat([1, 2, 3], "hello") = [1, 2, 3, "hello"]

concat("con", "cat") = "concat"

concat(1, "hello") = "1hello"

concat("he","is","man") = "heisman"

concat([1, 2, 3], "hello", [4, 5, 6]) = [1, 2, 3, "hello", 4, 5, 6]

cos(Decimal)

以弧度为单位返回数字的余弦值。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：

cos(0) = 1。

cosh(Decimal)

以弧度为单位返回数字的双曲余弦值。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：cosh(2.3) = 5.037220649268761。

解码（值，decodingScheme）

使用 decode 函数来解码一个编码的值。如果解码字符串为 JSON 文档，则返回可寻址对象。否则，解码字符串会返回为字符串。如果字符串无法解码，则函数返回 NULL。此函数支持解码 base64 编码的字符串和协议缓冲区 (protobuf) 消息格式。

SQL 版本 2016-03-23 及更高版本支持。

解码 base64 编码字符串

在此示例中，消息负载包含一个编码值。

{
    encoded_temp: "eyAidGVtcGVyYXR1cmUiOiAzMyB9Cg=="
}

此 SQL 语句中的decode函数对消息负载中的值进行解码。

SELECT decode(encoded_temp,"base64").temperature AS temp from 'topic/subtopic'

解码 encoded_temp 值会生成以下有效的 JSON 文档，该文档允许 SELECT 语句读取温度值。

{ "temperature": 33 }

此处显示了此示例中 SELECT 语句的结果。

{ "temp": 33 }

如果解码的值不是有效的 JSON 文档，则解码的值将作为字符串返回。

解码 protobuf 消息有效负载

您可以使用解码 SQL 函数来配置可以解码 protobuf 消息有效负载的规则。有关更多信息，请参阅解码 protobuf 消息有效负载。

此函数签名类似以下内容：

decode(<ENCODED DATA>, 'proto', '<S3 BUCKET NAME>', '<S3 OBJECT KEY>', '<PROTO NAME>', '<MESSAGE TYPE>')            

使用解码 SQL函数的示例 SQL 表达式可能如下所示：

SELECT VALUE decode(*, 'proto', 's3-bucket', 'messageformat.desc', 'myproto', 'messagetype') FROM 'some/topic'

encode(value, encodingScheme)

根据编码方案，使用 encode 函数将负载（可能是非 JSON 数据）编码为字符串表示形式。SQL 版本 2016-03-23 及更高版本支持。

endswith(String, String)

返回 Boolean 来表示第一个 String 参数是否以第二个 String 参数结尾。如果任一参数为 Null 或 Undefined，则结果为 Undefined。SQL 版本 2015-10-08 及更高版本支持。

示例：endswith("cat","at") = true。

exp(Decimal)

返回 e 的 Decimal 参数次方。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：exp(1) = e。

floor(Decimal)

将给定的 Decimal 向下舍入到最接近的 Int。SQL 版本 2015-10-08 及更高版本支持。

示例：

floor(1.2) = 1

floor(-1.2) = -2

get

从一个集合数据类型 (数组、字符串、对象) 中提取值。第一个参数不会进行任何转换。根据表中的记载对第二个参数进行转换。SQL 版本 2015-10-08 及更高版本支持。

示例：

get(["a", "b", "c"], 1) = "b"

get({"a":"b"}, "a") = "b"

get("abc", 0) = "a"

get_dynamodb(tableName, partitionKeyName, partitionKeyValue, sortKeyName, sortKeyValue, roleArn)

从 DynamoDB 表中检索数据。get_dynamodb() 可让您在计算规则时查询 DynamoDB 表。您可以使用从 DynamoDB 中检索到的数据筛选或增加消息负载。SQL 版本 2016-03-23 及更高版本支持。

get_dynamodb() 接受以下参数：

举例说明如何使用get_dynamodb()，假设您有一个 DynamoDB 表，其中包含所有连接设备的设备 ID 和位置信息。Amazon IoT以下 SELECT 语句使用 get_dynamodb() 函数检索指定的设备 ID 的位置：

SELECT *, get_dynamodb("InServiceDevices", "deviceId", id, "arn:aws:iam::12345678910:role/getdynamo").location AS location FROM 'some/topic'

get_mqtt_property(name)

引用以下任何 MQTT5 标头：contentType、payLoadFormatIndicator、responseTopic 和 correlationData。此函数将以下任何文字字符串作为参数：content_type、format_indicator、response_topic 和 correlation_data。有关更多信息，请参阅以下函数参数表。

下表显示了可接受的函数参数，及其与 get_mqtt_property 函数相关的返回类型：

以下示例规则 SQL 引用下列任何 MQTT5 标头：contentType、payLoadFormatIndicator、responseTopic 和 correlationData。

SELECT *, get_mqtt_property('content_type') as contentType,
          get_mqtt_property('format_indicator') as payloadFormatIndicator,
          get_mqtt_property('response_topic') as responseTopic,
          get_mqtt_property('correlation_data') as correlationData
FROM 'some/topic'

get_secret(secretId, secretType, key, roleArn)

在 Amazon Secrets Manager 中检索密钥当前版本的加密 SecretString 或者 SecretBinary字段中的值。有关创建和维护密钥的更多信息，请参阅CreateSecretUpdateSecret、和PutSecretValue。

get_secret() 接受以下参数：

示例：

您可以在 HTTPS 规则操作中的身份验证标头里使用 get_secret 函数，如下面的 API 密钥身份验证示例所示。

"API_KEY": "${get_secret('API_KEY', 'SecretString', 'API_KEY_VALUE', 'arn:aws:iam::12345678910:role/getsecret')}"
            

有关 HTTPS 规则操作的更多信息，请参阅 HTTP。

get_thing_shadow(thingName, shadowName, roleARN)

返回指定事物的指定影子。SQL 版本 2016-03-23 及更高版本支持。

示例：

与命名的影子一起使用时，请提供 shadowName 参数。

SELECT * from 'topic/subtopic'
WHERE
    get_thing_shadow("MyThing","MyThingShadow","arn:aws:iam::123456789012:role/AllowsThingShadowAccess")
    .state.reported.alarm = 'ON'

与未命名的影子一起使用时，请省略 shadowName 参数。

SELECT * from 'topic/subtopic'
WHERE
    get_thing_shadow("MyThing","arn:aws:iam::123456789012:role/AllowsThingShadowAccess")
    .state.reported.alarm = 'ON'

获取用户属性 () userPropertyKey

引用用户属性，这是 MQTT5 中支持的一种类型的属性标头。

函数参数

对于邮件标题中的以下用户属性：

下表显示了预期的 SQL 行为：

以下示例规则 SQL 将用户属性（一种类型的 MQTT5 属性标头）引用到有效负载中：

SELECT *, get_user_properties('user defined property key') as userProperty
FROM 'some/topic'

哈希函数

Amazon IoT 可以提供以下哈希函数：

所有哈希函数都可以输入一个字符串参数。结果为该字符串的哈希值。对非字符串参数进行标准字符串转换。所有哈希函数在 SQL 版本 2015-10-08 及更高版本中均受支持。

示例：

md2("hello") = "a9046c73e00331af68917d3804f70655"

md5("hello") = "5d41402abc4b2a76b9719d911017c592"

indexof(String, String)

返回第二个参数的第一个索引 (从零开始) 作为第一个参数的子字符串。两个参数均为字符串。如果参数数据类型不是字符串，则应用标准字符串转换规则进行转换。此函数只对字符串有效，不适用于数组。SQL 版本 2016-03-23 及更高版本支持。

示例：

indexof("abcd", "bc") = 1

isNull()

如果参数为 Null 值，则返回 true。SQL 版本 2015-10-08 及更高版本支持。

示例：

isNull(5) = false。

isNull(Null) = true。

isUndefined()

如果参数为 Undefined，则返回 true。SQL 版本 2016-03-23 及更高版本支持。

示例：

isUndefined(5) = false。

isUndefined(floor([1,2,3]))) = true。

length(String)

返回输入字符数中的字符数。对非 String 参数应用标准转换规则。SQL 版本 2016-03-23 及更高版本支持。

示例：

length("hi") = 2

length(false) = 5

ln(Decimal)

返回参数的自然对数。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：ln(e) = 1。

log(Decimal)

返回参数的以 10 为底的对数。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：log(100) = 2.0。

lower(String)

返回给定 String 的小写版本。非字符串参数使用标准转换规则转换为字符串。SQL 版本 2015-10-08 及更高版本支持。

示例：

lower("HELLO") = "hello"。

lower(["HELLO"]) = "[\"hello\"]"。

lpad(String, Int)

返回 String 参数，在输入参数的左侧填充由第二个参数指定的数量的空格。Int 参数必须介于 0 到 1000 之间。如果提供的值在这一有效范围之外，则参数被设置为与其最近的值（0 或 1000）。SQL 版本 2015-10-08 及更高版本支持。

示例：

lpad("hello", 2) = "  hello".

lpad(1, 3) = "   1"

ltrim(String)

从提供的 String 中删除所有前导空白（制表符和空格）。SQL 版本 2015-10-08 及更高版本支持。

示例：

Ltrim(" h i ") = "hi "。

machinelearning_predict(modelId, roleArn, record)

使用该machinelearning_predict函数使用基于亚马逊SageMaker模型的 MQTT 消息中的数据进行预测。SQL 版本 2015-10-08 及更高版本支持。machinelearning_predict 函数的参数如下：

该函数返回具有以下字段的 JSON 对象：

mod(Decimal, Decimal)

返回第一个参数除以第二个参数的余数。等效于 remainder(Decimal, Decimal)。您还可以使用“%”作为相同取模功能的插入运算符。SQL 版本 2015-10-08 及更高版本支持。

示例：mod(8, 3) = 2。

nanvl (AnyValue,) AnyValue

如果第一个参数为有效的 Decimal，则返回第一个参数。否则，返回第二个参数。SQL 版本 2015-10-08 及更高版本支持。

示例：Nanvl(8, 3) = 8。

newuuid()

返回随机的 16 字节 UUID。SQL 版本 2015-10-08 及更高版本支持。

示例：newuuid() = 123a4567-b89c-12d3-e456-789012345000

numbytes(String)

返回输入字符串 UTF-8 编码中的字节数。对非 String 参数应用标准转换规则。SQL 版本 2016-03-23 及更高版本支持。

示例：

numbytes("hi") = 2

numbytes("€") = 3

parse_time(String, Long[, String])

使用 parse_time 函数可将时间戳的格式设置为人类可读的日期/时间格式。SQL 版本 2016-03-23 及更高版本支持。要将时间戳字符串转换为毫秒，请参阅 time_to_epoch(String, String)。

parse_time 函数采用下列参数：

示例：

在将此消息发布到主题“A/B”时，负载 {"ts": "1970.01.01 AD at 21:46:40 CST"} 发送到 S3 存储桶：

{
    "ruleArn": "arn:aws:iot:us-east-2:ACCOUNT_ID:rule/RULE_NAME",
    "topicRulePayload": {
        "sql": "SELECT parse_time(\"yyyy.MM.dd G 'at' HH:mm:ss z\", 100000000, 'America/Belize' ) as ts FROM 'A/B'",

        "ruleDisabled": false,
        "awsIotSqlVersion": "2016-03-23",
        "actions": [
            {
                "s3": {
                    "roleArn": "arn:aws:iam::ACCOUNT_ID:rule:role/ROLE_NAME",
                    "bucketName": "BUCKET_NAME",
                    "key": "KEY_NAME"
                }
            }
        ],
        "ruleName": "RULE_NAME"
    }
} 

在将此消息发布到主题“A/B”时，与 {"ts": "2017.06.09 AD at 17:19:46 UTC"} 类似（但具有当前日期/时间）的负载发送到 S3 存储桶：

{
    "ruleArn": "arn:aws:iot:us-east-2:ACCOUNT_ID:rule/RULE_NAME",
    "topicRulePayload": {
        "sql": "SELECT parse_time(\"yyyy.MM.dd G 'at' HH:mm:ss z\", timestamp() ) as ts FROM 'A/B'",
        "awsIotSqlVersion": "2016-03-23",
        "ruleDisabled": false,
        "actions": [
            {
                "s3": {
                    "roleArn": "arn:aws:iam::ACCOUNT_ID:rule:role/ROLE_NAME",
                    "bucketName": "BUCKET_NAME",
                    "key": "KEY_NAME"
                }
            }
        ],
        "ruleName": "RULE_NAME"
    }
} 

parse_time() 也可用作替换模板。例如，在将此消息发布到主题“A/B”时，负载发送到密钥为“2017”的 S3 存储桶：

{
    "ruleArn": "arn:aws:iot:us-east-2:ACCOUNT_ID:rule/RULE_NAME",
    "topicRulePayload": {
        "sql": "SELECT * FROM 'A/B'",
        "awsIotSqlVersion": "2016-03-23",
        "ruleDisabled": false,
        "actions": [{
            "s3": {
                "roleArn": "arn:aws:iam::ACCOUNT_ID:rule:role/ROLE_NAME",
                "bucketName": "BUCKET_NAME",
                "key": "${parse_time('yyyy', timestamp(), 'UTC')}"
            }
        }],
        "ruleName": "RULE_NAME"
    }
}

power(Decimal, Decimal)

返回第一个参数的第二个参数次幂的值。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。SQL 版本 2015-10-08 及更高版本支持。

示例：power(2, 5) = 32.0。

principal()

返回设备用于身份验证的委托人，取决于触发消息的发布方式。下表介绍了为每个发布方法和协议返回的委托人。

下面的示例展示了 principal() 能够返回的不同类型的值：

rand()

返回在 0.0 到 1.0 之间均匀分布的伪随机双精度值。SQL 版本 2015-10-08 及更高版本支持。

示例：

rand() = 0.8231909191640703

regexp_matches(String, String)

如果字符串（第一个参数）包含正则表达式（第二个参数）的匹配项，则返回 true。

示例：

regexp_matches("aaaa", "a{2,}") = true。

regexp_matches("aaaa", "b") = false。

第二个参数：

必须是有效的正则表达式。非字符串类型使用标准转换规则转换为 String。根据类型，生成的字符串可能不是有效的正则表达式。如果（转换后的）参数不是有效的正则表达式，则结果为 Undefined。

regexp_replace(String, String, String)

用第三个参数替换在第一个参数中出现的所有第二个参数 (正则表达式)。用“$”引用捕获组。SQL 版本 2015-10-08 及更高版本支持。

示例：

regexp_replace("abcd", "bc", "x") = "axd"。

regexp_replace("abcd", "b(.*)d", "$1") = "ac"。

第二个参数：

必须是有效的正则表达式。非字符串类型使用标准转换规则转换为 String。根据类型，生成的字符串可能不是有效的正则表达式。如果（转换后的）参数不是有效的正则表达式，则结果为 Undefined。

第三个参数：

必须是有效的正则表达式替代字符串。（可以引用捕获组。） 非字符串类型使用标准转换规则转换为 String。如果（转换后的）参数不是有效的正则表达式替代字符串，则结果为 Undefined。

regexp_substr(String, String)

在第一个参数中查找第二个参数（正则表达式）的第一个匹配项。用“$”引用捕获组。SQL 版本 2015-10-08 及更高版本支持。

示例：

regexp_substr("hihihello", "hi") = "hi"

regexp_substr("hihihello", "(hi)*") = "hihi"

第二个参数：

必须是有效的正则表达式。非字符串类型使用标准转换规则转换为 String。根据类型，生成的字符串可能不是有效的正则表达式。如果（转换后的）参数不是有效的正则表达式，则结果为 Undefined。

remainder(Decimal, Decimal)

返回第一个参数除以第二个参数的余数。等效于 mod(Decimal, Decimal)。您还可以使用“%”作为相同取模功能的插入运算符。SQL 版本 2015-10-08 及更高版本支持。

示例：remainder(8, 3) = 2。

replace(String, String, String)

用第三个参数替换在第一个参数中出现的所有第二个参数。SQL 版本 2015-10-08 及更高版本支持。

示例：

replace("abcd", "bc", "x") = "axd".

replace("abcdabcd", "b", "x") = "axcdaxcd".

rpad(String, Int)

返回字符串参数，在输入参数的右侧填充在第二个参数中指定的数量的空格。Int 参数必须介于 0 到 1000 之间。如果提供的值在这一有效范围之外，则参数被设置为与其最近的值（0 或 1000）。SQL 版本 2015-10-08 及更高版本支持。

示例：

rpad("hello", 2) = "hello  ".

rpad(1, 3) = "1   ".

round(Decimal)

将给定的 Decimal 舍入到最近的 Int。如果 Decimal 与上下两个 Int 值距离相同 (例如 0.5)，Decimal 将向上进位。SQL 版本 2015-10-08 及更高版本支持。

示例：Round(1.2) = 1。

Round(1.5) = 2。

Round(1.7) = 2。

Round(-1.1) = -1。

Round(-1.5) = -2。

rtrim(String)

从提供的 String 中删除所有尾随空白（制表符和空格）。SQL 版本 2015-10-08 及更高版本支持。

示例：

rtrim(" h i ") = " h i"

sign(Decimal)

返回给定数字的符号。当参数的符号为正时，将返回 1。当参数的符号为负时，将返回 -1。如果参数为 0，则返回 0。SQL 版本 2015-10-08 及更高版本支持。

示例：

sign(-7) = -1。

sign(0) = 0。

sign(13) = 1。

sin(Decimal)

以弧度为单位返回数字的正弦值。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：sin(0) = 0.0

sinh(Decimal)

以弧度为单位返回数字的双曲正弦值。在代入函数之前，Decimal 值舍入到双精度。结果是双精度的 Decimal 值。SQL 版本 2015-10-08 及更高版本支持。

示例：sinh(2.3) = 4.936961805545957

substring(String, Int[, Int])

输入值为 String 后跟一个或两个 Int 值。对于 String 和单个 Int 参数，此函数在输入的 String 中从指定的 Int 索引 (从零开始，包括零) 到 String 结束提取子字符串并返回。对于 String 和两个 Int 参数，此函数在输入的 String 中从第一个 Int 索引参数 (从零开始，包括零) 到第二个 Int 索引参数 (从零开始，包括零) 提取子字符串并返回。索引小于零时将设置为零。大于 String 长度的索引设置为 String 长度。在三个参数的版本中，如果第一个索引大于等于第二个索引，那么结果为空 String。

 如果提供的参数不是 (String、Int) 或 (String、Int、Int)，则系统会对参数进行标准转换，尽量将其转换为正确的类型。如果无法转换类型，函数的结果为 Undefined。SQL 版本 2015-10-08 及更高版本支持。

示例：

substring("012345", 0) = "012345"。

substring("012345", 2) = "2345"。

substring("012345", 2.745) = "2345"。

substring(123, 2) = "3"。

substring("012345", -1) = "012345"。

substring(true, 1.2) = "rue"。

substring(false, -2.411E247) = "false"。

substring("012345", 1, 3) = "12"。

substring("012345", -50, 50) = "012345"。

substring("012345", 3, 1) = "".

sql_version()

返回此规则中指定的 SQL 版本。SQL 版本 2015-10-08 及更高版本支持。

示例：

sql_version() = "2016-03-23"

sqrt(Decimal)

返回数字的平方根。在代入函数之前，Decimal 参数舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：sqrt(9) = 3.0。

startswith(String, String)

返回显示第一个字符串参数是否以第二个字符串参数开头的 Boolean。如果任一参数为 Null 或 Undefined，则结果为 Undefined。SQL 版本 2015-10-08 及更高版本支持。

示例：

startswith("ranger","ran") = true

tan(Decimal)

以弧度为单位返回数字的正切值。在代入函数之前，Decimal 值舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：tan(3) = -0.1425465430742778

tanh(Decimal)

以弧度为单位返回数字的双曲正切值。在代入函数之前，Decimal 值舍入到双精度。SQL 版本 2015-10-08 及更高版本支持。

示例：tanh(2.3) = 0.9800963962661914

time_to_epoch(String, String)

使用 time_to_epoch 函数将时间戳字符串转换为 Unix 纪元时间的毫秒数。SQL 版本 2016-03-23 及更高版本支持。要将毫秒转换为格式化的时间戳字符串，请参阅 parse_time(String, Long[, String])。

time_to_epoch 函数采用下列参数：

示例：

time_to_epoch("2020-04-03 09:45:18 UTC+01:00", "yyyy-MM-dd HH:mm:ss VV") = 1585903518000

time_to_epoch("18 December 2015", "dd MMMM yyyy") = 1450396800000

time_to_epoch("2007-12-03 10:15:30.592 America/Los_Angeles", "yyyy-MM-dd HH:mm:ss.SSS z") = 1196705730592

timestamp()

返回 Amazon IoT 规则引擎观察到的当前时间戳，用距离 1970 年 1 月 1 日（星期四）协调世界时 (UTC) 00:00:00 的毫秒数来表示。SQL 版本 2015-10-08 及更高版本支持。

示例：timestamp() = 1481825251155

topic(Decimal)

返回已向其发送触发规则的消息的主题。如果未指定参数，则返回整个主题。Decimal 参数用于指定特定主题段，使用 1 指定第一个段。对于主题 foo/bar/baz，主题 (1) 将返回 foo，主题 (2) 将返回 bar，以此类推。SQL 版本 2015-10-08 及更高版本支持。

示例：

topic() = "things/myThings/thingOne"

topic(1) = "things"

在使用基本提取功能时，主题的初始前缀 ($aws/rules/rule-name) 对 topic() 函数不可用。例如，给定以下主题：

$aws/rules/BuildingManager/Buildings/Building5/Floor2/Room201/Lights

topic() = "Buildings/Building5/Floor2/Room201/Lights"

topic(3) = "Floor2"

traceid()

返回 MQTT 消息的跟踪 ID (UUID)，如果未通过 MQTT 发送消息，则返回 Undefined。SQL 版本 2015-10-08 及更高版本支持。

示例：

traceid() = "12345678-1234-1234-1234-123456789012"

transform(String, Object, Array)

返回对象数组，其中包含 Object 参数对 Array 参数的指定转换结果。

SQL 版本 2016-03-23 及更高版本支持。

变换函数示例 1

此示例演示如何使用 transform() 函数从数据对象和数组中生成单个对象数组。

在此示例中，将以下消息将发布到 MQTT 主题 A/B。

{
    "attributes": {
        "data1": 1,
        "data2": 2
    },
    "values": [
        {
            "a": 3
        },
        {
            "b": 4
        },
        {
            "c": 5
        }
    ]
}

此用于主题规则操作的 SQL 语句使用 String 值为 enrichArray 的 transform() 函数。在本例中，Object 是来自消息负载的 attributes 属性，而 Array 是 values 数组，其中包含三个对象。

select value transform("enrichArray", attributes, values) from 'A/B'

在收到消息负载后，SQL 语句将计算以下响应。

[
  {
    "a": 3,
    "data1": 1,
    "data2": 2
  },
  {
    "b": 4,
    "data1": 1,
    "data2": 2
  },
  {
    "c": 5,
    "data1": 1,
    "data2": 2
  }
]

变换函数示例 2

此示例演示 transform() 函数如何使用文本值来包含和重命名消息负载中的单个属性。

在此示例中，将以下消息将发布到 MQTT 主题 A/B。此消息与 变换函数示例 1 中使用的消息相同。

{
    "attributes": {
        "data1": 1,
        "data2": 2
    },
    "values": [
        {
            "a": 3
        },
        {
            "b": 4
        },
        {
            "c": 5
        }
    ]
}

此用于主题规则操作的 SQL 语句使用 String 值为 enrichArray 的 transform() 函数。transform() 函数中的 Object 在消息负载中具有一个名为 key 的单一属性，该属性的值为 attributes.data1，而 Array 是 values 数组，其中包含与上一个示例中使用的三个相同对象。

select value transform("enrichArray", {"key": attributes.data1}, values) from 'A/B'

收到消息负载后，此 SQL 语句将计算为以下响应。请注意 data1 属性在 key 响应中是如何命名的。

[
  {
    "a": 3,
    "key": 1
  },
  {
    "b": 4,
    "key": 1
  },
  {
    "c": 5,
    "key": 1
  }
]

变换函数示例 3

此示例演示如何使用 transform() 函数可在嵌套 SELECT 子句中选择多个属性并创建新对象以供后续处理。

在此示例中，将以下消息将发布到 MQTT 主题 A/B。

{
  "data1": "example",
  "data2": {
    "a": "first attribute",
    "b": "second attribute",
    "c": [
      {
        "x": {
          "someInt": 5,
          "someString": "hello"
        },
        "y": true
      },
      {
        "x": {
          "someInt": 10,
          "someString": "world"
        },
        "y": false
      }
    ]
  }
}

此转换函数的 Object 是 SELECT 语句返回的对象，其中包含消息的 data2 对象的 a 和 b 元素。Array 参数包括两个来自原始消息中 data2.c 数组的对象。

select value transform('enrichArray', (select a, b from data2), (select value c from data2)) from 'A/B'

借助前面的消息，SQL 语句将计算以下响应。

[
  {
    "x": {
      "someInt": 5,
      "someString": "hello"
    },
    "y": true,
    "a": "first attribute",
    "b": "second attribute"
  },
  {
    "x": {
      "someInt": 10,
      "someString": "world"
    },
    "y": false,
    "a": "first attribute",
    "b": "second attribute"
  }
]

此响应中返回的数组可以用于支持 batchMode 的主题规则操作。

trim(String)

从提供的 String 中删除所有前导空白和尾随空白。SQL 版本 2015-10-08 及更高版本支持。

示例：

Trim(" hi ") = "hi"

trunc(Decimal, Int)

按照第二个参数指定的 Decimal 位数截断第一个参数。如果第二个参数小于零，则它会设置为零。如果第二个参数大于 34，则它会设置为 34。将从结果中删除结尾的零。SQL 版本 2015-10-08 及更高版本支持。

示例：

trunc(2.3, 0) = 2。

trunc(2.3123, 2) = 2.31。

trunc(2.888, 2) = 2.88。

trunc(2.00, 5) = 2。

upper(String)

返回给定 String 的大写版本。非 String 参数将使用标准转换规则转换为 String。SQL 版本 2015-10-08 及更高版本支持。

示例：

upper("hello") = "HELLO"

upper(["hello"]) = "[\"HELLO\"]"