翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

関数

SQL 式の SELECT 句または WHERE 句では、以下の組み込み関数を使用できます。

abs(10 進数)

数値の絶対値を返します。SQL バージョン 2015-10-08 以降でサポートされています。

例: abs(-5) は 5 を返します。

accountid()

String としてこのルールを所有するアカウントの ID を返します。SQL バージョン 2015-10-08 以降でサポートされています。

例:

accountid() = "123456789012"

acos(10 進数)

数値の逆コサインをラジアンで返します。Decimal 引数は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例: acos(0) = 1.5707963267948966

asin(10 進数)

数値の逆サインをラジアンで返します。Decimal 引数は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例: asin(0) = 0.0

atan(10 進数)

数値の逆タンジェントをラジアンで返します。Decimal 引数は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例: atan(0) = 0.0

atan2(10 進数、10 進数)

正の X 軸と 2 つの引数で定義された点 (x、y) の間の角度をラジアンで返します。 反時計回りの角度では正で (上半面、y > 0)、時計回りの角度では負です (下反面、y < 0)。Decimal 引数は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例: atan2(1, 0) = 1.5707963267948966

aws_lambda(functionArn, inputJson)

inputJson を Lambda 関数に渡して指定された Lambda 関数を呼び出し、Lambda 関数で生成された JSON を返します。

指定された Lambda 関数を呼び出すアクセス許可を付与 AWS IoT lambda:InvokeFunctionする必要があります。次の例は、lambda:InvokeFunction を使用して AWS CLI権限を付与する方法を示しています。

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 は、'topic/subtopic' トピックで発行されたメッセージからデータを選択します。

some.value は、Lambda 関数によって生成された出力からデータを選択します。

bitand(Int、Int)

2 つの Int (-converted) 引数のビット表現におけるビット単位の AND を実行します。SQL バージョン 2015-10-08 以降でサポートされています。

例: bitand(13, 5) = 5

bitor(Int、Int)

2 つの引数のビット表現のビット単位の OR を実行します。SQL バージョン 2015-10-08 以降でサポートされています。

例: bitor(8, 5) = 13

bitxor(Int、Int)

2 つの Int (-converted) 引数のビット表現におけるビット単位の XOR を実行します。SQL バージョン 2015-10-08 以降でサポートされています。

例: bitor(13, 5) = 8

bitnot(Int)

Int (-converted) 引数のビット表現におけるビット単位の NOT を実行します。SQL バージョン 2015-10-08 以降でサポートされています。

例: bitnot(13) = 2

cast()

値を 1 つのデータ型から別のデータ型へ変換します。cast は通常の変換と同様に動作し、数値をブールへ/からキャストする追加機能があります。が 1 つのタイプを別のタイプにキャストする方法を決定 AWS IoT できない場合、結果は になりますUndefined。SQL バージョン 2015-10-08 以降でサポートされています。形式: cast(値 as 型)。

例:

cast(true as Int) = 1

cast を呼び出す際、次のキーワードが「as」の後に表示される場合があります。

キャストのルール:

ceil(10 進数)

指定の Decimal を最も近い Int に切り上げます。SQL バージョン 2015-10-08 以降でサポートされています。

例:

ceil(1.2) = 2

ceil(-1.2) = -1

chr(文字列)

指定の 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(10 進数)

数値のコサインをラジアンで返します。Decimal 引数は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例:

cos(0) = 1.

cosh(10 進数)

数値のハイパーボリックコサインをラジアンで返します。Decimal 引数は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例: cosh(2.3) = 5.037220649268761。

decode(value, 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 メッセージペイロードのデコード

decode SQL 関数を使用して、protobuf メッセージペイロードをデコードできるルールを設定できます。詳細については、「protobuf メッセージペイロードのデコード」を参照してください。

この関数の署名は次のようになります。

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

decode SQL 関数を使用した SQL 式の例は次のようになります。

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

encode(value, encodingScheme)

エンコードスキームに基づいて、ペイロード (非 JSON データの場合もある) を文字列表現にエンコードするには、encode 関数を使用します。SQL バージョン 2016-03-23 以降でサポートされています。

endswith(文字列、文字列)

Boolean を返し、最初の String 引数が 2 番目の String 引数で終わるかどうかを示します。どちらかの引数が Null または Undefined の場合、結果は Undefined です。SQL バージョン 2015-10-08 以降でサポートされています。

例: endswith("cat","at") = true。

exp(10 進数)

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

コレクションのような型から値を抽出します (配列、文字列、オブジェクト)。最初の引数に変換は適用されません。テーブルで説明されているように、変換は 2 番目の引数に適用されます。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() の使用方法の例として、 AWS IoTに接続されているすべてのデバイスのデバイス ID と位置情報を含む DynamoDB テーブルがあるとします。次の 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 ルール例では、contentType、payLoadFormatIndicator、responseTopic、correlationData のいずれかの MQTT5 ヘッダーを参照しています。

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)

AWS Secrets Manager の現在のバージョンのシークレットの暗号化された SecretString または SecretBinary フィールドの値を取得します。シークレットの作成と保守の詳細については、CreateSecret「」、UpdateSecret「」、および「」を参照してくださいPutSecretValue。

get_secret() には以下のパラメータがあります。

例:

次の API キー認証の例のように、HTTPS ルールアクションの認証ヘッダーで get_secret 関数を使用できます。

"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'

get_user_properties(userPropertyKey）

MQTT5 でサポートされているプロパティヘッダーの一種であるユーザープロパティを参照します。

関数の引数

メッセージヘッダー内の以下のユーザープロパティの場合:

次の表に、予想される SQL の動作を示します。

以下の SQL ルール例では、ユーザープロパティ (MQTT5 プロパティヘッダーの一種) をペイロードに参照しています。

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

ハッシュ関数

AWS IoT には、次のハッシュ関数が用意されています。

1 つの文字列引数を除くすべてのハッシュ関数。結果はその文字列のハッシュ値です。標準文字列変換は非文字列引数に適用されます。すべてのハッシュ関数は、SQL バージョン 2015-10-08 以降でサポートされます。

例:

md2("hello") = "a9046c73e00331af68917d3804f70655"

md5("hello") = "5d41402abc4b2a76b9719d911017c592"

indexof(文字列、文字列)

最初の引数のサブ文字列として、2 番目の引数の最初のインデックス (ゼロベース) を返します。両方の引数は文字列であることが期待されます。文字列ではない引数は、標準文字列変換ルールに従います。この関数は、配列にではなく、文字列にのみ適用されます。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 引数に適用されます。SQL バージョン 2016-03-23 以降でサポートされています。

例:

length("hi") = 2

length(false) = 5

ln(10 進数)

引数の自然対数を返します。Decimal 引数は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例: ln(e) = 1。

log(10 進数)

引数の 10 を底とする対数を返します。Decimal 引数は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例: log(100) = 2.0。

lower(文字列)

指定した String の小文字バージョンを返します。非文字列引数は標準変換ルールを使用して文字列に変換されます。SQL バージョン 2015-10-08 以降でサポートされています。

例:

lower("HELLO") = "hello"。

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

lpad(文字列、Int)

2 番目の引数で指定された数のスペースを左詰めにした String 引数を返します。Int 引数は、0 ～ 1000 の間である必要があります。提供された値がこの有効な範囲の外にある場合は、引数は最も近い有効な値に設定されます (0 または 1000)。SQL バージョン 2015-10-08 以降でサポートされています。

例:

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

lpad(1, 3) = "   1"

ltrim(文字列)

提供される String から先頭の空白 (タブとスペース) をすべて削除します。SQL バージョン 2015-10-08 以降でサポートされています。

例:

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

machinelearning_predict (modelId, roleArn, record)

machinelearning_predict 関数を使用して、Amazon SageMaker モデルに基づいて MQTT メッセージからのデータを使用して予測を行います。SQL バージョン 2015-10-08 以降でサポートされています。machinelearning_predict 関数の引数は次のとおりです。

この関数では、次のフィールドを持つ JSON オブジェクトが返されます。

mod(10 進数、10 進数)

最初の引数を 2 番目の引数で割ったときの剰余を返します。remainder(Decimal, Decimal) と同等です。同じモジュロ機能に挿入演算子として「%」も使用できます。SQL バージョン 2015-10-08 以降でサポートされています。

例: mod(8, 3) = 2。

nanvl(AnyValue， AnyValue）

最初の引数が有効な Decimal ならば、最初の引数が返されます。それ以外の場合、2 番目の引数が返されます。SQL バージョン 2015-10-08 以降でサポートされています。

例: Nanvl(8, 3) = 8。

newuuid()

16 バイトのランダムな UUID を返します。SQL バージョン 2015-10-08 以降でサポートされています。

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

numbytes(文字列)

指定された文字列の 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」に公開されると、ペイロードは S3 バケットに key = 「2017」で送信されます。

{
    "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(10 進数、10 進数)

最初の引数を 2 番目の引数の累乗にして返します。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(文字列、文字列)

文字列 (最初の引数) に、正規表現 (2 番目の引数) の一致が含まれている場合は、true を返します。正規表現|で を使用する場合は、 で使用します()。

例:

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

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

regexp_matches("aaa", "(aaa|bbb)") = true。

regexp_matches("bbb", "(aaa|bbb)") = true。

regexp_matches("ccc", "(aaa|bbb)") = false。

2 番目の引数:

有効な正規表現の式である必要があります。非文字列型は標準変換ルールを使用して String に変換されます。型により、結果として生じる文字列が有効な正規表現でない場合もあります。(変換された) 引数が有効な正規表現でない場合、結果は Undefined です。

regexp_replace(文字列、文字列、文字列)

最初の引数にある 2 番目の引数 (正規表現) の出現すべてを 3 番目の引数で置き換えます。「$」でキャプチャグループを参照します。SQL バージョン 2015-10-08 以降でサポートされています。

例:

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

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

2 番目の引数:

有効な正規表現の式である必要があります。非文字列型は標準変換ルールを使用して String に変換されます。型により、結果として生じる文字列が有効な正規表現でない場合もあります。(変換された) 引数が有効な正規表現でない場合、結果は Undefined です。

3 番目の引数:

有効な正規表現の置換文字列である必要があります。(キャプチャグループを参照できます。) 非文字列型は標準変換ルールを使用して String に変換されます。(変換された) 引数が有効な正規表現の置換文字列でない場合、結果は Undefined です。

regexp_substr(文字列、文字列)

最初のパラメータにある 2 番目のパラメータ (正規表現) の最初の一致を見つけます。「$」でキャプチャグループを参照します。SQL バージョン 2015-10-08 以降でサポートされています。

例:

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

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

2 番目の引数:

有効な正規表現の式である必要があります。非文字列型は標準変換ルールを使用して String に変換されます。型により、結果として生じる文字列が有効な正規表現でない場合もあります。(変換された) 引数が有効な正規表現でない場合、結果は Undefined です。

remainder(Decimal, Decimal)

最初の引数を 2 番目の引数で割ったときの剰余を返します。mod(10 進数、10 進数) と同等です。同じモジュロ機能に挿入演算子として「%」も使用できます。SQL バージョン 2015-10-08 以降でサポートされています。

例: remainder(8, 3) = 2。

replace(String, String, String)

最初の引数にある 2 番目の引数の出現すべてを 3 番目の引数で置き換えます。SQL バージョン 2015-10-08 以降でサポートされています。

例:

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

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

rpad(文字列、Int)

2 番目の引数で指定された数のスペースを右詰めにした文字列の引数を返します。Int 引数は、0 ～ 1000 の間である必要があります。提供された値がこの有効な範囲の外にある場合は、引数は最も近い有効な値に設定されます (0 または 1000)。SQL バージョン 2015-10-08 以降でサポートされています。

例:

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

rpad(1, 3) = "1   ".

round(10 進数)

指定の Decimal を最も近い Int に丸めます。Decimal が 2 つの 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 から末尾の空白 (タブとスペース) をすべて削除します。SQL バージョン 2015-10-08 以降でサポートされています。

例:

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

sign(10 進数)

指定された数値の符号を返します。引数の符号が正の場合、1 を返します。引数の符号が負の場合、-1 を返します。引数が 0 の場合、0 を返します。SQL バージョン 2015-10-08 以降でサポートされています。

例:

sign(-7) = -1.

sign(0) = 0.

sign(13) = 1.

sin(10 進数)

数値のサインをラジアンで返します。Decimal 引数は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例: sin(0) = 0.0

sinh(10 進数)

数値のハイパーボリックサインを返します。Decimal 値は関数適用の前に倍精度に丸められます。結果は倍精度の Decimal 値です。SQL バージョン 2015-10-08 以降でサポートされています。

例: sinh(2.3) = 4.936961805545957

sourceip()

デバイスまたはそれに接続するルーターの IP アドレスを取得します。デバイスがインターネットに直接接続されている場合、この関数はデバイスの送信元 IP アドレスを返します。デバイスがインターネットに接続するルーターに接続されている場合、関数はルーターの送信元 IP アドレスを返します。SQL バージョン 2016-03-23 でサポートされています。sourceip() はパラメータを取得しません。

例:

sourceip()="192.158.1.38"

sourceip()="1.102.103.104"

sourceip()="2001:db8:ff00::12ab:34cd"

SQL 例:

SELECT *, sourceip() as deviceIp FROM 'some/topic'

AWS IoT Core ルールアクションで sourceip() 関数を使用する方法の例：

例 1

次の例は、DynamoDB アクションで () 関数を代替テンプレートとして呼び出す方法を示しています。

{
	"topicRulePayload": {
		"sql": "SELECT * AS message FROM 'some/topic'",
		"ruleDisabled": false,
		"awsIotSqlVersion": "2016-03-23",
		"actions": [
			{
				"dynamoDB": {
					"tableName": "my_ddb_table",
					"hashKeyField": "key",
					"hashKeyValue": "${sourceip()}",
					"rangeKeyField": "timestamp",
					"rangeKeyValue": "${timestamp()}",
					"roleArn": "arn:aws:iam::123456789012:role/aws_iot_dynamoDB"
				}
			}
		]
	}
}

例 2

次の例は、代替テンプレートを使用して sourceip () 関数を MQTT ユーザープロパティとして追加する方法を示しています。

{
	"topicRulePayload": {
		"sql": "SELECT * FROM 'some/topic'",
		"ruleDisabled": false,
		"awsIotSqlVersion": "2016-03-23",
		"actions": [
			{
				"republish": {
					"topic": "${topic()}/republish",
					"roleArn": "arn:aws:iam::123456789012:role/aws_iot_republish",
					"headers": {
						"payloadFormatIndicator": "UTF8_DATA",
						"contentType": "rule/contentType",
						"correlationData": "cnVsZSBjb3JyZWxhdGlvbiBkYXRh",
						"userProperties": [
							{
								"key": "ruleKey1",
								"value": "ruleValue1"
							},
							{
								"key": "sourceip",
								"value": "${sourceip()}"
							}
						]
					}
				}
			}
		]
	}
}            

メッセージブローカーと基本的な取り込みパスの両方から AWS IoT Core ルールに渡すメッセージから送信元 IP アドレスを取得できます。IPv4 と IPv6 の両方のメッセージの両方の送信元 IP アドレスを使用できます。送信元 IP は次のように表示されます。

IPv6: yyyy:yyyy:yyyy::yyyy:yyyy

IPv4:xxx.xxx.xxx.xxx

substring(String, Int[, Int])

1 つか 2 つの String 値が続く Int を予想します。String および単一の Int 引数では、この関数は提供された String インデックス (ゼロベース、包括) から Int の端までの提供された String のサブストリングを返します。String および 2 つの Int 引数では、この関数は、最初の String インデックス引数 (ゼロベース、包括) から 2 番目の Int インデックス引数 (ゼロベース、除外) までの提供された Int のサブストリングを返します。ゼロ以下のインデックスはゼロに設定されます。String の長さを超過するインデックスは String の長さに設定されます。3 つの引数バージョンでは、最初のインデックスが 2 番目インデックスより大きい (または等しい) 場合、結果は空の 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(10 進数)

数値の平方根を返します。Decimal 引数は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例: sqrt(9) = 3.0。

startswith(文字列、文字列)

最初の文字列引数が 2 番目の文字列引数で始まるかどうか、Boolean を返します。どちらかの引数が Null または Undefined の場合、結果は Undefined です。SQL バージョン 2015-10-08 以降でサポートされています。

例:

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

tan(10 進数)

数値のタンジェントをラジアンで返します。Decimal 値は関数適用の前に倍精度に丸められます。SQL バージョン 2015-10-08 以降でサポートされています。

例: tan(3) = -0.1425465430742778

tanh(10 進数)

数値のハイパーボリックタンジェントをラジアンで返します。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()

AWS IoT ルールエンジンによって観測された 1970 年 1 月 1 日木曜日の協定世界時 (UTC) からの現在のタイムスタンプをミリ秒単位で返します。SQL バージョン 2015-10-08 以降でサポートされています。

例: timestamp() = 1481825251155

topic(10 進数)

ルールをトリガーしたメッセージが送信されたトピックを返します。パラメータが指定されていない場合、トピック全体が返されます。Decimal パラメータは、特定のトピックセグメントを指定するために使用され、1 は最初のセグメントを表します。foo/bar/baz トピックでは、topic(1) は foo を返し、topic(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)

Array パラメータの Object パラメータの指定された変換の結果を含むオブジェクトの配列を返します。

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 は 3 つのオブジェクトを含む 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 にはメッセージペイロードの値が attributes.data1 である key という単一属性が含まれており、Array は、前述の例で使用されたものと同じ 3 つのオブジェクトを含む 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

この例では、ネストされた SELECT 句で transform() 関数を使用して、複数の属性を選択し、後続の処理のために新しいオブジェクトを作成する方法を示します。

この例では、次のメッセージが 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 は、メッセージの data2 オブジェクトの a 要素と b 要素を含む SELECT ステートメントによって返されるオブジェクトです。Array パラメータは、元のメッセージの data2.c 配列の 2 つのオブジェクトで構成されます。

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 から、すべての先頭および末尾の空白を削除します。SQL バージョン 2015-10-08 以降でサポートされています。

例:

Trim(" hi ") = "hi"

trunc(10 進数、Int)

2 番目の引数で指定された Decimal の場所の数で最初の引数を切り捨てます。2 番目の引数がゼロよりより少ない場合は、ゼロに設定されます。2 番目の引数が 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 に変換されます。SQL バージョン 2015-10-08 以降でサポートされています。

例:

upper("hello") = "HELLO"

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