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í](https://docs.aws.amazon.com//timestream/latest/developerguide/timestream-for-influxdb.html).
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.
# Consulta de Amazon Timestream
La consulta de Amazon Timestream admite las siguientes acciones:
+ [CancelQuery](API_query_CancelQuery.md)
+ [CreateScheduledQuery](API_query_CreateScheduledQuery.md)
+ [DeleteScheduledQuery](API_query_DeleteScheduledQuery.md)
+ [DescribeAccountSettings](API_query_DescribeAccountSettings.md)
+ [DescribeEndpoints](API_query_DescribeEndpoints.md)
+ [DescribeScheduledQuery](API_query_DescribeScheduledQuery.md)
+ [ExecuteScheduledQuery](API_query_ExecuteScheduledQuery.md)
+ [ListScheduledQueries](API_query_ListScheduledQueries.md)
+ [ListTagsForResource](API_query_ListTagsForResource.md)
+ [PrepareQuery](API_query_PrepareQuery.md)
+ [Query](API_query_Query.md)
+ [TagResource](API_query_TagResource.md)
+ [UntagResource](API_query_UntagResource.md)
+ [UpdateAccountSettings](API_query_UpdateAccountSettings.md)
+ [UpdateScheduledQuery](API_query_UpdateScheduledQuery.md)
# CancelQuery
Cancela una consulta que se emitió. La cancelación solo se ofrece si la consulta no se completó antes de que se emitiera la solicitud de cancelación. Como la cancelación es una operación idempotente, las solicitudes de cancelación posteriores mostrarán un `CancellationMessage`, lo que indica que la consulta ya se canceló. Consulte el [ejemplo de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html) para obtener más detalles.
## Sintaxis de la solicitud
```
{
"QueryId": "string"
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [QueryId](#API_query_CancelQuery_RequestSyntax) **
El identificador de la consulta que debe cancelarse. Se muestra `QueryID` como parte del resultado de la consulta.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.
Patrón: `[a-zA-Z0-9]+`
Obligatorio: sí
## Sintaxis de la respuesta
```
{
"CancellationMessage": "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.
** [CancellationMessage](#API_query_CancelQuery_ResponseSyntax) **
Se muestra un `CancellationMessage` cuando ya se emitió una solicitud `CancelQuery` para la consulta especificada por `QueryId`.
Tipo: cadena
## Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).
** 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
** 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 uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/CancelQuery)
# 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](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [ClientToken](#API_query_CreateScheduledQuery_RequestSyntax) **
El uso de a ClientToken hace que la llamada sea CreateScheduledQuery idempotente, en otras palabras, hacer la misma solicitud repetidamente producirá el mismo resultado. Hacer varias CreateScheduledQuery solicitudes idénticas tiene el mismo efecto que hacer una sola solicitud.
+ Si CreateScheduledQuery se llama sin una`ClientToken`, el SDK de consultas genera una `ClientToken` en tu nombre.
+ Después de 8 horas, cualquier solicitud con el mismo `ClientToken` es tratada como una nueva solicitud.
Tipo: cadena
Restricciones de longitud: longitud mínima de 32. Longitud máxima de 128.
Obligatorio: no
** [ErrorReportConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **
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](API_query_ErrorReportConfiguration.md)
Obligatorio: sí
** [KmsKeyId](#API_query_CreateScheduledQuery_RequestSyntax) **
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 `SSE_KMS` se 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](#API_query_CreateScheduledQuery_RequestSyntax) **
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](#API_query_CreateScheduledQuery_RequestSyntax) **
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](API_query_NotificationConfiguration.md)
Obligatorio: sí
** [QueryString](#API_query_CreateScheduledQuery_RequestSyntax) **
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_runtime` está 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_runtime` pará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_runtime` se 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](#API_query_CreateScheduledQuery_RequestSyntax) **
La configuración programada para la consulta.
Tipo: objeto [ScheduleConfiguration](API_query_ScheduleConfiguration.md)
Obligatorio: sí
** [ScheduledQueryExecutionRoleArn](#API_query_CreateScheduledQuery_RequestSyntax) **
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](#API_query_CreateScheduledQuery_RequestSyntax) **
Lista de pares clave-valor para etiquetar la consulta programada.
Tipo: matriz de objetos [Tag](API_query_Tag.md)
Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.
Obligatorio: no
** [TargetConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **
Configuración que se utiliza para escribir el resultado de una consulta.
Tipo: objeto [TargetConfiguration](API_query_TargetConfiguration.md)
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](#API_query_CreateScheduledQuery_ResponseSyntax) **
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](CommonErrors.md).
** 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 uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/CreateScheduledQuery)
# DeleteScheduledQuery
Elimina una consulta programada determinada. Se trata de una operación irreversible.
## Sintaxis de la solicitud
```
{
"ScheduledQueryArn": "string"
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [ScheduledQueryArn](#API_query_DeleteScheduledQuery_RequestSyntax) **
El 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](CommonErrors.md).
** 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
## 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:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DeleteScheduledQuery)
# DescribeAccountSettings
Describe la configuración de su cuenta, que incluye el modelo de precios de las consultas y el máximo configurado que TCUs el servicio puede utilizar para la carga de trabajo de las consultas.
Solo se le cobrará por la duración de las unidades de cómputo que se utilizan para las cargas de trabajo.
## Sintaxis de la respuesta
```
{
"MaxQueryTCU": number,
"QueryCompute": {
"ComputeMode": "string",
"ProvisionedCapacity": {
"ActiveQueryTCU": number,
"LastUpdate": {
"Status": "string",
"StatusMessage": "string",
"TargetQueryTCU": number
},
"NotificationConfiguration": {
"RoleArn": "string",
"SnsConfiguration": {
"TopicArn": "string"
}
}
}
},
"QueryPricingModel": "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.
** [MaxQueryTCU](#API_query_DescribeAccountSettings_ResponseSyntax) **
El número máximo de [unidades de cálculo de Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/tcu.html) (TCUs) que el servicio utilizará en cualquier momento para atender sus consultas. Para ejecutar consultas, debe establecer una capacidad mínima de 4 TCU. Puede establecer la cantidad máxima de TCU en múltiplos de 4, como 4, 8, 16, 32, etc. Esta configuración solo se aplica al uso bajo demanda de ()TCUs.
Tipo: entero
** [QueryCompute](#API_query_DescribeAccountSettings_ResponseSyntax) **
Un objeto que contiene la configuración de uso de las unidades de cómputo de flujo temporal (TCUs) en su cuenta para la carga de trabajo de consulta. QueryCompute solo está disponible en la región de Asia Pacífico (Bombay).
Tipo: objeto [QueryComputeResponse](API_query_QueryComputeResponse.md)
** [QueryPricingModel](#API_query_DescribeAccountSettings_ResponseSyntax) **
El modelo de precios para las consultas de la cuenta.
Varias operaciones de Timestream utilizan el parámetro `QueryPricingModel`; sin embargo, la operación de la API `UpdateAccountSettings` no reconoce ningún otro valor que no sea `COMPUTE_UNITS`.
Tipo: cadena
Valores válidos: `BYTES_SCANNED | COMPUTE_UNITS`
## Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).
** 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
** ThrottlingException **
La solicitud se retrasó debido a una cantidad excesiva de solicitudes.
Código de estado HTTP: 400
## 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, consulte lo siguiente:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeAccountSettings)
# DescribeEndpoints
DescribeEndpoints devuelve una lista de puntos finales disponibles para realizar llamadas a la API de Timestream. Esta API está disponible a través de la escritura y la consulta.
Dado que los Timestream SDKs están diseñados para funcionar de forma transparente con la arquitectura del servicio, incluida la administración y el mapeo de los puntos finales del servicio, *no se recomienda* utilizar esta API a menos que:
+ Utiliza [puntos de conexión de VPC (AWS PrivateLink) con Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints).
+ Su aplicación utiliza un lenguaje de programación que aún no es compatible con SDK.
+ Necesita un mejor control sobre la implementación por parte del cliente.
Para obtener información detallada sobre cómo y cuándo usar e implementar DescribeEndpoints, consulte [The](https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery) Endpoint Discovery Pattern.
## Sintaxis de la respuesta
```
{
"Endpoints": [
{
"Address": "string",
"CachePeriodInMinutes": number
}
]
}
```
## 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.
** [Endpoints](#API_query_DescribeEndpoints_ResponseSyntax) **
Se muestra un objeto de `Endpoints` cuando se realiza una solicitud de `DescribeEndpoints`.
Tipo: matriz de objetos [Endpoint](API_query_Endpoint.md)
## Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).
** InternalServerException **
Se produjo un error de servidor interno al procesar la solicitud.
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 uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeEndpoints)
# DescribeScheduledQuery
Ofrece información detallada sobre una consulta programada.
## Sintaxis de la solicitud
```
{
"ScheduledQueryArn": "string"
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [ScheduledQueryArn](#API_query_DescribeScheduledQuery_RequestSyntax) **
El 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í
## Sintaxis de la respuesta
```
{
"ScheduledQuery": {
"Arn": "string",
"CreationTime": number,
"ErrorReportConfiguration": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"ObjectKeyPrefix": "string"
}
},
"KmsKeyId": "string",
"LastRunSummary": {
"ErrorReportLocation": {
"S3ReportLocation": {
"BucketName": "string",
"ObjectKey": "string"
}
},
"ExecutionStats": {
"BytesMetered": number,
"CumulativeBytesScanned": number,
"DataWrites": number,
"ExecutionTimeInMillis": number,
"QueryResultRows": number,
"RecordsIngested": number
},
"FailureReason": "string",
"InvocationTime": number,
"QueryInsightsResponse": {
"OutputBytes": number,
"OutputRows": number,
"QuerySpatialCoverage": {
"Max": {
"PartitionKey": [ "string" ],
"TableArn": "string",
"Value": number
}
},
"QueryTableCount": number,
"QueryTemporalRange": {
"Max": {
"TableArn": "string",
"Value": number
}
}
},
"RunStatus": "string",
"TriggerTime": number
},
"Name": "string",
"NextInvocationTime": number,
"NotificationConfiguration": {
"SnsConfiguration": {
"TopicArn": "string"
}
},
"PreviousInvocationTime": number,
"QueryString": "string",
"RecentlyFailedRuns": [
{
"ErrorReportLocation": {
"S3ReportLocation": {
"BucketName": "string",
"ObjectKey": "string"
}
},
"ExecutionStats": {
"BytesMetered": number,
"CumulativeBytesScanned": number,
"DataWrites": number,
"ExecutionTimeInMillis": number,
"QueryResultRows": number,
"RecordsIngested": number
},
"FailureReason": "string",
"InvocationTime": number,
"QueryInsightsResponse": {
"OutputBytes": number,
"OutputRows": number,
"QuerySpatialCoverage": {
"Max": {
"PartitionKey": [ "string" ],
"TableArn": "string",
"Value": number
}
},
"QueryTableCount": number,
"QueryTemporalRange": {
"Max": {
"TableArn": "string",
"Value": number
}
}
},
"RunStatus": "string",
"TriggerTime": number
}
],
"ScheduleConfiguration": {
"ScheduleExpression": "string"
},
"ScheduledQueryExecutionRoleArn": "string",
"State": "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"
}
}
}
}
```
## 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.
** [ScheduledQuery](#API_query_DescribeScheduledQuery_ResponseSyntax) **
La consulta programada.
Tipo: objeto [ScheduledQueryDescription](API_query_ScheduledQueryDescription.md)
## Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).
** 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
## 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:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeScheduledQuery)
# 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](https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html).
## 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](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [ClientToken](#API_query_ExecuteScheduledQuery_RequestSyntax) **
No se utiliza.
Tipo: cadena
Restricciones de longitud: longitud mínima de 32. Longitud máxima de 128.
Obligatorio: no
** [InvocationTime](#API_query_ExecuteScheduledQuery_RequestSyntax) **
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](#API_query_ExecuteScheduledQuery_RequestSyntax) **
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](API_query_ScheduledQueryInsights.md)
Obligatorio: no
** [ScheduledQueryArn](#API_query_ExecuteScheduledQuery_RequestSyntax) **
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](CommonErrors.md).
** 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\$1WITH\$1RATE\$1CONTROL
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:::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:::database/BaseDb/table/BaseTable",
"partitionKey": [
"measure_name"
]
}
},
"queryTemporalRange": {
"max": {
"value": 2399999999999,
"tableArn": "arn:aws:timestream:::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:::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\$1WITH\$1RATE\$1CONTROL
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:::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:::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:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ExecuteScheduledQuery)
# ListScheduledQueries
Obtiene una lista de todas las consultas programadas en la cuenta Amazon y región de la persona que llama. `ListScheduledQueries` acaba siendo coherente.
## Sintaxis de la solicitud
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [MaxResults](#API_query_ListScheduledQueries_RequestSyntax) **
La cantidad máxima de elementos que se devuelven en el resultado. Si la cantidad total de elementos disponibles es mayor que el valor especificado, se ofrece un `NextToken` en el resultado. Para reanudar la paginación, brinde el valor de `NextToken` como el argumento de la llamada posterior a `ListScheduledQueriesRequest`.
Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 1000.
Obligatorio: no
** [NextToken](#API_query_ListScheduledQueries_RequestSyntax) **
Un token de paginación para reanudar la paginación.
Tipo: cadena
Requerido: no
## Sintaxis de la respuesta
```
{
"NextToken": "string",
"ScheduledQueries": [
{
"Arn": "string",
"CreationTime": number,
"ErrorReportConfiguration": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"ObjectKeyPrefix": "string"
}
},
"LastRunStatus": "string",
"Name": "string",
"NextInvocationTime": number,
"PreviousInvocationTime": number,
"State": "string",
"TargetDestination": {
"TimestreamDestination": {
"DatabaseName": "string",
"TableName": "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.
** [NextToken](#API_query_ListScheduledQueries_ResponseSyntax) **
Un token destinado a especificar dónde iniciar la paginación. Esto NextToken proviene de una respuesta previamente truncada.
Tipo: cadena
** [ScheduledQueries](#API_query_ListScheduledQueries_ResponseSyntax) **
Una lista de consultas programadas.
Tipo: matriz de objetos [ScheduledQuery](API_query_ScheduledQuery.md)
## Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).
** 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
** 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 uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ListScheduledQueries)
# ListTagsForResource
Enumera todas las etiquetas de una consulta de recurso de Timestream.
## Sintaxis de la solicitud
```
{
"MaxResults": number,
"NextToken": "string",
"ResourceARN": "string"
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [MaxResults](#API_query_ListTagsForResource_RequestSyntax) **
Cantidad máxima de etiquetas que se mostrarán.
Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 200.
Obligatorio: no
** [NextToken](#API_query_ListTagsForResource_RequestSyntax) **
Un token de paginación para reanudar la paginación.
Tipo: cadena
Requerido: no
** [ResourceARN](#API_query_ListTagsForResource_RequestSyntax) **
El recurso de Timestream con las etiquetas que se van a incluir en la lista. Este valor es un Nombre de recurso de Amazon (ARN).
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.
Obligatorio: sí
## Sintaxis de la respuesta
```
{
"NextToken": "string",
"Tags": [
{
"Key": "string",
"Value": "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.
** [NextToken](#API_query_ListTagsForResource_ResponseSyntax) **
Un token de paginación para reanudar la paginación con una llamada posterior a `ListTagsForResourceResponse`.
Tipo: cadena
** [Tags](#API_query_ListTagsForResource_ResponseSyntax) **
Las etiquetas asociadas actualmente al recurso de Timestream.
Tipo: matriz de objetos [Tag](API_query_Tag.md)
Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.
## Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).
** 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
## 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:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ListTagsForResource)
# PrepareQuery
Operación sincrónica que permite enviar una consulta con parámetros para que Timestream los almacene para su ejecución posterior. Timestream solo admite el uso de esta operación con `ValidateOnly` se establece en `true`.
## Sintaxis de la solicitud
```
{
"QueryString": "string",
"ValidateOnly": boolean
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [QueryString](#API_query_PrepareQuery_RequestSyntax) **
La cadena de consulta de Timestream que quiere utilizar como sentencia preparada. Los nombres de los parámetros se pueden especificar en la cadena de consulta `@` seguida de un identificador.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 262144 caracteres.
Obligatorio: sí
** [ValidateOnly](#API_query_PrepareQuery_RequestSyntax) **
Al establecer este valor en `true`, Timestream solo validará que la cadena de consulta sea una consulta válida de Timestream y no almacenará la consulta preparada para su uso posterior.
Tipo: Booleano
Obligatorio: no
## Sintaxis de la respuesta
```
{
"Columns": [
{
"Aliased": boolean,
"DatabaseName": "string",
"Name": "string",
"TableName": "string",
"Type": {
"ArrayColumnInfo": {
"Name": "string",
"Type": "Type"
},
"RowColumnInfo": [
{
"Name": "string",
"Type": "Type"
}
],
"ScalarType": "string",
"TimeSeriesMeasureValueColumnInfo": {
"Name": "string",
"Type": "Type"
}
}
}
],
"Parameters": [
{
"Name": "string",
"Type": {
"ArrayColumnInfo": {
"Name": "string",
"Type": "Type"
},
"RowColumnInfo": [
{
"Name": "string",
"Type": "Type"
}
],
"ScalarType": "string",
"TimeSeriesMeasureValueColumnInfo": {
"Name": "string",
"Type": "Type"
}
}
}
],
"QueryString": "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.
** [Columns](#API_query_PrepareQuery_ResponseSyntax) **
Una lista de las columnas de la cláusula SELECT de la cadena de consulta que se envió.
Tipo: matriz de objetos [SelectColumn](API_query_SelectColumn.md)
** [Parameters](#API_query_PrepareQuery_ResponseSyntax) **
Una lista de los parámetros utilizados en la cadena de consulta que se envió.
Tipo: matriz de objetos [ParameterMapping](API_query_ParameterMapping.md)
** [QueryString](#API_query_PrepareQuery_ResponseSyntax) **
La cadena de consulta que quiere preparar.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 262144 caracteres.
## Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).
** 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
** 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 uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/PrepareQuery)
# Query
`Query` es una operación sincrónica que le permite ejecutar una consulta sobre sus datos de Amazon Timestream.
Si la habilitó `QueryInsights`, esta API también muestra información y métricas relacionadas con la consulta que ejecutó. `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](https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html).
**nota**
La cantidad máxima de solicitudes a la API de `Query` que puede realizar con la opción `QueryInsights` habilitada es de 1 consulta por segundo (QPS). Si supera esta tasa de consultas, es posible que se produzca una limitación.
`Query` se desconectará después de 60 segundos. Debe actualizar el tiempo de espera predeterminado en el SDK para que admita un tiempo de espera de 60 segundos. Consulte el [Ejemplo de código](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html) para obtener más detalles.
La solicitud de consulta fallará en los casos que se encuentra a continuación:
+ Si envía una solicitud de `Query` con el mismo token de cliente fuera del periodo de idempotencia de 5 minutos.
+ Si envía una solicitud de `Query` con el mismo token de cliente, pero cambia otros parámetros, dentro del periodo de idempotencia de 5 minutos.
+ Si el tamaño de la fila (incluidos los metadatos de la consulta) supera 1 MB, la consulta fallará y mostrará el siguiente mensaje de error:
`Query aborted as max page response size has been exceeded by the output result row`
+ Si el principal de IAM del iniciador de consultas y el lector de resultados no son iguales and/or , el iniciador de consultas y el lector de resultados no tienen la misma cadena de consulta en las solicitudes de consulta, la consulta fallará y se producirá un error. `Invalid pagination token`
## Sintaxis de la solicitud
```
{
"ClientToken": "string",
"MaxRows": number,
"NextToken": "string",
"QueryInsights": {
"Mode": "string"
},
"QueryString": "string"
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [ClientToken](#API_query_Query_RequestSyntax) **
Cadena única que distingue entre mayúsculas y minúsculas de hasta 64 caracteres ASCII que se especifica cuando se realiza una solicitud de `Query`. Si se brinda una `ClientToken`, la llamada a `Query` se vuelve *idempotente*. Esto significa que ejecutar la misma consulta de manera repetida producirá el mismo resultado. Es decir, hacer varias solicitudes de `Query` idénticas tiene el mismo efecto que realizar una sola solicitud. Cuando lo utilice `ClientToken` en una consulta, tenga en cuenta lo siguiente:
+ Si la API de consulta se crea sin un `ClientToken`, el SDK de consulta genera un `ClientToken` en su nombre.
+ Si la invocación de `Query` solo contiene el `ClientToken`, pero no incluye un `NextToken`, se supone que la invocación de la `Query` se trata de una nueva ejecución de consulta.
+ Si la invocación contiene `NextToken`, se supone que esa invocación específica es una invocación posterior de una llamada anterior a la API de consulta y se muestra un conjunto de resultados.
+ Transcurridas 4 horas, cualquier solicitud con la misma información `ClientToken` se considerará una solicitud nueva.
Tipo: cadena
Restricciones de longitud: longitud mínima de 32. Longitud máxima de 128.
Obligatorio: no
** [MaxRows](#API_query_Query_RequestSyntax) **
La cantidad total de filas que se mostrarán en el resultado de `Query`. La ejecución inicial de `Query` con un valor `MaxRows` especificado mostrará el conjunto de resultados de la consulta en dos casos:
+ El tamaño del resultado es inferior a `1MB`.
+ La cantidad de filas del conjunto de resultados es inferior al valor de `maxRows`.
De lo contrario, la invocación inicial de `Query` solo muestra un `NextToken`, que luego se puede utilizar en llamadas posteriores para obtener el conjunto de resultados. Para reanudar la paginación, proporcione el valor de `NextToken` en el comando posterior.
Si el tamaño de la fila es grande (por ejemplo, una fila tiene muchas columnas), Timestream puede mostrar menos filas para evitar que el tamaño de la respuesta supere el límite de 1 MB. Si no se brinda `MaxRows`, Timestream enviará la cantidad de filas necesaria para cumplir con el límite de 1 MB.
Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 1000.
Obligatorio: no
** [NextToken](#API_query_Query_RequestSyntax) **
Un token de paginación que se utiliza para mostrar un conjunto de resultados. Cuando se invoca la API de `Query` mediante `NextToken`, se supone que esa invocación específica es una invocación posterior de una llamada anterior a la `Query` y se muestra un conjunto de resultados. Sin embargo, si la invocación de `Query` solo contiene el `ClientToken`, se supone que la invocación de la `Query` se trata de una nueva ejecución de consulta.
Tenga en cuenta lo siguiente cuando lo utilice NextToken en una consulta:
+ Un token de paginación puede utilizarse para un máximo de cinco invocaciones de `Query` O durante un máximo de 1 hora, lo que ocurra primero.
+ Si se usa el mismo `NextToken`, se obtendrá el mismo conjunto de registros. Para seguir paginando el conjunto de resultados, debe utilizar el `nextToken` más reciente.
+ Supongamos que una invocación de `Query` muestra dos valores de `NextToken`, `TokenA` y `TokenB`. Si se utiliza `TokenB` en una invocación de `Query` posterior, se invalida `TokenA` y no se puede reutilizar.
+ Para solicitar un conjunto de resultados anterior de una consulta después de que se inicie la paginación, debe volver a invocar la API de consultas.
+ El último `NextToken` debe usarse para paginar hasta que se muestre `null`, momento en el que se debe utilizar un `NextToken` nuevo.
+ Si el principal de IAM del iniciador de la consulta y el lector de resultados no son iguales, el iniciador de and/or la consulta y el lector de resultados no tienen la misma cadena de consulta en las solicitudes de consulta, la consulta fallará y se generará un error. `Invalid pagination token`
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.
Obligatorio: no
** [QueryInsights](#API_query_Query_RequestSyntax) **
Encapsula la configuración para habilitar una `QueryInsights`.
La habilitación de `QueryInsights` muestra información y métricas además de los resultados de la consulta que ejecutó. Puede utilizar las `QueryInsights` para ajustar el rendimiento de sus consultas.
Tipo: objeto [QueryInsights](API_query_QueryInsights.md)
Obligatorio: no
** [QueryString](#API_query_Query_RequestSyntax) **
La consulta que ejecutará Timestream.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 262144 caracteres.
Obligatorio: sí
## Sintaxis de la respuesta
```
{
"ColumnInfo": [
{
"Name": "string",
"Type": {
"ArrayColumnInfo": "ColumnInfo",
"RowColumnInfo": [
"ColumnInfo"
],
"ScalarType": "string",
"TimeSeriesMeasureValueColumnInfo": "ColumnInfo"
}
}
],
"NextToken": "string",
"QueryId": "string",
"QueryInsightsResponse": {
"OutputBytes": number,
"OutputRows": number,
"QuerySpatialCoverage": {
"Max": {
"PartitionKey": [ "string" ],
"TableArn": "string",
"Value": number
}
},
"QueryTableCount": number,
"QueryTemporalRange": {
"Max": {
"TableArn": "string",
"Value": number
}
},
"UnloadPartitionCount": number,
"UnloadWrittenBytes": number,
"UnloadWrittenRows": number
},
"QueryStatus": {
"CumulativeBytesMetered": number,
"CumulativeBytesScanned": number,
"ProgressPercentage": number
},
"Rows": [
{
"Data": [
{
"ArrayValue": [
"Datum"
],
"NullValue": boolean,
"RowValue": "Row",
"ScalarValue": "string",
"TimeSeriesValue": [
{
"Time": "string",
"Value": "Datum"
}
]
}
]
}
]
}
```
## 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.
** [ColumnInfo](#API_query_Query_ResponseSyntax) **
Los tipos de datos de la columna del conjunto de datos que se muestra.
Tipo: matriz de objetos [ColumnInfo](API_query_ColumnInfo.md)
** [NextToken](#API_query_Query_ResponseSyntax) **
Un token de paginación que se puede volver a utilizar en una llamada de `Query` para obtener el siguiente conjunto de resultados.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.
** [QueryId](#API_query_Query_ResponseSyntax) **
Un identificador único para la consulta determinada.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.
Patrón: `[a-zA-Z0-9]+`
** [QueryInsightsResponse](#API_query_Query_ResponseSyntax) **
Encapsula `QueryInsights` que contiene información y métricas relacionadas con la consulta que ejecutó.
Tipo: objeto [QueryInsightsResponse](API_query_QueryInsightsResponse.md)
** [QueryStatus](#API_query_Query_ResponseSyntax) **
Información sobre el estado de la consulta, incluidos el progreso y los bytes que se escanearon.
Tipo: objeto [QueryStatus](API_query_QueryStatus.md)
** [Rows](#API_query_Query_ResponseSyntax) **
Las filas del conjunto de resultados que muestra la consulta.
Tipo: matriz de objetos [Row](API_query_Row.md)
## Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).
** 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
** QueryExecutionException **
Timestream no pudo ejecutar la consulta de manera correcta.
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 uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/Query)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/Query)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Query)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/Query)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Query)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/Query)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/Query)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/Query)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/Query)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Query)
# TagResource
Asocia un conjunto de etiquetas con un recurso de Timestream. Puede habilitar estas etiquetas definidas por el usuario de modo que aparezcan en la consola de facturación y administración de costos y así poder usarlas para el seguimiento de asignación de costos.
## Sintaxis de la solicitud
```
{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [ResourceARN](#API_query_TagResource_RequestSyntax) **
Identifica el recurso de Timestream al que se deben agregar las etiquetas. Este valor es un Nombre de recurso de Amazon (ARN).
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.
Obligatorio: sí
** [Tags](#API_query_TagResource_RequestSyntax) **
Las etiquetas que se van a asignar al recurso de Timestream .
Tipo: matriz de objetos [Tag](API_query_Tag.md)
Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.
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](CommonErrors.md).
** 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
** 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 uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/TagResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TagResource)
# UntagResource
Elimina la asociación de etiquetas de un recurso de consulta de Timestream.
## Sintaxis de la solicitud
```
{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [ResourceARN](#API_query_UntagResource_RequestSyntax) **
El recurso de Timestream del que se eliminarán las etiquetas. Este valor es un Nombre de recurso de Amazon (ARN).
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.
Obligatorio: sí
** [TagKeys](#API_query_UntagResource_RequestSyntax) **
Una lista de claves de etiquetas. Las etiquetas existentes del recurso con claves que son miembros de esta lista se eliminarán del recurso de Timestream.
Tipo: matriz de cadenas
Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 128 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](CommonErrors.md).
** 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
## 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:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UntagResource)
# UpdateAccountSettings
Hace la transición de su cuenta TCUs para utilizarla en los precios de las consultas y modifica el número máximo de unidades de cálculo de consultas que ha configurado. Si reduce el valor de `MaxQueryTCU` a la configuración deseada, el nuevo valor puede tardar hasta 24 horas en hacerse efectivo.
**nota**
Una vez que haya hecho la transición de su cuenta TCUs para utilizarla en los precios de consulta, no podrá pasar a utilizar los bytes escaneados para utilizar los precios de consulta.
## Sintaxis de la solicitud
```
{
"MaxQueryTCU": number,
"QueryCompute": {
"ComputeMode": "string",
"ProvisionedCapacity": {
"NotificationConfiguration": {
"RoleArn": "string",
"SnsConfiguration": {
"TopicArn": "string"
}
},
"TargetQueryTCU": number
}
},
"QueryPricingModel": "string"
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [MaxQueryTCU](#API_query_UpdateAccountSettings_RequestSyntax) **
La cantidad máxima de unidades de cómputo de Timestream que el servicio utilizará en cualquier momento para atender las consultas. Para ejecutar consultas, debe establecer una capacidad mínima de 4 TCU. Puede establecer la cantidad máxima de TCU en múltiplos de 4, como 4, 8, 16, 32, etc. El valor máximo admitido de `MaxQueryTCU` es 1000. Para solicitar un aumento de este límite flexible, ponte en contacto con AWS Support. Para obtener más información acerca de la cuota predeterminada de maxQueryTCU, consulte Cuotas predeterminadas. Esta configuración solo se aplica al uso bajo demanda de las unidades de cómputo Timestream ()TCUs.
El valor máximo admitido de `MaxQueryTCU` es 1000. Para solicitar un aumento de este límite flexible, ponte en contacto con AWS Support. Para obtener más información acerca de la cuota predeterminada de `maxQueryTCU`, consulte [Cuotas predeterminadas](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.default).
Tipo: entero
Obligatorio: no
** [QueryCompute](#API_query_UpdateAccountSettings_RequestSyntax) **
Modifica los ajustes de procesamiento de consultas configurados en su cuenta, incluidos el modelo de precios de las consultas y las unidades de cálculo de flujo temporal (TCUs) aprovisionadas en su cuenta. QueryCompute está disponible solo en la región de Asia Pacífico (Bombay).
Esta API es idempotente, lo que significa que realizar la misma solicitud muchas veces tendrá el mismo efecto que hacer la solicitud una vez.
Tipo: objeto [QueryComputeRequest](API_query_QueryComputeRequest.md)
Obligatorio: no
** [QueryPricingModel](#API_query_UpdateAccountSettings_RequestSyntax) **
El modelo de precios para las consultas de la cuenta.
Varias operaciones de Timestream utilizan el parámetro `QueryPricingModel`; sin embargo, la operación de la API `UpdateAccountSettings` no reconoce ningún otro valor que no sea `COMPUTE_UNITS`.
Tipo: cadena
Valores válidos: `BYTES_SCANNED | COMPUTE_UNITS`
Obligatorio: no
## Sintaxis de la respuesta
```
{
"MaxQueryTCU": number,
"QueryCompute": {
"ComputeMode": "string",
"ProvisionedCapacity": {
"ActiveQueryTCU": number,
"LastUpdate": {
"Status": "string",
"StatusMessage": "string",
"TargetQueryTCU": number
},
"NotificationConfiguration": {
"RoleArn": "string",
"SnsConfiguration": {
"TopicArn": "string"
}
}
}
},
"QueryPricingModel": "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.
** [MaxQueryTCU](#API_query_UpdateAccountSettings_ResponseSyntax) **
La cantidad máxima configurada de unidades de cómputo de Timestream que el servicio utilizará en cualquier momento para atender las consultas.
Tipo: entero
** [QueryCompute](#API_query_UpdateAccountSettings_ResponseSyntax) **
Confirma la configuración actualizada de la cuenta para consultar los datos de su cuenta. QueryCompute está disponible solo en la región de Asia Pacífico (Bombay).
Tipo: objeto [QueryComputeResponse](API_query_QueryComputeResponse.md)
** [QueryPricingModel](#API_query_UpdateAccountSettings_ResponseSyntax) **
El modelo de precios para una cuenta.
Tipo: cadena
Valores válidos: `BYTES_SCANNED | COMPUTE_UNITS`
## Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).
** 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
** 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 uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UpdateAccountSettings)
# UpdateScheduledQuery
Actualizar la consulta programada.
## Sintaxis de la solicitud
```
{
"ScheduledQueryArn": "string",
"State": "string"
}
```
## Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).
La solicitud acepta los siguientes datos en formato JSON.
** [ScheduledQueryArn](#API_query_UpdateScheduledQuery_RequestSyntax) **
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í
** [State](#API_query_UpdateScheduledQuery_RequestSyntax) **
Estado de la consulta programada.
Tipo: cadena
Valores válidos: `ENABLED | DISABLED`
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](CommonErrors.md).
** 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
## 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:
+ [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UpdateScheduledQuery)