As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Funções

Você pode usar as seguintes funções integradas nas cláusulas SELECT ou WHERE das expressões do SQL.

abs(Decimal)

Gera o valor absoluto de um número. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: abs(-5) gera 5.

accountid()

Gera o ID da conta que possui essa regra como uma String. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

accountid() = "123456789012"

acos(Decimal)

Gera o cosseno inverso de um número em radianos. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: acos(0) = 1,5707963267948966

asin(Decimal)

Gera o seno inverso de um número em radianos. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: asin(0) = 0,0

atan(Decimal)

Gera a tangente inversa de um número em radianos. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: atan(0) = 0,0

atan2(Decimal, Decimal)

Gera o ângulo, em radianos, entre o eixo X positivo e o ponto (x, y) definido nos dois argumentos.  O ângulo é positivo para os ângulos em sentido anti-horário (metade superior, y > 0) e negativo para os ângulos em sentido horário (metade inferior, y < 0). Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: atan2(1, 0) = 1,5707963267948966

aws_lambda(functionArn, inputJson)

Chama a função do Lambda especificada passando inputJson para a função do Lambda e retorna o JSON gerado pela função do Lambda.

Você deve conceder AWS IoT lambda:InvokeFunction permissões para invocar a função Lambda especificada. O seguinte exemplo mostra como conceder a permissão lambda:InvokeFunction usando a 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"

Veja os argumentos do comando add-permission:

Dada uma carga da mensagem JSON como:

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

A função do aws_lambda pode ser usada para chamar a função do Lambda da seguinte forma.

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

Se você deseja passar a carga da mensagem MQTT completa, especifique a carga JSON usando "*", como no exemplo a seguir.

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

payload.inner.element seleciona dados de mensagem publicada no tópico 'tópico/subtópico'.

some.value seleciona dados da saída gerada pela função do Lambda.

bitand(Int, Int)

Realiza um bitwise AND nas representações do bit dos dois argumentos Int(-convertido). Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: bitand(13, 5) = 5

bitor(Int, Int)

Executa um bitwise OU das representações de bit dos dois argumentos. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: bitor(8, 5) = 13

bitxor(Int, Int)

Realiza um bitwise XOR nas representações do bit dos dois argumentos Int(-convertido). Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:bitor(13, 5) = 8

bitnot(Int)

Realiza um bitwise NOT nas representações do bit do argumento Int(-convertido). Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: bitnot(13) = 2

cast()

Converte um valor de um tipo de dados para outro. O cast é muito parecido com as conversões padrão, com a adição da capacidade de converter números em ou de boolianos. Se AWS IoT não conseguir determinar como converter um tipo em outro, o resultado éUndefined. Compatível com a versão de 08/10/2015 do SQL e posteriores. Formato: cast(valor as tipo).

Exemplo:

cast(true as Int) = 1

As seguintes palavras-chave podem aparecer após "as" ao chamar cast:

Regras de cast:

ceil(Decimal)

Arredonda o Decimal fornecido para o Int acima mais próximo. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

ceil(1.2) = 2

ceil(-1.2) = -1

chr(String)

Gera o caractere ASCII que corresponde ao dado argumento Int. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

chr(65) = "A".

chr(49) = "1".

clientid()

Gera o ID do MQTT cliente que envia a mensagem ou n/a se a mensagem não foi enviada por MQTT. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

clientid() = "123456789012"

concat()

Concatena as matrizes ou strings. Essa função aceita qualquer número de argumentos e gera uma String ou uma Array. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

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)

Gera o cosseno de um número em radianos. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

cos(0) = 1.

cosh(Decimal)

Gera o cosseno hiperbólico de um número em radianos. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: cosh(2.3) = 5,037220649268761.

decodificar (valor, esquema de decodificação)

Use a função decode para decodificar um valor codificado. Se a string decodificada for um documento JSON, um objeto endereçável será retornado. Caso contrário, a string decodificada será retornada como uma string. A função retornará NULL se a string não puder ser decodificada. Essa função é compatível com a decodificação de strings codificadas em base64 e o formato de mensagem Protocol Buffer (protobuf).

Compatível com a versão de 23/03/2016 do SQL e posteriores.

Decodificação de strings codificadas em base64

Neste exemplo, a carga útil da mensagem inclui um valor codificado.

{
    encoded_temp: "eyAidGVtcGVyYXR1cmUiOiAzMyB9Cg=="
}

A função decode nessa instrução SQL decodifica o valor na carga útil da mensagem.

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

A decodificação do valor encoded_temp resulta no seguinte documento JSON válido, que permite que a instrução SELECT leia o valor da temperatura.

{ "temperature": 33 }

O resultado da instrução SELECT neste exemplo é mostrado aqui.

{ "temp": 33 }

Se o valor decodificado não fosse um documento JSON válido, o valor decodificado seria retornado como uma string.

Decodificação da carga útil da mensagem protobuf

Você pode usar a função decodificar SQL para configurar uma regra que pode decodificar a carga útil da mensagem protobuf. Para obter mais informações, consulte Decodificação de cargas úteis de mensagens protobuf.

A assinatura da função tem a seguinte aparência:

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

Um exemplo de expressão SQL usando a função decodificar SQL pode ter a seguinte aparência:

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

encode(value, encodingScheme)

Use a função encode para codificar a carga útil, que provavelmente serão dados não JSON, em sua representação de string com base no esquema de codificação. Compatível com a versão de 23/03/2016 do SQL e posteriores.

endswith(String, String)

Gera um Boolean indicando se o primeiro argumento de String termina com o segundo argumento de String. Se um dos argumentos for Null ou Undefined, o resultado será Undefined. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: endswith("cat","at") = verdadeiro.

exp(Decimal)

Gera e elevado ao argumento Decimal. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: exp(1) = e.

floor(Decimal)

Arredonda o Decimal fornecido para o Int abaixo mais próximo. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

floor(1.2) = 1

floor(-1.2) = -2

get

Extrai um valor de um tipo de coleção (Matriz, String, Objeto). Nenhuma conversão é aplicada ao primeiro argumento. A conversão se aplica como documentado na tabela ao segundo argumento. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

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

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

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

get_dynamodb (nome da tabela,,,,, RoLearn partitionKeyName) partitionKeyValue sortKeyName sortKeyValue

Recupera dados de uma tabela do DynamoDB. get_dynamodb() permite consultar uma tabela do DynamoDB enquanto uma regra é avaliada. É possível filtrar ou aumentar cargas de mensagens usando dados recuperados do DynamoDB. Compatível com a versão de 23/03/2016 do SQL e posteriores.

get_dynamodb() utiliza os seguintes parâmetros:

Como um exemplo de como é possível usar get_dynamodb(), digamos que você tenha uma tabela do DynamoDB que contém o ID do dispositivo e as informações de localização para todos os dispositivos conectados ao AWS IoT. A instrução SELECT a seguir usa a função get_dynamodb() para recuperar o local para o ID do dispositivo especificado:

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

get_mqtt_property (nome)

Referencia qualquer um dos seguintes cabeçalhos MQTT5: contentType, payLoadFormatIndicator, responseTopic e correlationData. Essa função usa qualquer uma das seguintes strings literais como argumento: content_type, format_indicator, response_topic e correlation_data. Para obter mais informações, consulte a tabela de Argumentos de função a seguir.

A tabela a seguir mostra os argumentos de função aceitáveis e os tipos de retorno associados para a get_mqtt_property função:

O exemplo de SQL de regras a seguir faz referência a qualquer um dos seguintes cabeçalhos MQTT5: contentType, payLoadFormatIndicator, responseTopic e 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, chave, roleArn)

Recupera o valor do campo criptografado SecretString ou SecretBinary da versão atual de um segredo em AWS Secrets Manager. Para obter mais informações sobre como criar e manter segredos CreateSecretUpdateSecret, consulte, PutSecretValuee.

get_secret() utiliza os seguintes parâmetros:

Exemplos:

Você pode usar a função get_secret em um cabeçalho de autenticação em uma ação de regra HTTPS, como no exemplo de autenticação de chave de API a seguir.

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

Para obter mais informações sobre as ações de regra HTTPS, consulte HTTP.

get_thing_shadow(thingName, shadowName, roleARN)

Retorna a sombra do objeto especificado. Compatível com a versão de 23/03/2016 do SQL e posteriores.

Exemplos:

Quando usado com uma sombra nomeada, forneça o parâmetro shadowName.

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

Quando usado com uma sombra sem nome, omita o parâmetro shadowName.

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

get_user_properties () userPropertyKey

Referencia as propriedades do usuário, que é um tipo de cabeçalho de propriedade suportado no MQTT5.

Argumentos de função

Para as seguintes propriedades do usuário nos cabeçalhos das mensagens:

A tabela a seguir mostra o comportamento esperado do SQL:

O exemplo a seguir de SQL de regras faz referência às propriedades do usuário (um tipo de cabeçalho de propriedade MQTT5) na carga útil:

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

Funções de hashing

AWS IoT fornece as seguintes funções de hashing:

Todas as funções de hash esperam um argumento de string. O resultado é o valor de hash da string em questão. Conversões de string padrão se aplicam a argumentos de não string. Todas as funções de hash são compatíveis com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

md2("hello") = "a9046c73e00331af68917d3804f70655"

md5("hello") = "5d41402abc4b2a76b9719d911017c592"

indexof(String, String)

Apresenta o primeiro índice (base em 0) do segundo argumento como uma substring no primeiro argumento. Os dois argumentos são esperados como strings. Os argumentos que não são strings estão sujeitos às regras padrão de conversão de string. Essa função não se aplica a matrizes, apenas a strings. Compatível com a versão de 23/03/2016 do SQL e posteriores.

Exemplos:

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

isNull()

Retorna verdadeiro se o argumento é o valor Null. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

isNull(5) = false.

isNull(Null) = true.

isUndefined()

Retorna verdadeiro se o argumento for Undefined. Compatível com a versão de 23/03/2016 do SQL e posteriores.

Exemplos:

isUndefined(5) = false.

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

length(String)

Gera o número de caracteres na string fornecida. As regras padrão de conversão se aplicam a argumentos de não String. Compatível com a versão de 23/03/2016 do SQL e posteriores.

Exemplos:

length("hi") = 2

length(false) = 5

ln(Decimal)

Gera o logaritmo natural do argumento. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: ln(e) = 1.

log(Decimal)

Gera o logaritmo na base 10 do argumento. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: log(100) = 2,0.

lower(String)

Gera a versão em letra minúscula da String fornecida. Argumentos de não string são convertidos em strings usando as regras padrão de conversão. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

lower("HELLO") = "hello".

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

lpad(String, Int)

Gera o argumento de String, preenchido no lado esquerdo com o número de espaços especificado pelo segundo argumento. O argumento Int deve estar entre 0 e 1000. Se o valor fornecido estiver fora desse intervalo válido, o argumento será definido para o valor válido mais próximo (0 ou 1.000). Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

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

lpad(1, 3) = "   1"

ltrim(String)

Remove todos os espaços em branco iniciais (caracteres de tabulação e espaços) da String fornecida. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

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

machinelearning_predict(modelId, roleArn, registro)

Use a machinelearning_predict função para fazer previsões usando os dados de uma mensagem MQTT com base em um modelo da Amazon SageMaker . Compatível com a versão de 08/10/2015 do SQL e posteriores. Os argumentos da função machinelearning_predict são:

A função gera um objeto JSON com os seguintes campos:

mod(Decimal, Decimal)

Gera o restante da divisão do primeiro argumento pelo segundo argumento. Equivale a remainder(Decimal, Decimal). Você também pode usar "%" como um operador infixo para a mesma funcionalidade do módulo. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: mod(8, 3) = 2.

nanquim (,) AnyValue AnyValue

Gera o primeiro argumento se for um Decimal válido. Caso contrário, o segundo argumento é retornado. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: Nanvl(8, 3) = 8.

newuuid()

Gera uma UUID aleatória de 16 bytes. Compatível com a versão de 08/10/2015 do SQL e posteriores.

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

numbytes(String)

Gera o número de bytes na codificação UTF-8 da string fornecida. As regras padrão de conversão se aplicam a argumentos de não String. Compatível com a versão de 23/03/2016 do SQL e posteriores.

Exemplos:

numbytes("hi") = 2

numbytes("€") = 3

parse_time(String, Long, [String])

Use a função parse_time para formatar um timestamp em um formato legível de data/hora. Compatível com a versão de 23/03/2016 do SQL e posteriores. Para converter uma string de carimbo de data/hora em milissegundos, consulte time_to_epoch(String, String).

A função parse_time espera os seguintes argumentos:

Exemplos:

Quando essa mensagem for publicada no tópico "A/B", a carga útil {"ts": "1970.01.01 AD at 21:46:40 CST"} será enviada para o bucket do 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"
    }
} 

Quando essa mensagem for publicada no tópico 'A/B', uma carga útil semelhante a {"ts": "2017.06.09 AD at 17:19:46 UTC"} (mas com data/hora atual) será enviada para o bucket 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() também pode ser usado como um modelo de substituição. Por exemplo, quando esta mensagem for publicada no tópico "A/B", a carga útil será enviada para o bucket S3 com chave = "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(Decimal, Decimal)

Gera o primeiro argumento elevado ao segundo argumento. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: power(2, 5) = 32,0.

principal()

Retorna a entidade principal que o dispositivo usa para autenticação, com base em como a mensagem acionadora foi publicada. A tabela a seguir descreve a entidade principal retornada para cada protocolo e método de publicação.

Os exemplos a seguir mostram os diferentes tipos de valores que principal() pode retornar:

rand()

Gera um pseudoaleatório, uniformemente distribuído entre 0,0 e 1,0. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

rand() = 0,8231909191640703

regexp_matches(String, String)

Retorna verdadeiro se a string (primeiro argumento) contiver uma correspondência para a expressão regular (segundo argumento). Se você usar | na expressão regular, use-a com ().

Exemplos:

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.

Segundo argumento:

Deve ser uma expressão regex válida. Tipos de não string são convertidos em String usando as regras padrão de conversão. Dependendo do tipo, a string resultante pode não ser uma expressão regular válida. Se o argumento (convertido) não for uma regex válida, o resultado será Undefined.

regexp_replace(String, String, String)

Substitui todas as ocorrências do segundo argumento (expressão regular) no primeiro argumento com o terceiro argumento. Faz referência a grupos de captura com "$". Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

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

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

Segundo argumento:

Deve ser uma expressão regex válida. Tipos de não string são convertidos em String usando as regras padrão de conversão. Dependendo do tipo, a string resultante pode não ser uma expressão regular válida. Se o argumento (convertido) não for uma expressão regex válida, o resultado será Undefined.

Terceiro argumento:

Deve ser uma string de substituição regex válida. (Pode fazer referência a grupos de captura.) Tipos de não string são convertidos em String usando as regras padrão de conversão. Se o argumento (convertido) não for uma string de substituição regex válida, o resultado será Undefined.

regexp_substr(String, String)

Localiza a primeira correspondência do segundo parâmetro (regex) no primeiro parâmetro. Faz referência a grupos de captura com "$". Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

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

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

Segundo argumento:

Deve ser uma expressão regex válida. Tipos de não string são convertidos em String usando as regras padrão de conversão. Dependendo do tipo, a string resultante pode não ser uma expressão regular válida. Se o argumento (convertido) não for uma expressão regex válida, o resultado será Undefined.

remainder(Decimal, Decimal)

Gera o restante da divisão do primeiro argumento pelo segundo argumento. Equivale a mod(Decimal, Decimal). Você também pode usar "%" como um operador infixo para a mesma funcionalidade do módulo. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: remainder(8, 3) = 2.

replace(String, String, String)

Substitui todas as ocorrências do segundo argumento no primeiro argumento com o terceiro argumento. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

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

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

rpad(String, Int)

Gera o argumento da string, preenchido no lado direito com o número de espaços especificado no segundo argumento. O argumento Int deve estar entre 0 e 1000. Se o valor fornecido estiver fora desse intervalo válido, o argumento será definido para o valor válido mais próximo (0 ou 1.000). Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

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

rpad(1, 3) = "1   ".

round(Decimal)

Arredonda o Decimal fornecido para o Int mais próximo. Se o Decimal for equidistante de dois valores Int (por exemplo, 0,5), o Decimal será arredondado. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: Round(1.2) = 1.

Round(1.5) = 2.

Round(1.7) = 2.

Round(-1.1) = -1.

Round(-1.5) = -2.

rtrim(String)

Remove todos os espaços em branco finais (caracteres de tabulação e espaços) da String fornecida. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

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

sign(Decimal)

Gera o sinal do número fornecido. Quando o sinal do argumento for positivo, 1 será gerado. Quando o sinal do argumento for negativo, -1 será gerado. Se o argumento for 0, 0 será gerado. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

sign(-7) = -1.

sign(0) = 0.

sign(13) = 1.

sin(Decimal)

Gera o seno de um número em radianos. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: sin(0) = 0,0

sinh(Decimal)

Gera o seno hiperbólico de um número em radianos. Valores Decimal são arredondados para dobrar a precisão antes da aplicação da função. O resultado é um valor Decimal de precisão dupla. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: sinh(2.3) = 4,936961805545957

sourceip()

Recupera o endereço IP de um dispositivo ou do roteador que se conecta a ele. Se o seu dispositivo estiver conectado diretamente à Internet, a função retornará o endereço IP de origem do dispositivo. Se o seu dispositivo estiver conectado a um roteador conectado à Internet, a função retornará o endereço IP de origem do dispositivo. Compatível com a versão SQL 23/03/2016. sourceip() não usa nenhum parâmetro.

Exemplos:

sourceip()="192.158.1.38"

sourceip()="1.102.103.104"

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

Exemplo de SQL:

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

Exemplos de como usar a função sourceip () em ações de AWS IoT Core regras:

Exemplo 1

O exemplo a seguir mostra como chamar a função () como modelo de substituição em uma ação do 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"
				}
			}
		]
	}
}

Exemplo 2

O exemplo a seguir mostra como adicionar a função sourceip() como uma propriedade de usuário do MQTT usando modelos de substituição.

{
	"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()}"
							}
						]
					}
				}
			}
		]
	}
}            

Você pode recuperar o endereço IP de origem das mensagens que passam para AWS IoT Core as regras dos caminhos do Message Broker e do Basic Ingest. Você também pode recuperar o IP de origem para mensagens IPv4 e IPv6. O IP de origem será exibido da seguinte forma:

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

IPv4: xxx.xxx.xxx.xxx

substring(String, Int[, Int])

Espera uma String seguida de um ou dois valores Int. No caso de uma String e um único argumento Int, essa função gera a substring da String fornecida do índice Int fornecido (baseado em 0, inclusive) ao final da String. No caso de uma String e dois argumentos Int, essa função gera a substring da String fornecida no primeiro argumento de índiceInt (baseado em 0, inclusive) para o segundo argumento de índice Int (baseado em 0, inclusive). Índices inferiores a zero são definidos como zero. Índices superiores ao comprimento da String são definidos para o comprimento da String. No caso da versão de argumento três, se o primeiro índice for superior ou igual ao segundo índice, o resultado será a String vazia.

 Se os argumentos fornecidos não forem (String, Int) nem (String, Int, Int), as conversões padrão serão aplicadas aos argumentos na tentativa de convertê-los nos tipos corretos. Se os tipos não puderem ser convertidos, o resultado da função será Undefined. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

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()

Retorna a versão SQL especificada nesta regra. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

sql_version() = "23/03/2016"

sqrt(Decimal)

Gera a raiz quadrada de um número. Argumentos Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: sqrt(9) = 3,0.

startswith(String, String)

Gera Boolean, independentemente de o primeiro argumento da string começar com o segundo argumento da string. Se um dos argumentos for Null ou Undefined, o resultado será Undefined. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

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

tan(Decimal)

Gera a tangente de um número em radianos. Valores Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: tan(3) = -0,1425465430742778

tanh(Decimal)

Gera a tangente hiperbólica de um número em radianos. Valores Decimal são arredondados para dobrar a precisão antes da aplicação da função. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: tanh(2.3) = 0,9800963962661914

time_to_epoch(String, String)

Use a função time_to_epoch para converter uma string de timestamp em um número de milissegundos tempo de epoch do Unix. Compatível com a versão de 23/03/2016 do SQL e posteriores. Para converter milissegundos em uma string de carimbo de data/hora, consulte parse_time(String, Long, [String]).

A função time_to_epoch espera os seguintes argumentos:

Exemplos:

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()

Retorna o timestamp atual em milissegundos a partir das 00:00:00 Horário Universal Coordenado (UTC), quinta-feira, 1º de janeiro de 1970, conforme observado pelo mecanismo de regras. AWS IoT Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo: timestamp() = 1481825251155

topic(Decimal)

Gera o tópico para o qual a mensagem que acionou a regra foi enviada. Se nenhum parâmetro for especificado, todo o tópico será gerado. O parâmetro Decimal é usado para especificar um segmento de tópico específico, com 1 designando o primeiro segmento. Para o tópico foo/bar/baz, topic(1) retornará foo, topic(2) retornará bar, e assim por diante. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

topic() = "things/myThings/thingOne"

topic(1) = "objetos"

Quando a Ingestão básica for usada, o prefixo inicial do tópico ($aws/rules/rule-name) não estará disponível na função topic(). Por exemplo, considerando o tópico:

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

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

topic(3) = "Floor2"

traceid()

Gera o ID de rastreamento (UUID) da mensagem MQTT ou Undefined caso a mensagem não tenha sido enviada por MQTT. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

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

transform(String, Objeto, Matriz)

Retorna uma matriz de objetos que contém o resultado da transformação especificada do parâmetro Object no parâmetro Array.

Compatível com a versão de 23/03/2016 do SQL e posteriores.

Exemplo 1 da função de transformação

Este exemplo mostra como a função transform() produz uma única matriz de objetos a partir de um objeto de dados e uma matriz.

Neste exemplo, a mensagem a seguir é publicada no tópico A/B do MQTT.

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

Essa instrução SQL para uma ação de regra de tópico usa a função transform() com um valor de String de enrichArray. Neste exemplo, Object é a propriedade de attributes da carga da mensagem e Array é a matriz de values, que contém três objetos.

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

Ao receber a carga útil da mensagem, a instrução SQL avalia a seguinte resposta.

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

Exemplo 2 da função de transformação

Este exemplo mostra como a função transform() pode usar valores literais para incluir e renomear atributos individuais da carga útil da mensagem.

Neste exemplo, a mensagem a seguir é publicada no tópico A/B do MQTT. Essa é a mesma mensagem que foi usada em Exemplo 1 da função de transformação.

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

Essa instrução SQL para uma ação de regra de tópico usa a função transform() com um valor de String de enrichArray. O Object na função transform() tem um único atributo chamado key com o valor de attributes.data1 na carga útil da mensagem e Array é a matriz de values, que contém os mesmos três objetos usados no exemplo anterior.

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

Ao receber a carga útil da mensagem, esta instrução SQL avalia a seguinte resposta. Observe como a propriedade data1 é nomeada key na resposta.

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

Exemplo 3 da função de transformação

Este exemplo mostra como a função transform() pode ser usada em cláusulas SELECT aninhadas para selecionar vários atributos e criar novos objetos para processamento posterior.

Neste exemplo, a mensagem a seguir é publicada no tópico A/B do MQTT.

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

O Object para esta função de transformação é o objeto retornado pela instrução SELECT, que contém os elementos a e b do objeto data2 da mensagem. O parâmetro Array consiste nos dois objetos da matriz data2.c na mensagem original.

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

Com a mensagem anterior, a instrução SQL avalia a seguinte resposta.

[
  {
    "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"
  }
]

A matriz retornada nessa resposta pode ser usada com ações de regras de tópico compatíveis com batchMode.

trim(String)

Remove todos os espaços em branco iniciais e finais da String fornecida. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplo:

Trim(" hi ") = "hi"

trunc(Decimal, Int)

Trunca o primeiro argumento para o número de lugares Decimal especificado pelo segundo argumento. Se o segundo argumento for inferior a zero, ele será definido como zero. Se o segundo argumento for superior a 34, ele será definido como 34. Os zeros finais são removidos do resultado. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

trunc(2.3, 0) = 2.

trunc(2.3123, 2) = 2,31.

trunc(2.888, 2) = 2,88.

trunc(2.00, 5) = 2.

upper(String)

Gera a versão em letra maiúscula da String fornecida. Os argumentos de nãoString são convertidos em String usando as regras de conversão padrão. Compatível com a versão de 08/10/2015 do SQL e posteriores.

Exemplos:

upper("hello") = "HELLO"

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