/*
* 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 rds-data-2018-08-01.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.RDSDataService.Model;
namespace Amazon.RDSDataService
{
///
/// Interface for accessing RDSDataService
///
/// Amazon RDS Data Service
///
/// Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless
/// v1 DB cluster. To run these statements, you work with the Data Service API.
///
///
///
/// The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.
///
///
///
/// For more information about the Data Service API, see Using
/// the Data API in the Amazon Aurora User Guide.
///
///
///
///
public partial interface IAmazonRDSDataService : IAmazonService, IDisposable
{
#region BatchExecuteStatement
///
/// Runs a batch SQL statement over an array of data.
///
///
///
/// You can run bulk update and insert operations for multiple records using a DML statement
/// with different parameter sets. Bulk operations can provide a significant performance
/// improvement over individual insert and update operations.
///
///
///
/// If a call isn't part of a transaction because it doesn't include the transactionID
/// parameter, changes that result from the call are committed automatically.
///
///
///
/// There isn't a fixed upper limit on the number of parameter sets. However, the maximum
/// size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds
/// this limit, the Data API returns an error and doesn't process the request. This 4-MiB
/// limit includes the size of the HTTP headers and the JSON notation in the request.
/// Thus, the number of parameter sets that you can include depends on a combination of
/// factors, such as the size of the SQL statement and the size of each parameter set.
///
///
///
/// The response size limit is 1 MiB. If the call returns more than 1 MiB of response
/// data, the call is terminated.
///
///
///
/// Container for the necessary parameters to execute the BatchExecuteStatement service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the BatchExecuteStatement service method, as returned by RDSDataService.
///
/// You do not have sufficient access to perform this action.
///
///
/// There is an error in the call or in a SQL statement.
///
///
/// There are insufficient privileges to make the call.
///
///
/// An internal error occurred.
///
///
/// The service specified by the resourceArn parameter is not available.
///
///
/// The execution of the SQL statement timed out.
///
/// REST API Reference for BatchExecuteStatement Operation
Task BatchExecuteStatementAsync(BatchExecuteStatementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region BeginTransaction
///
/// Starts a SQL transaction.
///
///
///
/// A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled
/// back automatically after 24 hours.
///
///
///
/// A transaction times out if no calls use its transaction ID in three minutes. If a
/// transaction times out before it's committed, it's rolled back automatically.
///
///
///
/// DDL statements inside a transaction cause an implicit commit. We recommend that you
/// run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout
/// enabled.
///
///
///
/// Container for the necessary parameters to execute the BeginTransaction service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the BeginTransaction service method, as returned by RDSDataService.
///
/// You do not have sufficient access to perform this action.
///
///
/// There is an error in the call or in a SQL statement.
///
///
/// There are insufficient privileges to make the call.
///
///
/// An internal error occurred.
///
///
/// The service specified by the resourceArn parameter is not available.
///
///
/// The execution of the SQL statement timed out.
///
/// REST API Reference for BeginTransaction Operation
Task BeginTransactionAsync(BeginTransactionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CommitTransaction
///
/// Ends a SQL transaction started with the BeginTransaction operation and
/// commits the changes.
///
/// Container for the necessary parameters to execute the CommitTransaction service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CommitTransaction service method, as returned by RDSDataService.
///
/// You do not have sufficient access to perform this action.
///
///
/// There is an error in the call or in a SQL statement.
///
///
/// There are insufficient privileges to make the call.
///
///
/// An internal error occurred.
///
///
/// The resourceArn, secretArn, or transactionId
/// value can't be found.
///
///
/// The service specified by the resourceArn parameter is not available.
///
///
/// The execution of the SQL statement timed out.
///
/// REST API Reference for CommitTransaction Operation
Task CommitTransactionAsync(CommitTransactionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ExecuteSql
///
/// Runs one or more SQL statements.
///
///
///
/// This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement
/// operation.
///
///
///
/// Container for the necessary parameters to execute the ExecuteSql service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ExecuteSql service method, as returned by RDSDataService.
///
/// You do not have sufficient access to perform this action.
///
///
/// There is an error in the call or in a SQL statement.
///
///
/// There are insufficient privileges to make the call.
///
///
/// An internal error occurred.
///
///
/// The service specified by the resourceArn parameter is not available.
///
/// REST API Reference for ExecuteSql Operation
[Obsolete("ExecuteSql has been deprecated. Please use ExecuteStatement or BatchExecuteStatement instead.")]
Task ExecuteSqlAsync(ExecuteSqlRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ExecuteStatement
///
/// Runs a SQL statement against a database.
///
///
///
/// If a call isn't part of a transaction because it doesn't include the transactionID
/// parameter, changes that result from the call are committed automatically.
///
///
///
/// If the binary response data from the database is more than 1 MB, the call is terminated.
///
///
///
/// Container for the necessary parameters to execute the ExecuteStatement service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ExecuteStatement service method, as returned by RDSDataService.
///
/// You do not have sufficient access to perform this action.
///
///
/// There is an error in the call or in a SQL statement.
///
///
/// There are insufficient privileges to make the call.
///
///
/// An internal error occurred.
///
///
/// The service specified by the resourceArn parameter is not available.
///
///
/// The execution of the SQL statement timed out.
///
/// REST API Reference for ExecuteStatement Operation
Task ExecuteStatementAsync(ExecuteStatementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RollbackTransaction
///
/// Performs a rollback of a transaction. Rolling back a transaction cancels its changes.
///
/// Container for the necessary parameters to execute the RollbackTransaction service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RollbackTransaction service method, as returned by RDSDataService.
///
/// You do not have sufficient access to perform this action.
///
///
/// There is an error in the call or in a SQL statement.
///
///
/// There are insufficient privileges to make the call.
///
///
/// An internal error occurred.
///
///
/// The resourceArn, secretArn, or transactionId
/// value can't be found.
///
///
/// The service specified by the resourceArn parameter is not available.
///
///
/// The execution of the SQL statement timed out.
///
/// REST API Reference for RollbackTransaction Operation
Task RollbackTransactionAsync(RollbackTransactionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}