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.
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 JSON formato.
- ClientToken
-
El uso de a ClientToken hace que la llamada sea CreateScheduledQuery idempotente, en otras palabras, si se hace la misma solicitud repetidamente, se obtendrá el mismo resultado. Hacer varias CreateScheduledQuery solicitudes idénticas tiene el mismo efecto que hacer una sola solicitud.
-
Si CreateScheduledQuery se llama sin un
ClientToken, la consulta SDK genera unClientTokenen tu nombre. -
Después de 8 horas, cualquier solicitud con el mismo
ClientTokenes tratada como una nueva solicitud.
Tipo: cadena
Restricciones de longitud: longitud mínima de 32. 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 KMS clave de Amazon utilizada para cifrar el recurso de consulta programada, en reposo. Si no se especifica la KMS clave de Amazon, el recurso de consulta programado se cifrará con una clave de Amazon KMS propiedad de Timestream. Para especificar una KMS clave, usa el ID de clave, la claveARN, el nombre o el alias. ARN Cuando utilice un nombre del alias, anteponga el nombre con alias/
Si
SSE_KMSse ErrorReportConfiguration utiliza como tipo de cifrado, KmsKeyId se utiliza lo mismo 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 en función del ScheduleConfiguration parámetro será el valor del
@scheduled_runtimeparámetro para cada consulta que se ejecute. 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 del cronograma de la consulta.
Tipo: objeto ScheduleConfiguration
Obligatorio: sí
- ScheduledQueryExecutionRoleArn
-
Es ARN para la IAM función que asumirá Timestream 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 utilizada 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 de HTTP 200.
El servicio devuelve los siguientes datos en JSON formato.
- Arn
-
ARNpara la consulta programada creada.
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 está autorizado a realizar esta acción.
HTTPCódigo de estado: 400
- ConflictException
-
No se han podido sondear los resultados de una consulta cancelada.
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
- ServiceQuotaExceededException
-
Ha superado la cuota de servicio.
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 con formato incorrecto.
HTTPCódigo de estado: 400
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:
