Para obtener capacidades similares a las de Amazon Timestream para LiveAnalytics, considere Amazon Timestream 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í.
CreateScheduledQuery
Crear una consulta programada que se ejecutará en su nombre según la programación configurada. Timestream asume la función de ejecución proporcionada como parte del parámetro ScheduledQueryExecutionRoleArn para ejecutar la consulta. Puede usar el parámetro NotificationConfiguration para configurar la notificación de las operaciones de consulta programadas.
Sintaxis de la solicitud
{
"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 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
-
El uso de un ClientToken hace que la llamada a CreateScheduledQuery sea idempotente, en otras palabras, hacer la misma solicitud repetidamente producirá el mismo resultado. Hacer varias solicitudes CreateScheduledQuery idénticas tiene el mismo efecto que realizar una sola solicitud.
-
Si se llama a CreateScheduledQuery sin un
ClientToken, el SDK de Query genera unClientTokenen su nombre. -
Después de 8 horas, cualquier solicitud con el mismo
ClientTokenes tratada como una nueva solicitud.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 32 caracteres. Longitud máxima de 128.
Obligatorio: no
-
- ErrorReportConfiguration
-
Configuración para el informe de errores. Se generarán informes de errores cuando se encuentre un problema al escribir los resultados de la consulta.
Tipo: objeto ErrorReportConfiguration
Obligatorio: sí
- KmsKeyId
-
La clave de Amazon KMS usada para cifrar el recurso de consulta programada, en reposo. Si no se especifica la clave de Amazon KMS, el recurso de consulta programada se cifrará con una clave de Amazon KMS propiedad de Timestream. Para especificar una clave KMS, utilice el ID de la clave, ARN de la clave, el nombre de alias o el ARN del alias. Cuando utilice un nombre del alias, anteponga el nombre con alias/
Si ErrorReportConfiguration usa
SSE_KMScomo tipo de cifrado, se utiliza el mismo KMSKeyId para cifrar el informe de errores en reposo.Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.
Obligatorio: no
- Name
-
Nombre de la consulta programada.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.
Patrón:
[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+Obligatorio: sí
- NotificationConfiguration
-
Configuración de notificaciones para la consulta programada. Timestream envía una notificación cuando finaliza la ejecución de una consulta, cuando se actualiza el estado o cuando se elimina.
Tipo: objeto NotificationConfiguration
Obligatorio: sí
- QueryString
-
La cadena de consulta que se ejecutará. Los nombres de los parámetros se pueden especificar en la cadena de consulta
@seguida de un identificador. El parámetro denominado@scheduled_runtimeestá reservado y se puede usar en la consulta para obtener la hora a la que está programada la ejecución de la consulta.La marca de tiempo calculada según el parámetro ScheduleConfiguration será el valor del parámetro
@scheduled_runtimepara cada ejecución de consulta. Por ejemplo, considere una instancia de una consulta programada que se ejecuta el 01-12-2021 00:00:00. Para esta instancia, el parámetro@scheduled_runtimese inicializa en la marca de tiempo 01-12-2021 00:00:00 al invocar la consulta.Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 262144 caracteres.
Obligatorio: sí
- ScheduleConfiguration
-
La configuración programada para la consulta.
Tipo: objeto ScheduleConfiguration
Obligatorio: sí
- ScheduledQueryExecutionRoleArn
-
El ARN para el rol de IAM que Timestream asumirá al ejecutar la consulta programada.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.
Obligatorio: sí
- Tags
-
Lista de pares clave-valor para etiquetar la consulta programada.
Tipo: matriz de objetos Tag
Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.
Obligatorio: no
- TargetConfiguration
-
Configuración que se utiliza para escribir el resultado de una consulta.
Tipo: objeto TargetConfiguration
Obligatorio: no
Sintaxis de la respuesta
{
"Arn": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- Arn
-
ARN para la consulta programada que se creó.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.
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
- ConflictException
-
No se pudo sondear los resultados de una consulta cancelada.
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
- ServiceQuotaExceededException
-
Superó la cuota de servicio.
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
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
