ExecuteScheduledQuery - Amazon Timestream
Sintaxe da solicitaçãoParâmetros da solicitaçãoElementos de respostaErrosExemplosConsulte 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á.

ExecuteScheduledQuery

Você pode usar essa API para executar uma consulta agendada manualmente.

Se você ativou QueryInsights, essa API também retornará insights e métricas relacionadas à consulta que você executou como parte de uma notificação do Amazon SNS. QueryInsights ajuda no ajuste do desempenho de sua consulta. Para mais informações sobre QueryInsights, consulte Uso de insights de consulta para otimizar consultas no Amazon Timestream.

Sintaxe da solicitação

{
   "ClientToken": "string",
   "InvocationTime": number,
   "QueryInsights": { 
      "Mode": "string"
   },
   "ScheduledQueryArn": "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

Não usado.

Tipo: string

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

Obrigatório: não

InvocationTime

Carimbo de data/hora em UTC. A consulta será executada como se tivesse sido invocada nesse carimbo de data/hora.

Tipo: carimbo de data/hora

Obrigatório: sim

QueryInsights

Encapsula as configurações para ativar o QueryInsights.

A ativação QueryInsights retorna insights e métricas como parte da notificação do Amazon SNS para a consulta executada. Você pode usar QueryInsights para ajustar o desempenho e o custo de sua consulta.

Tipo: objeto ScheduledQueryInsights

Obrigatório: não

ScheduledQueryArn

ARN da consulta agendada.

Tipo: string

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

Obrigatório: sim

Elementos de resposta

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

Erros

Para 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

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

ResourceNotFoundException

Não foi possível encontrar o recurso solicitado.

ScheduledQueryArn

ARN da consulta agendada.

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

Exemplos

Mensagem de notificação de consulta agendada para o modo ENABLED_WITH_RATE_CONTROL

O exemplo a seguir mostra uma mensagem de notificação de consulta agendada bem-sucedida para o modo ENABLED_WITH_RATE_CONTROL do parâmetro QueryInsights.

"SuccessNotificationMessage": {
    "type": "MANUAL_TRIGGER_SUCCESS",
    "arn": "arn:aws:timestream:<Region>:<Account>:scheduled-query/sq-test-49c6ed55-c2e7-4cc2-9956-4a0ecea13420-80e05b035236a4c3",
    "scheduledQueryRunSummary": {
        "invocationEpochSecond": 1723710546,
        "triggerTimeMillis": 1723710547490,
        "runStatus": "MANUAL_TRIGGER_SUCCESS",
        "executionStats": {
            "executionTimeInMillis": 17343,
            "dataWrites": 1024,
            "bytesMetered": 0,
            "cumulativeBytesScanned": 600,
            "recordsIngested": 1,
            "queryResultRows": 1
        },
        "queryInsightsResponse": {
            "querySpatialCoverage": {
                "max": {
                    "value": 1.0,
                    "tableArn": "arn:aws:timestream:<Region>:<Account>:database/BaseDb/table/BaseTable",
                    "partitionKey": [
                        "measure_name"
                    ]
                }
            },
            "queryTemporalRange": {
                "max": {
                    "value": 2399999999999,
                    "tableArn": "arn:aws:timestream:<Region>:<Account>:database/BaseDb/table/BaseTable"
                }
            },
            "queryTableCount": 1,
            "outputRows": 1,
            "outputBytes": 59
        }
    }
}

Mensagem de notificação de consulta agendada para o modo DISABLED

O exemplo a seguir mostra uma mensagem de notificação de consulta agendada bem-sucedida para o modo DISABLED do parâmetro QueryInsights.

"SuccessNotificationMessage": {
    "type": "MANUAL_TRIGGER_SUCCESS",
    "arn": "arn:aws:timestream:<Region>:<Account>:scheduled-query/sq-test-fa109d9e-6528-4a0d-ac40-482fa05e657f-140faaeecdc5b2a7",
    "scheduledQueryRunSummary": {
        "invocationEpochSecond": 1723711401,
        "triggerTimeMillis": 1723711402144,
        "runStatus": "MANUAL_TRIGGER_SUCCESS",
        "executionStats": {
            "executionTimeInMillis": 17992,
            "dataWrites": 1024,
            "bytesMetered": 0,
            "cumulativeBytesScanned": 600,
            "recordsIngested": 1,
            "queryResultRows": 1
        }
    }
}

Mensagem de notificação de falha para o modo ENABLED_WITH_RATE_CONTROL

O exemplo a seguir mostra uma mensagem de notificação de consulta agendada com falha para o modo ENABLED_WITH_RATE_CONTROL do parâmetro QueryInsights.

"FailureNotificationMessage": {
    "type": "MANUAL_TRIGGER_FAILURE",
    "arn": "arn:aws:timestream:<Region>:<Account>:scheduled-query/sq-test-b261670d-790c-4116-9db5-0798071b18b1-b7e27a1d79be226d",
    "scheduledQueryRunSummary": {
        "invocationEpochSecond": 1727915513,
        "triggerTimeMillis": 1727915513894,
        "runStatus": "MANUAL_TRIGGER_FAILURE",
        "executionStats": {
            "executionTimeInMillis": 10777,
            "dataWrites": 0,
            "bytesMetered": 0,
            "cumulativeBytesScanned": 0,
            "recordsIngested": 0,
            "queryResultRows": 4
        },
        "errorReportLocation": {
            "s3ReportLocation": {
                "bucketName": "amzn-s3-demo-bucket",
                "objectKey": "4my-organization-f7a3c5d065a1a95e/1727915513/MANUAL/1727915513894/5e14b3df-b147-49f4-9331-784f749b68ae"
            }
        },
        "failureReason": "Schedule encountered some errors and is incomplete. Please take a look at error report for further details"
    }
}

Mensagem de notificação de falha para o modo DISABLED

O exemplo a seguir mostra uma mensagem de notificação de consulta agendada com falha para o modo DISABLED do parâmetro QueryInsights.

"FailureNotificationMessage": {
    "type": "MANUAL_TRIGGER_FAILURE",
    "arn": "arn:aws:timestream:<Region>:<Account>:scheduled-query/sq-test-b261670d-790c-4116-9db5-0798071b18b1-b7e27a1d79be226d",
    "scheduledQueryRunSummary": {
        "invocationEpochSecond": 1727915194,
        "triggerTimeMillis": 1727915195119,
        "runStatus": "MANUAL_TRIGGER_FAILURE",
        "executionStats": {
            "executionTimeInMillis": 10777,
            "dataWrites": 0,
            "bytesMetered": 0,
            "cumulativeBytesScanned": 0,
            "recordsIngested": 0,
            "queryResultRows": 4
        },
        "errorReportLocation": {
            "s3ReportLocation": {
                "bucketName": "amzn-s3-demo-bucket",
                "objectKey": "4my-organization-b7e27a1d79be226d/1727915194/MANUAL/1727915195119/08dea9f5-9a0a-4e63-a5f7-ded23247bb98"
            }
        },
        "failureReason": "Schedule encountered some errors and is incomplete. Please take a look at error report for further details"
    }
}

Consulte também

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