ExecuteScheduledQuery - Amazon Timestream
Sintaxe da SolicitaçãoParâmetros da solicitaçãoElementos de RespostaErrosExemplosConsulte também

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 isso API para executar uma consulta agendada manualmente.

Se você ativouQueryInsights, isso API também retornará informações e métricas relacionadas à consulta que você executou como parte de uma SNS notificação da Amazon. QueryInsightsajuda no ajuste do desempenho de sua consulta. Para obter mais informações sobreQueryInsights, 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 comuns a todas as ações, consulte Parâmetros Comuns.

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

ClientToken

Não usado.

Tipo: string

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

Obrigatório: Não

InvocationTime

O registro de data e hora é. UTC A consulta será executada como se tivesse sido invocada nesse timestamp.

Tipo: carimbo de data/hora

Obrigatório: Sim

QueryInsights

Encapsula as configurações para ativação. QueryInsights

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

Tipo: objeto ScheduledQueryInsights

Obrigatório: Não

ScheduledQueryArn

ARNda consulta agendada.

Tipo: string

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

Obrigatório: Sim

Elementos de Resposta

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

Erros

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

AccessDeniedException

Você não está autorizado a realizar essa ação.

HTTPCódigo de status: 400

InternalServerException

O serviço não conseguiu processar totalmente essa solicitação devido a um erro interno do servidor.

HTTPCódigo de status: 400

InvalidEndpointException

O endpoint solicitado não era válido.

HTTPCódigo de status: 400

ResourceNotFoundException

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

HTTPCódigo de status: 400

ThrottlingException

A solicitação foi negada devido à limitação da solicitação.

HTTPCódigo de status: 400

ValidationException

Solicitação inválida ou malformada.

HTTPCódigo de status: 400

Exemplos

Mensagem de notificação de consulta agendada para o CONTROL modo ENABLED WITH _ RATE _ _

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

"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 DISABLED modo

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

"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 CONTROL modo ENABLED WITH _ RATE _ _

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

"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": "my-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 DISABLED modo

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

"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": "my-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 isso API em um idioma específico AWS SDKs, consulte o seguinte: