/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the timestream-query-2018-11-01.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.TimestreamQuery.Model;
namespace Amazon.TimestreamQuery
{
///
/// Interface for accessing TimestreamQuery
///
/// Amazon Timestream Query
///
public partial interface IAmazonTimestreamQuery : IAmazonService, IDisposable
{
///
/// Paginators for the service
///
ITimestreamQueryPaginatorFactory Paginators { get; }
#region CancelQuery
///
/// 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.
///
/// Container for the necessary parameters to execute the CancelQuery service method.
///
/// The response from the CancelQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for CancelQuery Operation
CancelQueryResponse CancelQuery(CancelQueryRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the CancelQuery service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CancelQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for CancelQuery Operation
Task CancelQueryAsync(CancelQueryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateScheduledQuery
///
/// 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.
///
/// Container for the necessary parameters to execute the CreateScheduledQuery service method.
///
/// The response from the CreateScheduledQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Unable to poll results for a cancelled query.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// You have exceeded the service quota.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for CreateScheduledQuery Operation
CreateScheduledQueryResponse CreateScheduledQuery(CreateScheduledQueryRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the CreateScheduledQuery service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateScheduledQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Unable to poll results for a cancelled query.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// You have exceeded the service quota.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for CreateScheduledQuery Operation
Task CreateScheduledQueryAsync(CreateScheduledQueryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteScheduledQuery
///
/// Deletes a given scheduled query. This is an irreversible operation.
///
/// Container for the necessary parameters to execute the DeleteScheduledQuery service method.
///
/// The response from the DeleteScheduledQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for DeleteScheduledQuery Operation
DeleteScheduledQueryResponse DeleteScheduledQuery(DeleteScheduledQueryRequest request);
///
/// Deletes a given scheduled query. This is an irreversible operation.
///
/// Container for the necessary parameters to execute the DeleteScheduledQuery service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteScheduledQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for DeleteScheduledQuery Operation
Task DeleteScheduledQueryAsync(DeleteScheduledQueryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeEndpoints
///
/// 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:
///
///
///
/// For detailed information on how and when to use and implement DescribeEndpoints, see
/// The
/// Endpoint Discovery Pattern.
///
///
/// Container for the necessary parameters to execute the DescribeEndpoints service method.
///
/// The response from the DescribeEndpoints service method, as returned by TimestreamQuery.
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for DescribeEndpoints Operation
DescribeEndpointsResponse DescribeEndpoints(DescribeEndpointsRequest request);
///
/// 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:
///
///
///
/// For detailed information on how and when to use and implement DescribeEndpoints, see
/// The
/// Endpoint Discovery Pattern.
///
///
/// Container for the necessary parameters to execute the DescribeEndpoints service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeEndpoints service method, as returned by TimestreamQuery.
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for DescribeEndpoints Operation
Task DescribeEndpointsAsync(DescribeEndpointsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeScheduledQuery
///
/// Provides detailed information about a scheduled query.
///
/// Container for the necessary parameters to execute the DescribeScheduledQuery service method.
///
/// The response from the DescribeScheduledQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for DescribeScheduledQuery Operation
DescribeScheduledQueryResponse DescribeScheduledQuery(DescribeScheduledQueryRequest request);
///
/// Provides detailed information about a scheduled query.
///
/// Container for the necessary parameters to execute the DescribeScheduledQuery service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeScheduledQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for DescribeScheduledQuery Operation
Task DescribeScheduledQueryAsync(DescribeScheduledQueryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ExecuteScheduledQuery
///
/// You can use this API to run a scheduled query manually.
///
/// Container for the necessary parameters to execute the ExecuteScheduledQuery service method.
///
/// The response from the ExecuteScheduledQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for ExecuteScheduledQuery Operation
ExecuteScheduledQueryResponse ExecuteScheduledQuery(ExecuteScheduledQueryRequest request);
///
/// You can use this API to run a scheduled query manually.
///
/// Container for the necessary parameters to execute the ExecuteScheduledQuery service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ExecuteScheduledQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for ExecuteScheduledQuery Operation
Task ExecuteScheduledQueryAsync(ExecuteScheduledQueryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListScheduledQueries
///
/// Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
/// is eventually consistent.
///
/// Container for the necessary parameters to execute the ListScheduledQueries service method.
///
/// The response from the ListScheduledQueries service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for ListScheduledQueries Operation
ListScheduledQueriesResponse ListScheduledQueries(ListScheduledQueriesRequest request);
///
/// Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
/// is eventually consistent.
///
/// Container for the necessary parameters to execute the ListScheduledQueries service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListScheduledQueries service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for ListScheduledQueries Operation
Task ListScheduledQueriesAsync(ListScheduledQueriesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// List all tags on a Timestream query resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by TimestreamQuery.
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// List all tags on a Timestream query resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by TimestreamQuery.
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PrepareQuery
///
/// 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
/// the PrepareQueryRequest$ValidateOnly set to true.
///
/// Container for the necessary parameters to execute the PrepareQuery service method.
///
/// The response from the PrepareQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for PrepareQuery Operation
PrepareQueryResponse PrepareQuery(PrepareQueryRequest request);
///
/// 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
/// the PrepareQueryRequest$ValidateOnly set to true.
///
/// Container for the necessary parameters to execute the PrepareQuery service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PrepareQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for PrepareQuery Operation
Task PrepareQueryAsync(PrepareQueryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region Query
///
/// Query is a synchronous operation that enables you to run a query against
/// your Amazon Timestream data. 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.
///
///
///
/// Container for the necessary parameters to execute the Query service method.
///
/// The response from the Query service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Unable to poll results for a cancelled query.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// Timestream was unable to run the query successfully.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for Query Operation
QueryResponse Query(QueryRequest request);
///
/// Query is a synchronous operation that enables you to run a query against
/// your Amazon Timestream data. 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.
///
///
///
/// Container for the necessary parameters to execute the Query service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the Query service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Unable to poll results for a cancelled query.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// Timestream was unable to run the query successfully.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for Query Operation
Task QueryAsync(QueryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// 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.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by TimestreamQuery.
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// You have exceeded the service quota.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by TimestreamQuery.
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// You have exceeded the service quota.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Removes the association of tags from a Timestream query resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by TimestreamQuery.
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Removes the association of tags from a Timestream query resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by TimestreamQuery.
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateScheduledQuery
///
/// Update a scheduled query.
///
/// Container for the necessary parameters to execute the UpdateScheduledQuery service method.
///
/// The response from the UpdateScheduledQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for UpdateScheduledQuery Operation
UpdateScheduledQueryResponse UpdateScheduledQuery(UpdateScheduledQueryRequest request);
///
/// Update a scheduled query.
///
/// Container for the necessary parameters to execute the UpdateScheduledQuery service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateScheduledQuery service method, as returned by TimestreamQuery.
///
/// You are not authorized to perform this action.
///
///
/// Timestream was unable to fully process this request because of an internal server
/// error.
///
///
/// The requested endpoint was not valid.
///
///
/// The requested resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
/// Invalid or malformed request.
///
/// REST API Reference for UpdateScheduledQuery Operation
Task UpdateScheduledQueryAsync(UpdateScheduledQueryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}