Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample for details.
Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.
Deletes a given scheduled query. This is an irreversible operation.
", "endpointdiscovery":{"required":true}, "idempotent":true }, "DescribeAccountSettings":{ "name":"DescribeAccountSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountSettingsRequest"}, "output":{"shape":"DescribeAccountSettingsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"InvalidEndpointException"} ], "documentation":"Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.
You're charged only for the duration of compute units used for your workloads.
", "endpointdiscovery":{"required":true} }, "DescribeEndpoints":{ "name":"DescribeEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEndpointsRequest"}, "output":{"shape":"DescribeEndpointsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:
You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream
Your application uses a programming language that does not yet have SDK support
You require better control over the client-side implementation
For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.
", "endpointoperation":true }, "DescribeScheduledQuery":{ "name":"DescribeScheduledQuery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScheduledQueryRequest"}, "output":{"shape":"DescribeScheduledQueryResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"InvalidEndpointException"} ], "documentation":"Provides detailed information about a scheduled query.
", "endpointdiscovery":{"required":true} }, "ExecuteScheduledQuery":{ "name":"ExecuteScheduledQuery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExecuteScheduledQueryRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"InvalidEndpointException"} ], "documentation":"You can use this API to run a scheduled query manually.
If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed as part of an Amazon SNS notification. QueryInsights helps with performance tuning of your query. For more information about QueryInsights, see Using query insights to optimize queries in Amazon Timestream.
Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.
List all tags on a Timestream query resource.
", "endpointdiscovery":{"required":true} }, "PrepareQuery":{ "name":"PrepareQuery", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PrepareQueryRequest"}, "output":{"shape":"PrepareQueryResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"InvalidEndpointException"} ], "documentation":"A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with ValidateOnly set to true.
Query is a synchronous operation that enables you to run a query against your Amazon Timestream data.
If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed. QueryInsights helps with performance tuning of your query. For more information about QueryInsights, see Using query insights to optimize queries in Amazon Timestream.
The maximum number of Query API requests you're allowed to make with QueryInsights enabled is 1 query per second (QPS). If you exceed this query rate, it might result in throttling.
Query will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the code sample for details.
Your query request will fail in the following cases:
If you submit a Query request with the same client token outside of the 5-minute idempotency window.
If you submit a Query request with the same client token, but change other parameters, within the 5-minute idempotency window.
If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message:
Query aborted as max page response size has been exceeded by the output result row
If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an Invalid pagination token error.
Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.
", "endpointdiscovery":{"required":true} }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidEndpointException"} ], "documentation":"Removes the association of tags from a Timestream query resource.
", "endpointdiscovery":{"required":true} }, "UpdateAccountSettings":{ "name":"UpdateAccountSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAccountSettingsRequest"}, "output":{"shape":"UpdateAccountSettingsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"InvalidEndpointException"} ], "documentation":"Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective.
After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.
Update a scheduled query.
", "endpointdiscovery":{"required":true} } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"ServiceErrorMessage"} }, "documentation":"You do not have the necessary permissions to access the account settings.
", "exception":true, "synthetic":true }, "AccountSettingsNotificationConfiguration":{ "type":"structure", "required":["RoleArn"], "members":{ "SnsConfiguration":{"shape":"SnsConfiguration"}, "RoleArn":{ "shape":"AmazonResourceName", "documentation":"An Amazon Resource Name (ARN) that grants Timestream permission to publish notifications. This field is only visible if SNS Topic is provided when updating the account settings.
" } }, "documentation":"Configuration settings for notifications related to account settings.
" }, "AmazonResourceName":{ "type":"string", "max":2048, "min":1 }, "CancelQueryRequest":{ "type":"structure", "required":["QueryId"], "members":{ "QueryId":{ "shape":"QueryId", "documentation":" The ID of the query that needs to be cancelled. QueryID is returned as part of the query result.
A CancellationMessage is returned when a CancelQuery request for the query specified by QueryId has already been issued.
The name of the result set column. The name of the result set is available for columns of all data types except for arrays.
" }, "Type":{ "shape":"Type", "documentation":"The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, Booleans, and others. Complex data types are types such as arrays, rows, and others.
" } }, "documentation":"Contains the metadata for query results such as the column names, data types, and other attributes.
" }, "ColumnInfoList":{ "type":"list", "member":{"shape":"ColumnInfo"} }, "ComputeMode":{ "type":"string", "enum":[ "ON_DEMAND", "PROVISIONED" ] }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"Unable to poll results for a cancelled query.
", "exception":true }, "CreateScheduledQueryRequest":{ "type":"structure", "required":[ "Name", "QueryString", "ScheduleConfiguration", "NotificationConfiguration", "ScheduledQueryExecutionRoleArn", "ErrorReportConfiguration" ], "members":{ "Name":{ "shape":"ScheduledQueryName", "documentation":"Name of the scheduled query.
" }, "QueryString":{ "shape":"QueryString", "documentation":"The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.
The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
The schedule configuration for the query.
" }, "NotificationConfiguration":{ "shape":"NotificationConfiguration", "documentation":"Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
" }, "TargetConfiguration":{ "shape":"TargetConfiguration", "documentation":"Configuration used for writing the result of a query.
" }, "ClientToken":{ "shape":"ClientToken", "documentation":"Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.
If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.
After 8 hours, any request with the same ClientToken is treated as a new request.
The ARN for the IAM role that Timestream will assume when running the scheduled query.
" }, "Tags":{ "shape":"TagList", "documentation":"A list of key-value pairs to label the scheduled query.
" }, "KmsKeyId":{ "shape":"StringValue2048", "documentation":"The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/
If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
" } } }, "CreateScheduledQueryResponse":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"AmazonResourceName", "documentation":"ARN for the created scheduled query.
" } } }, "Datum":{ "type":"structure", "members":{ "ScalarValue":{ "shape":"ScalarValue", "documentation":"Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
" }, "TimeSeriesValue":{ "shape":"TimeSeriesDataPointList", "documentation":"Indicates if the data point is a timeseries data type.
" }, "ArrayValue":{ "shape":"DatumList", "documentation":"Indicates if the data point is an array.
" }, "RowValue":{ "shape":"Row", "documentation":"Indicates if the data point is a row.
" }, "NullValue":{ "shape":"NullableBoolean", "documentation":"Indicates if the data point is null.
" } }, "documentation":"Datum represents a single data point in a query result.
" }, "DatumList":{ "type":"list", "member":{"shape":"Datum"} }, "DeleteScheduledQueryRequest":{ "type":"structure", "required":["ScheduledQueryArn"], "members":{ "ScheduledQueryArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the scheduled query.
" } } }, "DescribeAccountSettingsRequest":{ "type":"structure", "members":{} }, "DescribeAccountSettingsResponse":{ "type":"structure", "members":{ "MaxQueryTCU":{ "shape":"MaxQueryCapacity", "documentation":"The maximum number of Timestream compute units (TCUs) the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. This configuration is applicable only for on-demand usage of (TCUs).
" }, "QueryPricingModel":{ "shape":"QueryPricingModel", "documentation":"The pricing model for queries in your account.
The QueryPricingModel parameter is used by several Timestream operations; however, the UpdateAccountSettings API operation doesn't recognize any values other than COMPUTE_UNITS.
An object that contains the usage settings for Timestream Compute Units (TCUs) in your account for the query workload.
" } } }, "DescribeEndpointsRequest":{ "type":"structure", "members":{} }, "DescribeEndpointsResponse":{ "type":"structure", "required":["Endpoints"], "members":{ "Endpoints":{ "shape":"Endpoints", "documentation":"An Endpoints object is returned when a DescribeEndpoints request is made.
The ARN of the scheduled query.
" } } }, "DescribeScheduledQueryResponse":{ "type":"structure", "required":["ScheduledQuery"], "members":{ "ScheduledQuery":{ "shape":"ScheduledQueryDescription", "documentation":"The scheduled query.
" } } }, "DimensionMapping":{ "type":"structure", "required":[ "Name", "DimensionValueType" ], "members":{ "Name":{ "shape":"SchemaName", "documentation":"Column name from query result.
" }, "DimensionValueType":{ "shape":"DimensionValueType", "documentation":"Type for the dimension.
" } }, "documentation":"This type is used to map column(s) from the query result to a dimension in the destination table.
" }, "DimensionMappingList":{ "type":"list", "member":{"shape":"DimensionMapping"} }, "DimensionValueType":{ "type":"string", "enum":["VARCHAR"] }, "Double":{"type":"double"}, "Endpoint":{ "type":"structure", "required":[ "Address", "CachePeriodInMinutes" ], "members":{ "Address":{ "shape":"String", "documentation":"An endpoint address.
" }, "CachePeriodInMinutes":{ "shape":"Long", "documentation":"The TTL for the endpoint, in minutes.
" } }, "documentation":"Represents an available endpoint against which to make API calls against, as well as the TTL for that endpoint.
" }, "Endpoints":{ "type":"list", "member":{"shape":"Endpoint"} }, "ErrorMessage":{"type":"string"}, "ErrorReportConfiguration":{ "type":"structure", "required":["S3Configuration"], "members":{ "S3Configuration":{ "shape":"S3Configuration", "documentation":"The S3 configuration for the error reports.
" } }, "documentation":"Configuration required for error reporting.
" }, "ErrorReportLocation":{ "type":"structure", "members":{ "S3ReportLocation":{ "shape":"S3ReportLocation", "documentation":"The S3 location where error reports are written.
" } }, "documentation":"This contains the location of the error report for a single scheduled query call.
" }, "ExecuteScheduledQueryRequest":{ "type":"structure", "required":[ "ScheduledQueryArn", "InvocationTime" ], "members":{ "ScheduledQueryArn":{ "shape":"AmazonResourceName", "documentation":"ARN of the scheduled query.
" }, "InvocationTime":{ "shape":"Time", "documentation":"The timestamp in UTC. Query will be run as if it was invoked at this timestamp.
" }, "ClientToken":{ "shape":"ClientToken", "documentation":"Not used.
", "idempotencyToken":true }, "QueryInsights":{ "shape":"ScheduledQueryInsights", "documentation":"Encapsulates settings for enabling QueryInsights.
Enabling QueryInsights returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use QueryInsights to tune your query performance and cost.
Total time, measured in milliseconds, that was needed for the scheduled query run to complete.
" }, "DataWrites":{ "shape":"Long", "documentation":"Data writes metered for records ingested in a single scheduled query run.
" }, "BytesMetered":{ "shape":"Long", "documentation":"Bytes metered for a single scheduled query run.
" }, "CumulativeBytesScanned":{ "shape":"Long", "documentation":"Bytes scanned for a single scheduled query run.
" }, "RecordsIngested":{ "shape":"Long", "documentation":"The number of records ingested for a single scheduled query run.
" }, "QueryResultRows":{ "shape":"Long", "documentation":"Number of rows present in the output from running a query before ingestion to destination data source.
" } }, "documentation":"Statistics for a single scheduled query run.
" }, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"An internal server error occurred while processing the request.
", "exception":true }, "InvalidEndpointException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"The requested endpoint is invalid.
", "exception":true }, "LastUpdate":{ "type":"structure", "members":{ "TargetQueryTCU":{ "shape":"QueryTCU", "documentation":"The number of TimeStream Compute Units (TCUs) requested in the last account settings update.
" }, "Status":{ "shape":"LastUpdateStatus", "documentation":"The status of the last update. Can be either PENDING, FAILED, or SUCCEEDED.
Error message describing the last account settings update status, visible only if an error occurred.
" } }, "documentation":"Configuration object that contains the most recent account settings update, visible only if settings have been updated previously.
" }, "LastUpdateStatus":{ "type":"string", "enum":[ "PENDING", "FAILED", "SUCCEEDED" ] }, "ListScheduledQueriesRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxScheduledQueriesResults", "documentation":"The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as the argument to the subsequent call to ListScheduledQueriesRequest.
A pagination token to resume pagination.
" } } }, "ListScheduledQueriesResponse":{ "type":"structure", "required":["ScheduledQueries"], "members":{ "ScheduledQueries":{ "shape":"ScheduledQueryList", "documentation":"A list of scheduled queries.
" }, "NextToken":{ "shape":"NextScheduledQueriesResultsToken", "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceARN"], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).
" }, "MaxResults":{ "shape":"MaxTagsForResourceResult", "documentation":"The maximum number of tags to return.
" }, "NextToken":{ "shape":"NextTagsForResourceResultsToken", "documentation":"A pagination token to resume pagination.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "required":["Tags"], "members":{ "Tags":{ "shape":"TagList", "documentation":"The tags currently associated with the Timestream resource.
" }, "NextToken":{ "shape":"NextTagsForResourceResultsToken", "documentation":"A pagination token to resume pagination with a subsequent call to ListTagsForResourceResponse.
Refers to the value of measure_name in a result row. This field is required if MeasureNameColumn is provided.
" }, "SourceColumn":{ "shape":"SchemaName", "documentation":"This field refers to the source column from which measure-value is to be read for result materialization.
" }, "TargetMeasureName":{ "shape":"SchemaName", "documentation":"Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.
" }, "MeasureValueType":{ "shape":"MeasureValueType", "documentation":"Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.
" }, "MultiMeasureAttributeMappings":{ "shape":"MultiMeasureAttributeMappingList", "documentation":"Required when measureValueType is MULTI. Attribute mappings for MULTI value measures.
" } }, "documentation":"MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.
" }, "MixedMeasureMappingList":{ "type":"list", "member":{"shape":"MixedMeasureMapping"}, "min":1 }, "MultiMeasureAttributeMapping":{ "type":"structure", "required":[ "SourceColumn", "MeasureValueType" ], "members":{ "SourceColumn":{ "shape":"SchemaName", "documentation":"Source column from where the attribute value is to be read.
" }, "TargetMultiMeasureAttributeName":{ "shape":"SchemaName", "documentation":"Custom name to be used for attribute name in derived table. If not provided, source column name would be used.
" }, "MeasureValueType":{ "shape":"ScalarMeasureValueType", "documentation":"Type of the attribute to be read from the source column.
" } }, "documentation":"Attribute mapping for MULTI value measures.
" }, "MultiMeasureAttributeMappingList":{ "type":"list", "member":{"shape":"MultiMeasureAttributeMapping"}, "min":1 }, "MultiMeasureMappings":{ "type":"structure", "required":["MultiMeasureAttributeMappings"], "members":{ "TargetMultiMeasureName":{ "shape":"SchemaName", "documentation":"The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.
" }, "MultiMeasureAttributeMappings":{ "shape":"MultiMeasureAttributeMappingList", "documentation":"Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
" } }, "documentation":"Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided. MultiMeasureMappings can be used to ingest data as multi measures in the derived table.
" }, "NextScheduledQueriesResultsToken":{"type":"string"}, "NextTagsForResourceResultsToken":{"type":"string"}, "NotificationConfiguration":{ "type":"structure", "required":["SnsConfiguration"], "members":{ "SnsConfiguration":{ "shape":"SnsConfiguration", "documentation":"Details about the Amazon Simple Notification Service (SNS) configuration. This field is visible only when SNS Topic is provided when updating the account settings.
" } }, "documentation":"Notification configuration for a scheduled query. A notification is sent by Timestream when a scheduled query is created, its state is updated or when it is deleted.
" }, "NullableBoolean":{ "type":"boolean", "box":true }, "PaginationToken":{ "type":"string", "max":2048, "min":1 }, "ParameterMapping":{ "type":"structure", "required":[ "Name", "Type" ], "members":{ "Name":{ "shape":"String", "documentation":"Parameter name.
" }, "Type":{"shape":"Type"} }, "documentation":"Mapping for named parameters.
" }, "ParameterMappingList":{ "type":"list", "member":{"shape":"ParameterMapping"} }, "PartitionKey":{"type":"string"}, "PartitionKeyList":{ "type":"list", "member":{"shape":"PartitionKey"} }, "PrepareQueryRequest":{ "type":"structure", "required":["QueryString"], "members":{ "QueryString":{ "shape":"QueryString", "documentation":"The Timestream query string that you want to use as a prepared statement. Parameter names can be specified in the query string @ character followed by an identifier.
By setting this value to true, Timestream will only validate that the query string is a valid Timestream query, and not store the prepared query for later use.
The query string that you want prepare.
" }, "Columns":{ "shape":"SelectColumnList", "documentation":"A list of SELECT clause columns of the submitted query string.
" }, "Parameters":{ "shape":"ParameterMappingList", "documentation":"A list of parameters used in the submitted query string.
" } } }, "ProvisionedCapacityRequest":{ "type":"structure", "required":["TargetQueryTCU"], "members":{ "TargetQueryTCU":{ "shape":"QueryTCU", "documentation":"The target compute capacity for querying data, specified in Timestream Compute Units (TCUs).
" }, "NotificationConfiguration":{ "shape":"AccountSettingsNotificationConfiguration", "documentation":"Configuration settings for notifications related to the provisioned capacity update.
" } }, "documentation":"A request to update the provisioned capacity settings for querying data.
" }, "ProvisionedCapacityResponse":{ "type":"structure", "members":{ "ActiveQueryTCU":{ "shape":"QueryTCU", "documentation":"The number of Timestream Compute Units (TCUs) provisioned in the account. This field is only visible when the compute mode is PROVISIONED.
An object that contains settings for notifications that are sent whenever the provisioned capacity settings are modified. This field is only visible when the compute mode is PROVISIONED.
Information about the last update to the provisioned capacity settings.
" } }, "documentation":"The response to a request to update the provisioned capacity settings for querying data.
" }, "QueryComputeRequest":{ "type":"structure", "members":{ "ComputeMode":{ "shape":"ComputeMode", "documentation":"The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value PROVISIONED.
Configuration object that contains settings for provisioned Timestream Compute Units (TCUs) in your account.
" } }, "documentation":"A request to retrieve or update the compute capacity settings for querying data.
" }, "QueryComputeResponse":{ "type":"structure", "members":{ "ComputeMode":{ "shape":"ComputeMode", "documentation":"The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value PROVISIONED.
Configuration object that contains settings for provisioned Timestream Compute Units (TCUs) in your account.
" } }, "documentation":"The response to a request to retrieve or update the compute capacity settings for querying data.
" }, "QueryExecutionException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"Timestream was unable to run the query successfully.
", "exception":true }, "QueryId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9]+" }, "QueryInsights":{ "type":"structure", "required":["Mode"], "members":{ "Mode":{ "shape":"QueryInsightsMode", "documentation":"Provides the following modes to enable QueryInsights:
ENABLED_WITH_RATE_CONTROL – Enables QueryInsights for the queries being processed. This mode also includes a rate control mechanism, which limits the QueryInsights feature to 1 query per second (QPS).
DISABLED – Disables QueryInsights.
QueryInsights is a performance tuning feature that helps you optimize your queries, reducing costs and improving performance. With QueryInsights, you can assess the pruning efficiency of your queries and identify areas for improvement to enhance query performance. With QueryInsights, you can also analyze the effectiveness of your queries in terms of temporal and spatial pruning, and identify opportunities to improve performance. Specifically, you can evaluate how well your queries use time-based and partition key-based indexing strategies to optimize data retrieval. To optimize query performance, it's essential that you fine-tune both the temporal and spatial parameters that govern query execution.
The key metrics provided by QueryInsights are QuerySpatialCoverage and QueryTemporalRange. QuerySpatialCoverage indicates how much of the spatial axis the query scans, with lower values being more efficient. QueryTemporalRange shows the time range scanned, with narrower ranges being more performant.
Benefits of QueryInsights
The following are the key benefits of using QueryInsights:
Identifying inefficient queries – QueryInsights provides information on the time-based and attribute-based pruning of the tables accessed by the query. This information helps you identify the tables that are sub-optimally accessed.
Optimizing your data model and partitioning – You can use the QueryInsights information to access and fine-tune your data model and partitioning strategy.
Tuning queries – QueryInsights highlights opportunities to use indexes more effectively.
The maximum number of Query API requests you're allowed to make with QueryInsights enabled is 1 query per second (QPS). If you exceed this query rate, it might result in throttling.
Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning.
" }, "QueryTemporalRange":{ "shape":"QueryTemporalRange", "documentation":"Provides insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning:
Add missing time-predicates.
Remove functions around the time predicates.
Add time predicates to all the sub-queries.
Indicates the number of tables in the query.
", "box":true }, "OutputRows":{ "shape":"Long", "documentation":"Indicates the total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise.
", "box":true }, "OutputBytes":{ "shape":"Long", "documentation":"Indicates the size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise.
", "box":true }, "UnloadPartitionCount":{ "shape":"Long", "documentation":"Indicates the partitions created by the Unload operation.
Indicates the rows written by the Unload query.
Indicates the size, in bytes, written by the Unload operation.
Provides various insights and metrics related to the query that you executed.
" }, "QueryPricingModel":{ "type":"string", "enum":[ "BYTES_SCANNED", "COMPUTE_UNITS" ] }, "QueryRequest":{ "type":"structure", "required":["QueryString"], "members":{ "QueryString":{ "shape":"QueryString", "documentation":"The query to be run by Timestream.
" }, "ClientToken":{ "shape":"ClientRequestToken", "documentation":" Unique, case-sensitive string of up to 64 ASCII characters specified when a Query request is made. Providing a ClientToken makes the call to Query idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query requests has the same effect as making a single request. When using ClientToken in a query, note the following:
If the Query API is instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.
If the Query invocation only contains the ClientToken but does not include a NextToken, that invocation of Query is assumed to be a new query run.
If the invocation contains NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to the Query API, and a result set is returned.
After 4 hours, any request with the same ClientToken is treated as a new request.
A pagination token used to return a set of results. When the Query API is invoked using NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to Query, and a result set is returned. However, if the Query invocation only contains the ClientToken, that invocation of Query is assumed to be a new query run.
Note the following when using NextToken in a query:
A pagination token can be used for up to five Query invocations, OR for a duration of up to 1 hour – whichever comes first.
Using the same NextToken will return the same set of records. To keep paginating through the result set, you must to use the most recent nextToken.
Suppose a Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a subsequent Query invocation, then TokenA is invalidated and cannot be reused.
To request a previous result set from a query after pagination has begun, you must re-invoke the Query API.
The latest NextToken should be used to paginate until null is returned, at which point a new NextToken should be used.
If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an Invalid pagination token error.
The total number of rows to be returned in the Query output. The initial run of Query with a MaxRows value specified will return the result set of the query in two cases:
The size of the result is less than 1MB.
The number of rows in the result set is less than the value of maxRows.
Otherwise, the initial invocation of Query only returns a NextToken, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken value in the subsequent command.
If the row size is large (e.g. a row has many columns), Timestream may return fewer rows to keep the response size from exceeding the 1 MB limit. If MaxRows is not provided, Timestream will send the necessary number of rows to meet the 1 MB limit.
Encapsulates settings for enabling QueryInsights.
Enabling QueryInsights returns insights and metrics in addition to query results for the query that you executed. You can use QueryInsights to tune your query performance.
A unique ID for the given query.
" }, "NextToken":{ "shape":"PaginationToken", "documentation":" A pagination token that can be used again on a Query call to get the next set of results.
The result set rows returned by the query.
" }, "ColumnInfo":{ "shape":"ColumnInfoList", "documentation":"The column data types of the returned result set.
" }, "QueryStatus":{ "shape":"QueryStatus", "documentation":"Information about the status of the query, including progress and bytes scanned.
" }, "QueryInsightsResponse":{ "shape":"QueryInsightsResponse", "documentation":"Encapsulates QueryInsights containing insights and metrics related to the query that you executed.
Provides insights into the spatial coverage of the executed query and the table with the most inefficient spatial pruning.
Value – The maximum ratio of spatial coverage.
TableArn – The Amazon Resource Name (ARN) of the table with sub-optimal spatial pruning.
PartitionKey – The partition key used for partitioning, which can be a default measure_name or a CDPK.
Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning
For example, you can do the following with the QuerySpatialCoverage information:
Add measure_name or use customer-defined partition key (CDPK) predicates.
If you've already done the preceding action, remove functions around them or clauses, such as LIKE.
The maximum ratio of spatial coverage.
" }, "TableArn":{ "shape":"AmazonResourceName", "documentation":"The Amazon Resource Name (ARN) of the table with the most sub-optimal spatial pruning.
" }, "PartitionKey":{ "shape":"PartitionKeyList", "documentation":"The partition key used for partitioning, which can be a default measure_name or a customer defined partition key.
Provides insights into the table with the most sub-optimal spatial range scanned by your query.
" }, "QueryStatus":{ "type":"structure", "members":{ "ProgressPercentage":{ "shape":"Double", "documentation":"The progress of the query, expressed as a percentage.
" }, "CumulativeBytesScanned":{ "shape":"Long", "documentation":"The amount of data scanned by the query in bytes. This is a cumulative sum and represents the total amount of bytes scanned since the query was started.
" }, "CumulativeBytesMetered":{ "shape":"Long", "documentation":"The amount of data scanned by the query in bytes that you will be charged for. This is a cumulative sum and represents the total amount of data that you will be charged for since the query was started. The charge is applied only once and is either applied when the query completes running or when the query is cancelled.
" } }, "documentation":"Information about the status of the query, including progress and bytes scanned.
" }, "QueryString":{ "type":"string", "max":262144, "min":1, "sensitive":true }, "QueryTCU":{"type":"integer"}, "QueryTemporalRange":{ "type":"structure", "members":{ "Max":{ "shape":"QueryTemporalRangeMax", "documentation":"Encapsulates the following properties that provide insights into the most sub-optimal performing table on the temporal axis:
Value – The maximum duration in nanoseconds between the start and end of the query.
TableArn – The Amazon Resource Name (ARN) of the table which is queried with the largest time range.
Provides insights into the temporal range of the query, including the table with the largest (max) time range.
" }, "QueryTemporalRangeMax":{ "type":"structure", "members":{ "Value":{ "shape":"Long", "documentation":"The maximum duration in nanoseconds between the start and end of the query.
" }, "TableArn":{ "shape":"AmazonResourceName", "documentation":"The Amazon Resource Name (ARN) of the table which is queried with the largest time range.
" } }, "documentation":"Provides insights into the table with the most sub-optimal temporal pruning scanned by your query.
" }, "ResourceName":{"type":"string"}, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"}, "ScheduledQueryArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the scheduled query.
" } }, "documentation":"The requested resource could not be found.
", "exception":true }, "Row":{ "type":"structure", "required":["Data"], "members":{ "Data":{ "shape":"DatumList", "documentation":"List of data points in a single row of the result set.
" } }, "documentation":"Represents a single row in the query results.
" }, "RowList":{ "type":"list", "member":{"shape":"Row"} }, "S3BucketName":{ "type":"string", "max":63, "min":3, "pattern":"[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" }, "S3Configuration":{ "type":"structure", "required":["BucketName"], "members":{ "BucketName":{ "shape":"S3BucketName", "documentation":"Name of the S3 bucket under which error reports will be created.
" }, "ObjectKeyPrefix":{ "shape":"S3ObjectKeyPrefix", "documentation":"Prefix for the error report key. Timestream by default adds the following prefix to the error report path.
" }, "EncryptionOption":{ "shape":"S3EncryptionOption", "documentation":"Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
" } }, "documentation":"Details on S3 location for error reports that result from running a query.
" }, "S3EncryptionOption":{ "type":"string", "enum":[ "SSE_S3", "SSE_KMS" ] }, "S3ObjectKey":{"type":"string"}, "S3ObjectKeyPrefix":{ "type":"string", "max":896, "min":1, "pattern":"[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+" }, "S3ReportLocation":{ "type":"structure", "members":{ "BucketName":{ "shape":"S3BucketName", "documentation":"S3 bucket name.
" }, "ObjectKey":{ "shape":"S3ObjectKey", "documentation":"S3 key.
" } }, "documentation":"S3 report location for the scheduled query run.
" }, "ScalarMeasureValueType":{ "type":"string", "enum":[ "BIGINT", "BOOLEAN", "DOUBLE", "VARCHAR", "TIMESTAMP" ] }, "ScalarType":{ "type":"string", "enum":[ "VARCHAR", "BOOLEAN", "BIGINT", "DOUBLE", "TIMESTAMP", "DATE", "TIME", "INTERVAL_DAY_TO_SECOND", "INTERVAL_YEAR_TO_MONTH", "UNKNOWN", "INTEGER" ] }, "ScalarValue":{"type":"string"}, "ScheduleConfiguration":{ "type":"structure", "required":["ScheduleExpression"], "members":{ "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.
" } }, "documentation":"Configuration of the schedule of the query.
" }, "ScheduleExpression":{ "type":"string", "max":256, "min":1 }, "ScheduledQuery":{ "type":"structure", "required":[ "Arn", "Name", "State" ], "members":{ "Arn":{ "shape":"AmazonResourceName", "documentation":"The Amazon Resource Name.
" }, "Name":{ "shape":"ScheduledQueryName", "documentation":"The name of the scheduled query.
" }, "CreationTime":{ "shape":"Time", "documentation":"The creation time of the scheduled query.
" }, "State":{ "shape":"ScheduledQueryState", "documentation":"State of scheduled query.
" }, "PreviousInvocationTime":{ "shape":"Time", "documentation":"The last time the scheduled query was run.
" }, "NextInvocationTime":{ "shape":"Time", "documentation":"The next time the scheduled query is to be run.
" }, "ErrorReportConfiguration":{ "shape":"ErrorReportConfiguration", "documentation":"Configuration for scheduled query error reporting.
" }, "TargetDestination":{ "shape":"TargetDestination", "documentation":"Target data source where final scheduled query result will be written.
" }, "LastRunStatus":{ "shape":"ScheduledQueryRunStatus", "documentation":"Status of the last scheduled query run.
" } }, "documentation":"Scheduled Query
" }, "ScheduledQueryDescription":{ "type":"structure", "required":[ "Arn", "Name", "QueryString", "State", "ScheduleConfiguration", "NotificationConfiguration" ], "members":{ "Arn":{ "shape":"AmazonResourceName", "documentation":"Scheduled query ARN.
" }, "Name":{ "shape":"ScheduledQueryName", "documentation":"Name of the scheduled query.
" }, "QueryString":{ "shape":"QueryString", "documentation":"The query to be run.
" }, "CreationTime":{ "shape":"Time", "documentation":"Creation time of the scheduled query.
" }, "State":{ "shape":"ScheduledQueryState", "documentation":"State of the scheduled query.
" }, "PreviousInvocationTime":{ "shape":"Time", "documentation":"Last time the query was run.
" }, "NextInvocationTime":{ "shape":"Time", "documentation":"The next time the scheduled query is scheduled to run.
" }, "ScheduleConfiguration":{ "shape":"ScheduleConfiguration", "documentation":"Schedule configuration.
" }, "NotificationConfiguration":{ "shape":"NotificationConfiguration", "documentation":"Notification configuration.
" }, "TargetConfiguration":{ "shape":"TargetConfiguration", "documentation":"Scheduled query target store configuration.
" }, "ScheduledQueryExecutionRoleArn":{ "shape":"AmazonResourceName", "documentation":"IAM role that Timestream uses to run the schedule query.
" }, "KmsKeyId":{ "shape":"StringValue2048", "documentation":"A customer provided KMS key used to encrypt the scheduled query resource.
" }, "ErrorReportConfiguration":{ "shape":"ErrorReportConfiguration", "documentation":"Error-reporting configuration for the scheduled query.
" }, "LastRunSummary":{ "shape":"ScheduledQueryRunSummary", "documentation":"Runtime summary for the last scheduled query run.
" }, "RecentlyFailedRuns":{ "shape":"ScheduledQueryRunSummaryList", "documentation":"Runtime summary for the last five failed scheduled query runs.
" } }, "documentation":"Structure that describes scheduled query.
" }, "ScheduledQueryInsights":{ "type":"structure", "required":["Mode"], "members":{ "Mode":{ "shape":"ScheduledQueryInsightsMode", "documentation":"Provides the following modes to enable ScheduledQueryInsights:
ENABLED_WITH_RATE_CONTROL – Enables ScheduledQueryInsights for the queries being processed. This mode also includes a rate control mechanism, which limits the QueryInsights feature to 1 query per second (QPS).
DISABLED – Disables ScheduledQueryInsights.
Encapsulates settings for enabling QueryInsights on an ExecuteScheduledQueryRequest.
Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning.
" }, "QueryTemporalRange":{ "shape":"QueryTemporalRange", "documentation":"Provides insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning:
Add missing time-predicates.
Remove functions around the time predicates.
Add time predicates to all the sub-queries.
Indicates the number of tables in the query.
", "box":true }, "OutputRows":{ "shape":"Long", "documentation":"Indicates the total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise.
", "box":true }, "OutputBytes":{ "shape":"Long", "documentation":"Indicates the size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise.
", "box":true } }, "documentation":"Provides various insights and metrics related to the ExecuteScheduledQueryRequest that was executed.
InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter @scheduled_runtime can be used in the query to get the value.
The actual time when the query was run.
" }, "RunStatus":{ "shape":"ScheduledQueryRunStatus", "documentation":"The status of a scheduled query run.
" }, "ExecutionStats":{ "shape":"ExecutionStats", "documentation":"Runtime statistics for a scheduled run.
" }, "QueryInsightsResponse":{ "shape":"ScheduledQueryInsightsResponse", "documentation":"Provides various insights and metrics related to the run summary of the scheduled query.
" }, "ErrorReportLocation":{ "shape":"ErrorReportLocation", "documentation":"S3 location for error report.
" }, "FailureReason":{ "shape":"ErrorMessage", "documentation":"Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons.
" } }, "documentation":"Run summary for the scheduled query
" }, "ScheduledQueryRunSummaryList":{ "type":"list", "member":{"shape":"ScheduledQueryRunSummary"} }, "ScheduledQueryState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "SchemaName":{"type":"string"}, "SelectColumn":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"Name of the column.
" }, "Type":{"shape":"Type"}, "DatabaseName":{ "shape":"ResourceName", "documentation":"Database that has this column.
" }, "TableName":{ "shape":"ResourceName", "documentation":"Table within the database that has this column.
" }, "Aliased":{ "shape":"NullableBoolean", "documentation":"True, if the column name was aliased by the query. False otherwise.
" } }, "documentation":"Details of the column that is returned by the query.
" }, "SelectColumnList":{ "type":"list", "member":{"shape":"SelectColumn"} }, "ServiceErrorMessage":{"type":"string"}, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"You have exceeded the service quota.
", "exception":true }, "SnsConfiguration":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"AmazonResourceName", "documentation":"SNS topic ARN that the scheduled query status notifications will be sent to.
" } }, "documentation":"Details on SNS that are required to send the notification.
" }, "String":{"type":"string"}, "StringValue2048":{ "type":"string", "max":2048, "min":1 }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"The key of the tag. Tag keys are case sensitive.
" }, "Value":{ "shape":"TagValue", "documentation":"The value of the tag. Tag values are case sensitive and can be null.
" } }, "documentation":"A tag is a label that you assign to a Timestream database and/or table. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize databases and/or tables, for example, by purpose, owner, or environment.
" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":200, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "Tags" ], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN).
" }, "Tags":{ "shape":"TagList", "documentation":"The tags to be assigned to the Timestream resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "max":256, "min":0 }, "TargetConfiguration":{ "type":"structure", "required":["TimestreamConfiguration"], "members":{ "TimestreamConfiguration":{ "shape":"TimestreamConfiguration", "documentation":"Configuration needed to write data into the Timestream database and table.
" } }, "documentation":"Configuration used for writing the output of a query.
" }, "TargetDestination":{ "type":"structure", "members":{ "TimestreamDestination":{ "shape":"TimestreamDestination", "documentation":"Query result destination details for Timestream data source.
" } }, "documentation":"Destination details to write data for a target data source. Current supported data source is Timestream.
" }, "ThrottlingException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"The request was throttled due to excessive requests.
", "exception":true }, "Time":{"type":"timestamp"}, "TimeSeriesDataPoint":{ "type":"structure", "required":[ "Time", "Value" ], "members":{ "Time":{ "shape":"Timestamp", "documentation":"The timestamp when the measure value was collected.
" }, "Value":{ "shape":"Datum", "documentation":"The measure value for the data point.
" } }, "documentation":"The timeseries data type represents the values of a measure over time. A time series is an array of rows of timestamps and measure values, with rows sorted in ascending order of time. A TimeSeriesDataPoint is a single data point in the time series. It represents a tuple of (time, measure value) in a time series.
" }, "TimeSeriesDataPointList":{ "type":"list", "member":{"shape":"TimeSeriesDataPoint"} }, "Timestamp":{"type":"string"}, "TimestreamConfiguration":{ "type":"structure", "required":[ "DatabaseName", "TableName", "TimeColumn", "DimensionMappings" ], "members":{ "DatabaseName":{ "shape":"ResourceName", "documentation":"Name of Timestream database to which the query result will be written.
" }, "TableName":{ "shape":"ResourceName", "documentation":"Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.
" }, "TimeColumn":{ "shape":"SchemaName", "documentation":"Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
" }, "DimensionMappings":{ "shape":"DimensionMappingList", "documentation":"This is to allow mapping column(s) from the query result to the dimension in the destination table.
" }, "MultiMeasureMappings":{ "shape":"MultiMeasureMappings", "documentation":"Multi-measure mappings.
" }, "MixedMeasureMappings":{ "shape":"MixedMeasureMappingList", "documentation":"Specifies how to map measures to multi-measure records.
" }, "MeasureNameColumn":{ "shape":"SchemaName", "documentation":"Name of the measure column.
" } }, "documentation":"Configuration to write data into Timestream database and table. This configuration allows the user to map the query result select columns into the destination table columns.
" }, "TimestreamDestination":{ "type":"structure", "members":{ "DatabaseName":{ "shape":"ResourceName", "documentation":"Timestream database name.
" }, "TableName":{ "shape":"ResourceName", "documentation":"Timestream table name.
" } }, "documentation":"Destination for scheduled query.
" }, "Type":{ "type":"structure", "members":{ "ScalarType":{ "shape":"ScalarType", "documentation":"Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types.
" }, "ArrayColumnInfo":{ "shape":"ColumnInfo", "documentation":"Indicates if the column is an array.
" }, "TimeSeriesMeasureValueColumnInfo":{ "shape":"ColumnInfo", "documentation":"Indicates if the column is a timeseries data type.
" }, "RowColumnInfo":{ "shape":"ColumnInfoList", "documentation":"Indicates if the column is a row.
" } }, "documentation":"Contains the data type of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, Boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries.
" }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "TagKeys" ], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource.
" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdateAccountSettingsRequest":{ "type":"structure", "members":{ "MaxQueryTCU":{ "shape":"MaxQueryCapacity", "documentation":"The maximum number of compute units the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. The maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft limit, contact Amazon Web Services Support. For information about the default quota for maxQueryTCU, see Default quotas. This configuration is applicable only for on-demand usage of Timestream Compute Units (TCUs).
The maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft limit, contact Amazon Web Services Support. For information about the default quota for maxQueryTCU, see Default quotas.
The pricing model for queries in an account.
The QueryPricingModel parameter is used by several Timestream operations; however, the UpdateAccountSettings API operation doesn't recognize any values other than COMPUTE_UNITS.
Modifies the query compute settings configured in your account, including the query pricing model and provisioned Timestream Compute Units (TCUs) in your account.
This API is idempotent, meaning that making the same request multiple times will have the same effect as making the request once.
The configured maximum number of compute units the service will use at any point in time to serve your queries.
" }, "QueryPricingModel":{ "shape":"QueryPricingModel", "documentation":"The pricing model for an account.
" }, "QueryCompute":{ "shape":"QueryComputeResponse", "documentation":"Confirms the updated account settings for querying data in your account.
" } } }, "UpdateScheduledQueryRequest":{ "type":"structure", "required":[ "ScheduledQueryArn", "State" ], "members":{ "ScheduledQueryArn":{ "shape":"AmazonResourceName", "documentation":"ARN of the scheuled query.
" }, "State":{ "shape":"ScheduledQueryState", "documentation":"State of the scheduled query.
" } } }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"Invalid or malformed request.
", "exception":true } }, "documentation":"