ExecuteScheduledQuery - Amazon Timestream
Sintaxis de la solicitudParámetros de la solicitudElementos de respuestaErroresEjemplosVéase también

Para obtener capacidades similares a las de Amazon Timestream, considere Amazon Timestream LiveAnalytics para InfluxDB. Ofrece una ingesta de datos simplificada y tiempos de respuesta a las consultas en milisegundos de un solo dígito para realizar análisis en tiempo real. Obtenga más información aquí.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

ExecuteScheduledQuery

Puede utilizar esta API para ejecutar una consulta programada de manera manual.

Si la habilitó QueryInsights, esta API también muestra información y métricas relacionadas con la consulta que ejecutó como parte de una notificación de Amazon SNS. QueryInsights ayuda a ajustar el rendimiento de la consulta. Para obtener más información sobre QueryInsights, consulte Uso de la información sobre las consultas para su optimización en Amazon Timestream.

Sintaxis de la solicitud

{
   "ClientToken": "string",
   "InvocationTime": number,
   "QueryInsights": { 
      "Mode": "string"
   },
   "ScheduledQueryArn": "string"
}

Parámetros de la solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

ClientToken

No se utiliza.

Tipo: cadena

Restricciones de longitud: longitud mínima de 32. Longitud máxima de 128.

Obligatorio: no

InvocationTime

La marca de tiempo en UTC. La consulta se ejecutará como si se hubiera invocado en esta marca de tiempo.

Tipo: marca temporal

Obligatorio: sí

QueryInsights

Encapsula la configuración para habilitar una QueryInsights.

La habilitación de la QueryInsights muestra la información y métricas como parte de la notificación de Amazon SNS para la consulta que ejecutó. Puede utilizar las QueryInsights para ajustar el rendimiento y el costo de sus consultas.

Tipo: objeto ScheduledQueryInsights

Obligatorio: no

ScheduledQueryArn

ARN de la consulta programada.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Obligatorio: sí

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200 con un cuerpo HTTP vacío.

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

AccessDeniedException

No cuenta con los permisos necesarios para acceder a la configuración de la cuenta.

Código de estado HTTP: 400

InternalServerException

Se produjo un error de servidor interno al procesar la solicitud.

Código de estado HTTP: 400

InvalidEndpointException

El punto de conexión solicitado no es válido.

Código de estado HTTP: 400

ResourceNotFoundException

No se ha encontrado el recurso solicitado.

ScheduledQueryArn

El ARN de la consulta programada.

Código de estado HTTP: 400

ThrottlingException

La solicitud se retrasó debido a una cantidad excesiva de solicitudes.

Código de estado HTTP: 400

ValidationException

Solicitud no válida o con formato incorrecto.

Código de estado HTTP: 400

Ejemplos

Mensaje de notificación de consulta programada para el modo ENABLED_WITH_RATE_CONTROL

En el siguiente ejemplo, se muestra un mensaje de notificación de consulta programada de manera correcta para el modo ENABLED_WITH_RATE_CONTROL del 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
        }
    }
}

Mensaje de notificación de consulta programada para el modo DISABLED

En el siguiente ejemplo, se muestra un mensaje de notificación de consulta programada de manera correcta para el modo DISABLED del 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
        }
    }
}

Mensaje de notificación de falla para el modo ENABLED_WITH_RATE_CONTROL

En el siguiente ejemplo, se muestra un mensaje de notificación de consulta programada fallido para el modo ENABLED_WITH_RATE_CONTROL del 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"
    }
}

Mensaje de notificación de falla para el modo DISABLED

En el siguiente ejemplo, se muestra un mensaje de notificación de consulta programada fallido para el modo DISABLED del 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"
    }
}

Véase también

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente: