/* * 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.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 { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// ITimestreamQueryPaginatorFactory Paginators { get; } #endif #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); /// /// Initiates the asynchronous execution of the CancelQuery operation. /// /// /// Container for the necessary parameters to execute the CancelQuery operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelQuery /// operation. /// REST API Reference for CancelQuery Operation IAsyncResult BeginCancelQuery(CancelQueryRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CancelQuery operation. /// /// /// The IAsyncResult returned by the call to BeginCancelQuery. /// /// Returns a CancelQueryResult from TimestreamQuery. /// REST API Reference for CancelQuery Operation CancelQueryResponse EndCancelQuery(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the CreateScheduledQuery operation. /// /// /// Container for the necessary parameters to execute the CreateScheduledQuery operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateScheduledQuery /// operation. /// REST API Reference for CreateScheduledQuery Operation IAsyncResult BeginCreateScheduledQuery(CreateScheduledQueryRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateScheduledQuery operation. /// /// /// The IAsyncResult returned by the call to BeginCreateScheduledQuery. /// /// Returns a CreateScheduledQueryResult from TimestreamQuery. /// REST API Reference for CreateScheduledQuery Operation CreateScheduledQueryResponse EndCreateScheduledQuery(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the DeleteScheduledQuery operation. /// /// /// Container for the necessary parameters to execute the DeleteScheduledQuery operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteScheduledQuery /// operation. /// REST API Reference for DeleteScheduledQuery Operation IAsyncResult BeginDeleteScheduledQuery(DeleteScheduledQueryRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteScheduledQuery operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteScheduledQuery. /// /// Returns a DeleteScheduledQueryResult from TimestreamQuery. /// REST API Reference for DeleteScheduledQuery Operation DeleteScheduledQueryResponse EndDeleteScheduledQuery(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the DescribeEndpoints operation. /// /// /// Container for the necessary parameters to execute the DescribeEndpoints operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEndpoints /// operation. /// REST API Reference for DescribeEndpoints Operation IAsyncResult BeginDescribeEndpoints(DescribeEndpointsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeEndpoints operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeEndpoints. /// /// Returns a DescribeEndpointsResult from TimestreamQuery. /// REST API Reference for DescribeEndpoints Operation DescribeEndpointsResponse EndDescribeEndpoints(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the DescribeScheduledQuery operation. /// /// /// Container for the necessary parameters to execute the DescribeScheduledQuery operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeScheduledQuery /// operation. /// REST API Reference for DescribeScheduledQuery Operation IAsyncResult BeginDescribeScheduledQuery(DescribeScheduledQueryRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeScheduledQuery operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeScheduledQuery. /// /// Returns a DescribeScheduledQueryResult from TimestreamQuery. /// REST API Reference for DescribeScheduledQuery Operation DescribeScheduledQueryResponse EndDescribeScheduledQuery(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the ExecuteScheduledQuery operation. /// /// /// Container for the necessary parameters to execute the ExecuteScheduledQuery operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteScheduledQuery /// operation. /// REST API Reference for ExecuteScheduledQuery Operation IAsyncResult BeginExecuteScheduledQuery(ExecuteScheduledQueryRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ExecuteScheduledQuery operation. /// /// /// The IAsyncResult returned by the call to BeginExecuteScheduledQuery. /// /// Returns a ExecuteScheduledQueryResult from TimestreamQuery. /// REST API Reference for ExecuteScheduledQuery Operation ExecuteScheduledQueryResponse EndExecuteScheduledQuery(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the ListScheduledQueries operation. /// /// /// Container for the necessary parameters to execute the ListScheduledQueries operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListScheduledQueries /// operation. /// REST API Reference for ListScheduledQueries Operation IAsyncResult BeginListScheduledQueries(ListScheduledQueriesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListScheduledQueries operation. /// /// /// The IAsyncResult returned by the call to BeginListScheduledQueries. /// /// Returns a ListScheduledQueriesResult from TimestreamQuery. /// REST API Reference for ListScheduledQueries Operation ListScheduledQueriesResponse EndListScheduledQueries(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from TimestreamQuery. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the PrepareQuery operation. /// /// /// Container for the necessary parameters to execute the PrepareQuery operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPrepareQuery /// operation. /// REST API Reference for PrepareQuery Operation IAsyncResult BeginPrepareQuery(PrepareQueryRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the PrepareQuery operation. /// /// /// The IAsyncResult returned by the call to BeginPrepareQuery. /// /// Returns a PrepareQueryResult from TimestreamQuery. /// REST API Reference for PrepareQuery Operation PrepareQueryResponse EndPrepareQuery(IAsyncResult asyncResult); #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: /// /// /// /// 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); /// /// Initiates the asynchronous execution of the Query operation. /// /// /// Container for the necessary parameters to execute the Query operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndQuery /// operation. /// REST API Reference for Query Operation IAsyncResult BeginQuery(QueryRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the Query operation. /// /// /// The IAsyncResult returned by the call to BeginQuery. /// /// Returns a QueryResult from TimestreamQuery. /// REST API Reference for Query Operation QueryResponse EndQuery(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from TimestreamQuery. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from TimestreamQuery. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #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); /// /// Initiates the asynchronous execution of the UpdateScheduledQuery operation. /// /// /// Container for the necessary parameters to execute the UpdateScheduledQuery operation on AmazonTimestreamQueryClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateScheduledQuery /// operation. /// REST API Reference for UpdateScheduledQuery Operation IAsyncResult BeginUpdateScheduledQuery(UpdateScheduledQueryRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateScheduledQuery operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateScheduledQuery. /// /// Returns a UpdateScheduledQueryResult from TimestreamQuery. /// REST API Reference for UpdateScheduledQuery Operation UpdateScheduledQueryResponse EndUpdateScheduledQuery(IAsyncResult asyncResult); #endregion } }