View a markdown version of this page

CreateScheduledQuery - Amazon Timestream
Sintaxe da solicitaçãoParâmetros da solicitaçãoSintaxe da respostaElementos de respostaErrosConsulte também

Para recursos semelhantes aos do Amazon Timestream para, considere o Amazon Timestream LiveAnalytics para InfluxDB. Ele oferece ingestão de dados simplificada e tempos de resposta de consulta de um dígito em milissegundos para análises em tempo real. Saiba mais aqui.

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á.

CreateScheduledQuery

Crie uma consulta agendada que será executada em seu nome na programação configurada. O Timestream assume a função de execução fornecida como parte do parâmetro ScheduledQueryExecutionRoleArn para executar a consulta. É possível utilizar o parâmetro NotificationConfiguration para configurar a notificação das suas operações de consulta agendada.

Sintaxe da solicitação

{
   "ClientToken": "string",
   "ErrorReportConfiguration": { 
      "S3Configuration": { 
         "BucketName": "string",
         "EncryptionOption": "string",
         "ObjectKeyPrefix": "string"
      }
   },
   "KmsKeyId": "string",
   "Name": "string",
   "NotificationConfiguration": { 
      "SnsConfiguration": { 
         "TopicArn": "string"
      }
   },
   "QueryString": "string",
   "ScheduleConfiguration": { 
      "ScheduleExpression": "string"
   },
   "ScheduledQueryExecutionRoleArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TargetConfiguration": { 
      "TimestreamConfiguration": { 
         "DatabaseName": "string",
         "DimensionMappings": [ 
            { 
               "DimensionValueType": "string",
               "Name": "string"
            }
         ],
         "MeasureNameColumn": "string",
         "MixedMeasureMappings": [ 
            { 
               "MeasureName": "string",
               "MeasureValueType": "string",
               "MultiMeasureAttributeMappings": [ 
                  { 
                     "MeasureValueType": "string",
                     "SourceColumn": "string",
                     "TargetMultiMeasureAttributeName": "string"
                  }
               ],
               "SourceColumn": "string",
               "TargetMeasureName": "string"
            }
         ],
         "MultiMeasureMappings": { 
            "MultiMeasureAttributeMappings": [ 
               { 
                  "MeasureValueType": "string",
                  "SourceColumn": "string",
                  "TargetMultiMeasureAttributeName": "string"
               }
            ],
            "TargetMultiMeasureName": "string"
         },
         "TableName": "string",
         "TimeColumn": "string"
      }
   }
}

Parâmetros da solicitação

Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte Parâmetros comuns.

A solicitação aceita os dados a seguir no formato JSON.

ClientToken

Usar a ClientToken torna a chamada para CreateScheduledQuery idempotente, em outras palavras, fazer a mesma solicitação repetidamente produzirá o mesmo resultado. Fazer várias CreateScheduledQuery solicitações idênticas tem o mesmo efeito que fazer uma única solicitação.

  • Se CreateScheduledQuery for chamado sem umClientToken, o Query SDK gerará um ClientToken em seu nome.

  • Após oito horas, qualquer solicitação com o mesmo ClientToken será tratada como uma nova solicitação.

Tipo: string

Restrições de comprimento: comprimento mínimo de 32. O comprimento máximo é 128.

Obrigatório: não

ErrorReportConfiguration

Configuração para relatórios de erros. Relatórios de erros serão gerados quando um problema for encontrado ao gravar resultados de consultas.

Tipo: objeto ErrorReportConfiguration

Obrigatório: sim

KmsKeyId

A chave do Amazon KMS utilizada para criptografar o recurso de consulta agendada em repouso. Se a chave do Amazon KMS não for especificada, o recurso de consulta agendada será criptografado com uma chave do Amazon KMS de propriedade do Timestream. Para especificar uma chave do KMS, use o ID de chave, o ARN de chave, o nome de alias ou o ARN de alias. Ao usar um nome de alias, use alias/ como prefixo.

Se for ErrorReportConfiguration usado SSE_KMS como tipo de criptografia, o mesmo KmsKeyId será usado para criptografar o relatório de erros em repouso.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2.048.

Obrigatório: não

Name

Nome da consulta agendada.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.

Padrão: [a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+

Obrigatório: sim

NotificationConfiguration

Configuração de notificação para a consulta agendada. Uma notificação é enviada pelo Timestream quando uma execução de consulta é finalizada, quando seu estado é atualizado ou quando ela é excluída.

Tipo: objeto NotificationConfiguration

Obrigatório: sim

QueryString

String de consulta a ser executada. Nomes de parâmetros podem ser especificados no caractere @ da string de consulta, seguido por um identificador. O parâmetro nomeado @scheduled_runtime é reservado e pode ser utilizado na consulta para obter o horário em que ela está programada para ser executada.

O timestamp, calculado de acordo com o ScheduleConfiguration parâmetro, será o valor do @scheduled_runtime parâmetro para cada execução de consulta. Por exemplo, considere uma instância de uma consulta agendada em execução em 2021-12-01 00:00:00. Para esse caso, o parâmetro @scheduled_runtime é inicializado no registro de data/hora 2021-12-01 00:00:00 ao chamar a consulta.

Tipo: string

Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 262144.

Obrigatório: sim

ScheduleConfiguration

Configuração da programação da consulta.

Tipo: objeto ScheduleConfiguration

Obrigatório: sim

ScheduledQueryExecutionRoleArn

O ARN do perfil do IAM que o Timestream assumirá ao executar a consulta agendada.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2048.

Obrigatório: sim

Tags

Uma lista de pares chave/valor para rotular a consulta agendada.

Tipo: matriz de objetos Tag

Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.

Obrigatório: não

TargetConfiguration

Configuração utilizada para gravar o resultado de uma consulta.

Tipo: objeto TargetConfiguration

Obrigatório: não

Sintaxe da resposta

{
   "Arn": "string"
}

Elementos de resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

Arn

ARN referente à consulta agendada criada.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2.048.

Erros

Para informações sobre os erros comuns retornados pelas ações, consulte Tipos de erro comuns.

AccessDeniedException

Você não tem as permissões necessárias para acessar as configurações da conta.

Código de status HTTP: 400

ConflictException

Não é possível obter resultados de uma consulta cancelada.

Código de status HTTP: 400

InternalServerException

Ocorreu um erro interno ao processar a solicitação.

Código de status HTTP: 400

InvalidEndpointException

O endpoint solicitado é inválido.

Código de status HTTP: 400

ServiceQuotaExceededException

Service quota excedida.

Código de status HTTP: 400

ThrottlingException

A solicitação foi restringida devido ao excesso de solicitações.

Código de status HTTP: 400

ValidationException

Solicitação inválida ou malformada.

Código de status HTTP: 400

Consulte também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: