Amazon RDS Data ServiceAPI Reference

API Version 2018-08-01

Amazon RDS Data Service API Reference

Amazon RDS Data Service: API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.

Amazon RDS Data Service API Reference

Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

BatchExecuteStatement .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

BeginTransaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

CommitTransaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

ExecuteSql ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

ExecuteStatement .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

RollbackTransaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26ArrayValue .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

API Version 2018-08-01iii

Amazon RDS Data Service API Reference

ColumnMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Field .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Record .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

ResultFrame .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

ResultSetMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

ResultSetOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

SqlParameter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

SqlStatementResult ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

StructValue .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

UpdateResult ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Value .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

API Version 2018-08-01iv

Amazon RDS Data Service API Reference

WelcomeAmazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DBcluster. 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 theAmazon Aurora User Guide.

NoteIf you have questions or comments related to the Data API, send email to Rds-data-api-feedback@amazon.com.

This document was last published on June 16, 2020.

API Version 2018-08-011

Amazon RDS Data Service API Reference

ActionsThe following actions are supported:

• BatchExecuteStatement (p. 3)• BeginTransaction (p. 7)• CommitTransaction (p. 10)• ExecuteSql (p. 13)• ExecuteStatement (p. 17)• RollbackTransaction (p. 23)

API Version 2018-08-012

Amazon RDS Data Service API ReferenceBatchExecuteStatement

BatchExecuteStatementRuns 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 differentparameter sets. Bulk operations can provide a significant performance improvement over individualinsert and update operations.

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

Request Syntax

POST /BatchExecute HTTP/1.1Content-type: application/json

{ "database": "string", "parameterSets": [ [ { "name": "string", "typeHint": "string", "value": { "arrayValue": { "arrayValues": [ "ArrayValue" ], "blobValues": [ blob ], "booleanValues": [ boolean ], "doubleValues": [ number ], "longValues": [ number ], "stringValues": [ "string" ] }, "blobValue": blob, "booleanValue": boolean, "doubleValue": number, "isNull": boolean, "longValue": number, "stringValue": "string", "structValue": { "string" : "Field" } } } ] ], "resourceArn": "string", "schema": "string", "secretArn": "string", "sql": "string", "transactionId": "string"}

URI Request ParametersThe request does not use any URI parameters.

API Version 2018-08-013

Amazon RDS Data Service API ReferenceRequest Body

Request BodyThe request accepts the following data in JSON format.

database (p. 3)

The name of the database.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: NoparameterSets (p. 3)

The parameter set for the batch operation.

The SQL statement is executed as many times as the number of parameter sets provided. To executea SQL statement with no parameters, use one of the following options:• Specify one or more empty parameter sets.• Use the ExecuteStatement operation instead of the BatchExecuteStatement operation.

NoteArray parameters are not supported.

Type: Array of arrays of SqlParameter (p. 37) objects

Required: NoresourceArn (p. 3)

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: Yesschema (p. 3)

The name of the database schema.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: NosecretArn (p. 3)

The name or ARN of the secret that enables access to the DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: Yessql (p. 3)

The SQL statement to run.

Type: String

API Version 2018-08-014

Amazon RDS Data Service API ReferenceResponse Syntax

Length Constraints: Minimum length of 0. Maximum length of 65536.

Required: YestransactionId (p. 3)

The identifier of a transaction that was started by using the BeginTransaction operation. Specifythe transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don't set this parameter.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 192.

Required: No

Response SyntaxHTTP/1.1 200Content-type: application/json

{ "updateResults": [ { "generatedFields": [ { "arrayValue": { "arrayValues": [ "ArrayValue" ], "blobValues": [ blob ], "booleanValues": [ boolean ], "doubleValues": [ number ], "longValues": [ number ], "stringValues": [ "string" ] }, "blobValue": blob, "booleanValue": boolean, "doubleValue": number, "isNull": boolean, "longValue": number, "stringValue": "string", "structValue": { "string" : "Field" } } ] } ]}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

updateResults (p. 5)

The execution results of each batch entry.

API Version 2018-08-015

Amazon RDS Data Service API ReferenceErrors

Type: Array of UpdateResult (p. 40) objects

ErrorsBadRequestException

There is an error in the call or in a SQL statement.

HTTP Status Code: 400ForbiddenException

There are insufficient privileges to make the call.

HTTP Status Code: 403InternalServerErrorException

An internal error occurred.

HTTP Status Code: 500ServiceUnavailableError

The service specified by the resourceArn parameter is not available.

HTTP Status Code: 503StatementTimeoutException

The execution of the SQL statement timed out.

HTTP Status Code: 400

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-016

Amazon RDS Data Service API ReferenceBeginTransaction

BeginTransactionStarts a SQL transaction.

ImportantA transaction can run for a maximum of 24 hours. A transaction is terminated and rolled backautomatically after 24 hours.A transaction times out if no calls use its transaction ID in three minutes. If a transaction timesout before it's committed, it's rolled back automatically.DDL statements inside a transaction cause an implicit commit. We recommend that you run eachDDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled.

Request SyntaxPOST /BeginTransaction HTTP/1.1Content-type: application/json

{ "database": "string", "resourceArn": "string", "schema": "string", "secretArn": "string"}

URI Request ParametersThe request does not use any URI parameters.

Request BodyThe request accepts the following data in JSON format.

database (p. 7)

The name of the database.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: NoresourceArn (p. 7)

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: Yesschema (p. 7)

The name of the database schema.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

API Version 2018-08-017

Amazon RDS Data Service API ReferenceResponse Syntax

Required: NosecretArn (p. 7)

The name or ARN of the secret that enables access to the DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: Yes

Response SyntaxHTTP/1.1 200Content-type: application/json

{ "transactionId": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

transactionId (p. 8)

The transaction ID of the transaction started by the call.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 192.

ErrorsBadRequestException

There is an error in the call or in a SQL statement.

HTTP Status Code: 400ForbiddenException

There are insufficient privileges to make the call.

HTTP Status Code: 403InternalServerErrorException

An internal error occurred.

HTTP Status Code: 500ServiceUnavailableError

The service specified by the resourceArn parameter is not available.

HTTP Status Code: 503

API Version 2018-08-018

Amazon RDS Data Service API ReferenceSee Also

StatementTimeoutException

The execution of the SQL statement timed out.

HTTP Status Code: 400

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-019

Amazon RDS Data Service API ReferenceCommitTransaction

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

Request SyntaxPOST /CommitTransaction HTTP/1.1Content-type: application/json

{ "resourceArn": "string", "secretArn": "string", "transactionId": "string"}

URI Request ParametersThe request does not use any URI parameters.

Request BodyThe request accepts the following data in JSON format.

resourceArn (p. 10)

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: YessecretArn (p. 10)

The name or ARN of the secret that enables access to the DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: YestransactionId (p. 10)

The identifier of the transaction to end and commit.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 192.

Required: Yes

Response SyntaxHTTP/1.1 200

API Version 2018-08-0110

Amazon RDS Data Service API ReferenceResponse Elements

Content-type: application/json

{ "transactionStatus": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

transactionStatus (p. 10)

The status of the commit operation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

ErrorsBadRequestException

There is an error in the call or in a SQL statement.

HTTP Status Code: 400ForbiddenException

There are insufficient privileges to make the call.

HTTP Status Code: 403InternalServerErrorException

An internal error occurred.

HTTP Status Code: 500NotFoundException

The resourceArn, secretArn, or transactionId value can't be found.

HTTP Status Code: 404ServiceUnavailableError

The service specified by the resourceArn parameter is not available.

HTTP Status Code: 503StatementTimeoutException

The execution of the SQL statement timed out.

HTTP Status Code: 400

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

API Version 2018-08-0111

Amazon RDS Data Service API ReferenceSee Also

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0112

Amazon RDS Data Service API ReferenceExecuteSql

ExecuteSqlRuns one or more SQL statements.

ImportantThis operation is deprecated. Use the BatchExecuteStatement or ExecuteStatementoperation.

Request SyntaxPOST /ExecuteSql HTTP/1.1Content-type: application/json

{ "awsSecretStoreArn": "string", "database": "string", "dbClusterOrInstanceArn": "string", "schema": "string", "sqlStatements": "string"}

URI Request ParametersThe request does not use any URI parameters.

Request BodyThe request accepts the following data in JSON format.

awsSecretStoreArn (p. 13)

The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: Yesdatabase (p. 13)

The name of the database.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: NodbClusterOrInstanceArn (p. 13)

The ARN of the Aurora Serverless DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: Yes

API Version 2018-08-0113

Amazon RDS Data Service API ReferenceResponse Syntax

schema (p. 13)

The name of the database schema.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: NosqlStatements (p. 13)

One or more SQL statements to run on the DB cluster.

You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement ispermitted, including data definition, data manipulation, and commit statements.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 65536.

Required: Yes

Response SyntaxHTTP/1.1 200Content-type: application/json

{ "sqlStatementResults": [ { "numberOfRecordsUpdated": number, "resultFrame": { "records": [ { "values": [ { "arrayValues": [ "Value" ], "bigIntValue": number, "bitValue": boolean, "blobValue": blob, "doubleValue": number, "intValue": number, "isNull": boolean, "realValue": number, "stringValue": "string", "structValue": { "attributes": [ "Value" ] } } ] } ], "resultSetMetadata": { "columnCount": number, "columnMetadata": [ { "arrayBaseColumnType": number, "isAutoIncrement": boolean,

API Version 2018-08-0114

Amazon RDS Data Service API ReferenceResponse Elements

"isCaseSensitive": boolean, "isCurrency": boolean, "isSigned": boolean, "label": "string", "name": "string", "nullable": number, "precision": number, "scale": number, "schemaName": "string", "tableName": "string", "type": number, "typeName": "string" } ] } } } ]}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

sqlStatementResults (p. 14)

The results of the SQL statement or statements.

Type: Array of SqlStatementResult (p. 38) objects

ErrorsBadRequestException

There is an error in the call or in a SQL statement.

HTTP Status Code: 400ForbiddenException

There are insufficient privileges to make the call.

HTTP Status Code: 403InternalServerErrorException

An internal error occurred.

HTTP Status Code: 500ServiceUnavailableError

The service specified by the resourceArn parameter is not available.

HTTP Status Code: 503

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

API Version 2018-08-0115

Amazon RDS Data Service API ReferenceSee Also

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0116

Amazon RDS Data Service API ReferenceExecuteStatement

ExecuteStatementRuns a SQL statement against a database.

ImportantIf 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 isterminated.

Request SyntaxPOST /Execute HTTP/1.1Content-type: application/json

{ "continueAfterTimeout": boolean, "database": "string", "includeResultMetadata": boolean, "parameters": [ { "name": "string", "typeHint": "string", "value": { "arrayValue": { "arrayValues": [ "ArrayValue" ], "blobValues": [ blob ], "booleanValues": [ boolean ], "doubleValues": [ number ], "longValues": [ number ], "stringValues": [ "string" ] }, "blobValue": blob, "booleanValue": boolean, "doubleValue": number, "isNull": boolean, "longValue": number, "stringValue": "string", "structValue": { "string" : "Field" } } } ], "resourceArn": "string", "resultSetOptions": { "decimalReturnType": "string" }, "schema": "string", "secretArn": "string", "sql": "string", "transactionId": "string"}

URI Request ParametersThe request does not use any URI parameters.

API Version 2018-08-0117

Amazon RDS Data Service API ReferenceRequest Body

Request BodyThe request accepts the following data in JSON format.

continueAfterTimeout (p. 17)

A value that indicates whether to continue running the statement after the call times out. Bydefault, the statement stops running when the call times out.

ImportantFor DDL statements, we recommend continuing to run the statement after the call timesout. When a DDL statement terminates before it is finished running, it can result in errorsand possibly corrupted data structures.

Type: Boolean

Required: Nodatabase (p. 17)

The name of the database.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: NoincludeResultMetadata (p. 17)

A value that indicates whether to include metadata in the results.

Type: Boolean

Required: Noparameters (p. 17)

The parameters for the SQL statement.

NoteArray parameters are not supported.

Type: Array of SqlParameter (p. 37) objects

Required: NoresourceArn (p. 17)

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: YesresultSetOptions (p. 17)

Options that control how the result set is returned.

Type: ResultSetOptions (p. 36) object

Required: No

API Version 2018-08-0118

Amazon RDS Data Service API ReferenceResponse Syntax

schema (p. 17)

The name of the database schema.

NoteCurrently, the schema parameter isn't supported.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: NosecretArn (p. 17)

The name or ARN of the secret that enables access to the DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: Yessql (p. 17)

The SQL statement to run.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 65536.

Required: YestransactionId (p. 17)

The identifier of a transaction that was started by using the BeginTransaction operation. Specifythe transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don't set this parameter.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 192.

Required: No

Response SyntaxHTTP/1.1 200Content-type: application/json

{ "columnMetadata": [ { "arrayBaseColumnType": number, "isAutoIncrement": boolean, "isCaseSensitive": boolean, "isCurrency": boolean, "isSigned": boolean, "label": "string", "name": "string", "nullable": number,

API Version 2018-08-0119

Amazon RDS Data Service API ReferenceResponse Elements

"precision": number, "scale": number, "schemaName": "string", "tableName": "string", "type": number, "typeName": "string" } ], "generatedFields": [ { "arrayValue": { "arrayValues": [ "ArrayValue" ], "blobValues": [ blob ], "booleanValues": [ boolean ], "doubleValues": [ number ], "longValues": [ number ], "stringValues": [ "string" ] }, "blobValue": blob, "booleanValue": boolean, "doubleValue": number, "isNull": boolean, "longValue": number, "stringValue": "string", "structValue": { "string" : "Field" } } ], "numberOfRecordsUpdated": number, "records": [ [ { "arrayValue": { "arrayValues": [ "ArrayValue" ], "blobValues": [ blob ], "booleanValues": [ boolean ], "doubleValues": [ number ], "longValues": [ number ], "stringValues": [ "string" ] }, "blobValue": blob, "booleanValue": boolean, "doubleValue": number, "isNull": boolean, "longValue": number, "stringValue": "string", "structValue": { "string" : "Field" } } ] ]}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

API Version 2018-08-0120

Amazon RDS Data Service API ReferenceErrors

columnMetadata (p. 19)

Metadata for the columns included in the results.

Type: Array of ColumnMetadata (p. 29) objectsgeneratedFields (p. 19)

Values for fields generated during the request.

NoteThe generatedFields data isn't supported by Aurora PostgreSQL. To get the values ofgenerated fields, use the RETURNING clause. For more information, see Returning DataFrom Modified Rows in the PostgreSQL documentation.

Type: Array of Field (p. 31) objectsnumberOfRecordsUpdated (p. 19)

The number of records updated by the request.

Type: Longrecords (p. 19)

The records returned by the SQL statement.

Type: Array of arrays of Field (p. 31) objects

ErrorsBadRequestException

There is an error in the call or in a SQL statement.

HTTP Status Code: 400ForbiddenException

There are insufficient privileges to make the call.

HTTP Status Code: 403InternalServerErrorException

An internal error occurred.

HTTP Status Code: 500ServiceUnavailableError

The service specified by the resourceArn parameter is not available.

HTTP Status Code: 503StatementTimeoutException

The execution of the SQL statement timed out.

HTTP Status Code: 400

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

API Version 2018-08-0121

Amazon RDS Data Service API ReferenceSee Also

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0122

Amazon RDS Data Service API ReferenceRollbackTransaction

RollbackTransactionPerforms a rollback of a transaction. Rolling back a transaction cancels its changes.

Request SyntaxPOST /RollbackTransaction HTTP/1.1Content-type: application/json

{ "resourceArn": "string", "secretArn": "string", "transactionId": "string"}

URI Request ParametersThe request does not use any URI parameters.

Request BodyThe request accepts the following data in JSON format.

resourceArn (p. 23)

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: YessecretArn (p. 23)

The name or ARN of the secret that enables access to the DB cluster.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 100.

Required: YestransactionId (p. 23)

The identifier of the transaction to roll back.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 192.

Required: Yes

Response SyntaxHTTP/1.1 200

API Version 2018-08-0123

Amazon RDS Data Service API ReferenceResponse Elements

Content-type: application/json

{ "transactionStatus": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

transactionStatus (p. 23)

The status of the rollback operation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

ErrorsBadRequestException

There is an error in the call or in a SQL statement.

HTTP Status Code: 400ForbiddenException

There are insufficient privileges to make the call.

HTTP Status Code: 403InternalServerErrorException

An internal error occurred.

HTTP Status Code: 500NotFoundException

The resourceArn, secretArn, or transactionId value can't be found.

HTTP Status Code: 404ServiceUnavailableError

The service specified by the resourceArn parameter is not available.

HTTP Status Code: 503StatementTimeoutException

The execution of the SQL statement timed out.

HTTP Status Code: 400

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

API Version 2018-08-0124

Amazon RDS Data Service API ReferenceSee Also

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0125

Amazon RDS Data Service API Reference

Data TypesThe Amazon RDS Data Service API contains several data types that various actions use. This sectiondescribes each data type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• ArrayValue (p. 27)• ColumnMetadata (p. 29)• Field (p. 31)• Record (p. 33)• ResultFrame (p. 34)• ResultSetMetadata (p. 35)• ResultSetOptions (p. 36)• SqlParameter (p. 37)• SqlStatementResult (p. 38)• StructValue (p. 39)• UpdateResult (p. 40)• Value (p. 41)

API Version 2018-08-0126

Amazon RDS Data Service API ReferenceArrayValue

ArrayValueContains an array.

ContentsarrayValues

An array of arrays.

Type: Array of ArrayValue (p. 27) objects

Required: NoblobValues

An array of BLOBs.

Type: Array of Base64-encoded binary data objects

Required: NobooleanValues

An array of Boolean values.

Type: Array of booleans

Required: NodoubleValues

An array of integers.

Type: Array of doubles

Required: NolongValues

An array of floating point numbers.

Type: Array of longs

Required: NostringValues

An array of strings.

Type: Array of strings

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java

API Version 2018-08-0127

Amazon RDS Data Service API ReferenceSee Also

• AWS SDK for Ruby V3

API Version 2018-08-0128

Amazon RDS Data Service API ReferenceColumnMetadata

ColumnMetadataContains the metadata for a column.

ContentsarrayBaseColumnType

The type of the column.

Type: Integer

Required: NoisAutoIncrement

A value that indicates whether the column increments automatically.

Type: Boolean

Required: NoisCaseSensitive

A value that indicates whether the column is case-sensitive.

Type: Boolean

Required: NoisCurrency

A value that indicates whether the column contains currency values.

Type: Boolean

Required: NoisSigned

A value that indicates whether an integer column is signed.

Type: Boolean

Required: Nolabel

The label for the column.

Type: String

Required: Noname

The name of the column.

Type: String

Required: Nonullable

A value that indicates whether the column is nullable.

API Version 2018-08-0129

Amazon RDS Data Service API ReferenceSee Also

Type: Integer

Required: Noprecision

The precision value of a decimal number column.

Type: Integer

Required: Noscale

The scale value of a decimal number column.

Type: Integer

Required: NoschemaName

The name of the schema that owns the table that includes the column.

Type: String

Required: NotableName

The name of the table that includes the column.

Type: String

Required: Notype

The type of the column.

Type: Integer

Required: NotypeName

The database-specific data type of the column.

Type: String

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0130

Amazon RDS Data Service API ReferenceField

FieldContains a value.

ContentsarrayValue

An array of values.

Type: ArrayValue (p. 27) object

Required: NoblobValue

A value of BLOB data type.

Type: Base64-encoded binary data object

Required: NobooleanValue

A value of Boolean data type.

Type: Boolean

Required: NodoubleValue

A value of double data type.

Type: Double

Required: NoisNull

A NULL value.

Type: Boolean

Required: NolongValue

A value of long data type.

Type: Long

Required: NostringValue

A value of string data type.

Type: String

Required: NostructValue

A value of STRUCT data type.

API Version 2018-08-0131

Amazon RDS Data Service API ReferenceSee Also

NoteCurrently, structValue isn't supported.

Type: String to Field (p. 31) object map

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0132

Amazon RDS Data Service API ReferenceRecord

RecordA record returned by a call.

Contentsvalues

The values returned in the record.

Type: Array of Value (p. 41) objects

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0133

Amazon RDS Data Service API ReferenceResultFrame

ResultFrameThe result set returned by a SQL statement.

Contentsrecords

The records in the result set.

Type: Array of Record (p. 33) objects

Required: NoresultSetMetadata

The result-set metadata in the result set.

Type: ResultSetMetadata (p. 35) object

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0134

Amazon RDS Data Service API ReferenceResultSetMetadata

ResultSetMetadataThe metadata of the result set returned by a SQL statement.

ContentscolumnCount

The number of columns in the result set.

Type: Long

Required: NocolumnMetadata

The metadata of the columns in the result set.

Type: Array of ColumnMetadata (p. 29) objects

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0135

Amazon RDS Data Service API ReferenceResultSetOptions

ResultSetOptionsOptions that control how the result set is returned.

ContentsdecimalReturnType

A value that indicates how a field of DECIMAL type is represented in the response. The value ofSTRING, the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONGspecifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise.

ImportantConversion to Double or Long can result in roundoff errors due to precision loss. Werecommend converting to String, especially when working with currency values.

Type: String

Valid Values: DOUBLE_OR_LONG | STRING

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0136

Amazon RDS Data Service API ReferenceSqlParameter

SqlParameterA parameter used in a SQL statement.

Contentsname

The name of the parameter.

Type: String

Required: NotypeHint

A hint that specifies the correct object type for data type mapping.

Values:• DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to

the database.• TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type

to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].• TIME - The corresponding String parameter value is sent as an object of TIME type to the

database. The accepted format is HH:MM:SS[.FFF].• DATE - The corresponding String parameter value is sent as an object of DATE type to the

database. The accepted format is YYYY-MM-DD.

Type: String

Valid Values: DATE | DECIMAL | TIME | TIMESTAMP

Required: Novalue

The value of the parameter.

Type: Field (p. 31) object

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0137

Amazon RDS Data Service API ReferenceSqlStatementResult

SqlStatementResultThe result of a SQL statement.

ImportantThis data type is deprecated.

ContentsnumberOfRecordsUpdated

The number of records updated by a SQL statement.

Type: Long

Required: NoresultFrame

The result set of the SQL statement.

Type: ResultFrame (p. 34) object

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0138

Amazon RDS Data Service API ReferenceStructValue

StructValueA structure value returned by a call.

Contentsattributes

The attributes returned in the record.

Type: Array of Value (p. 41) objects

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0139

Amazon RDS Data Service API ReferenceUpdateResult

UpdateResultThe response elements represent the results of an update.

ContentsgeneratedFields

Values for fields generated during the request.

Type: Array of Field (p. 31) objects

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0140

Amazon RDS Data Service API ReferenceValue

ValueContains the value of a column.

ImportantThis data type is deprecated.

ContentsarrayValues

An array of column values.

Type: Array of Value (p. 41) objects

Required: NobigIntValue

A value for a column of big integer data type.

Type: Long

Required: NobitValue

A value for a column of BIT data type.

Type: Boolean

Required: NoblobValue

A value for a column of BLOB data type.

Type: Base64-encoded binary data object

Required: NodoubleValue

A value for a column of double data type.

Type: Double

Required: NointValue

A value for a column of integer data type.

Type: Integer

Required: NoisNull

A NULL value.

Type: Boolean

Required: No

API Version 2018-08-0141

Amazon RDS Data Service API ReferenceSee Also

realValue

A value for a column of real data type.

Type: Float

Required: NostringValue

A value for a column of string data type.

Type: String

Required: NostructValue

A value for a column of STRUCT data type.

Type: StructValue (p. 39) object

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0142