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

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 usarlo API para ejecutar una consulta programada de forma manual.

Si lo has activadoQueryInsights, API también se muestran estadísticas y métricas relacionadas con la consulta que ejecutaste como parte de una SNS notificación de Amazon. QueryInsightsayuda a ajustar el rendimiento de la consulta. Para obtener más informaciónQueryInsights, consulte Uso de la información de consultas para optimizar las consultas 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 JSON formato.

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 habilitarla. QueryInsights

La activación QueryInsights devuelve estadísticas y métricas como parte de la SNS notificación de Amazon para la consulta que ejecutaste. Puede utilizarlos QueryInsights para ajustar el rendimiento y el coste de sus consultas.

Tipo: objeto ScheduledQueryInsights

Obligatorio: no

ScheduledQueryArn

ARNde 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 de HTTP 200 puntos con HTTP el cuerpo vacío.

Errores

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

AccessDeniedException

No está autorizado a realizar esta acción.

HTTPCódigo de estado: 400

InternalServerException

El servicio no pudo procesar completamente esta solicitud debido a un error interno del servidor.

HTTPCódigo de estado: 400

InvalidEndpointException

El punto final solicitado no era válido.

HTTPCódigo de estado: 400

ResourceNotFoundException

No se ha encontrado el recurso solicitado.

HTTPCódigo de estado: 400

ThrottlingException

La solicitud fue denegada debido a una limitación de la solicitud.

HTTPCódigo de estado: 400

ValidationException

Solicitud no válida o mal formada.

HTTPCódigo de estado: 400

Ejemplos

Mensaje de notificación de consulta programada para el CONTROL modo ENABLED WITH _ RATE _ _

El siguiente ejemplo muestra un mensaje de notificación de consulta programado correctamente para el ENABLED_WITH_RATE_CONTROL modo del 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
        }
    }
}

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

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

Mensaje de notificación de error para el CONTROL modo ENABLED WITH _ RATE _ _

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

Mensaje de notificación de error para el DISABLED modo

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

Véase también

Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: