RDSDataService

public struct RDSDataService

Client object for interacting with AWS RDSDataService service.

Amazon RDS Data Service Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DB cluster. To run these statements, you work with the Data Service API. For more information about the Data Service API, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide. If you have questions or comments related to the Data API, send email to Rds-data-api-feedback@amazon.com.

Member variables

Initialization

  • Initialize the RDSDataService client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • 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.

    Declaration

    Swift

    public func batchExecuteStatement(_ input: BatchExecuteStatementRequest) -> EventLoopFuture<BatchExecuteStatementResponse>

  • Starts a SQL transaction. <important> <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.</p> <p>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.</p> <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p> </important>

    Declaration

    Swift

    public func beginTransaction(_ input: BeginTransactionRequest) -> EventLoopFuture<BeginTransactionResponse>

  • Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

    Declaration

    Swift

    public func commitTransaction(_ input: CommitTransactionRequest) -> EventLoopFuture<CommitTransactionResponse>

  • Runs one or more SQL statements. This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

    Declaration

    Swift

    @available(*, deprecated, message: "The ExecuteSql API is deprecated, please use the ExecuteStatement API.")
public func executeSql(_ input: ExecuteSqlRequest) -> EventLoopFuture<ExecuteSqlResponse>

  • 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. The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

    Declaration

    Swift

    public func executeStatement(_ input: ExecuteStatementRequest) -> EventLoopFuture<ExecuteStatementResponse>

  • Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

    Declaration

    Swift

    public func rollbackTransaction(_ input: RollbackTransactionRequest) -> EventLoopFuture<RollbackTransactionResponse>

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum DecimalReturnType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TypeHint : String, CustomStringConvertible, Codable

Shapes