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

O uso de um ClientToken torna a chamada para CreateScheduledQuery idempotente. Em outras palavras, fazer a mesma solicitação repetidamente produzirá o mesmo resultado. Fazer várias solicitações CreateScheduledQuery idênticas tem o mesmo efeito de se fazer uma única solicitação.

• Se CreateScheduledQuery for chamada sem ClientToken, o SDK de consulta 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 tamanho: tamanho mínimo de 32. O tamanho máximo é de 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 ErrorReportConfiguration usar SSE_KMS como tipo de criptografia, o mesmo KmsKeyId será utilizado para criptografar o relatório de erro em repouso.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 2.048.

Obrigatório: não

Name

Nome da consulta agendada.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 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 carimbo de data/hora calculado de acordo com o parâmetro ScheduleConfiguration será o valor do parâmetro @scheduled_runtime 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 carimbo de data/hora 2021-12-01 00:00:00 ao chamar a consulta.

Tipo: string

Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 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. Tamanho máximo de 2.048.

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. Tamanho máximo de 2.048.

Erros

Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.

AccessDeniedException

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

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

Cota de serviço 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 mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:

• AWS Command Line Interface V2

• AWS SDK para .NET

• AWS SDK para C++

• AWS SDK para Go v2

• AWS SDK para Java v2

• AWS SDK para JavaScript V3

• AWS SDK para Kotlin

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK para Ruby V3