github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/rds-data/2018-08-01/api-2.json (about)

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2018-08-01",
     5      "endpointPrefix":"rds-data",
     6      "jsonVersion":"1.1",
     7      "protocol":"rest-json",
     8      "serviceFullName":"AWS RDS DataService",
     9      "serviceId":"RDS Data",
    10      "signatureVersion":"v4",
    11      "signingName":"rds-data",
    12      "uid":"rds-data-2018-08-01"
    13    },
    14    "operations":{
    15      "BatchExecuteStatement":{
    16        "name":"BatchExecuteStatement",
    17        "http":{
    18          "method":"POST",
    19          "requestUri":"/BatchExecute",
    20          "responseCode":200
    21        },
    22        "input":{"shape":"BatchExecuteStatementRequest"},
    23        "output":{"shape":"BatchExecuteStatementResponse"},
    24        "errors":[
    25          {"shape":"BadRequestException"},
    26          {"shape":"StatementTimeoutException"},
    27          {"shape":"InternalServerErrorException"},
    28          {"shape":"ForbiddenException"},
    29          {"shape":"ServiceUnavailableError"}
    30        ]
    31      },
    32      "BeginTransaction":{
    33        "name":"BeginTransaction",
    34        "http":{
    35          "method":"POST",
    36          "requestUri":"/BeginTransaction",
    37          "responseCode":200
    38        },
    39        "input":{"shape":"BeginTransactionRequest"},
    40        "output":{"shape":"BeginTransactionResponse"},
    41        "errors":[
    42          {"shape":"BadRequestException"},
    43          {"shape":"StatementTimeoutException"},
    44          {"shape":"InternalServerErrorException"},
    45          {"shape":"ForbiddenException"},
    46          {"shape":"ServiceUnavailableError"}
    47        ]
    48      },
    49      "CommitTransaction":{
    50        "name":"CommitTransaction",
    51        "http":{
    52          "method":"POST",
    53          "requestUri":"/CommitTransaction",
    54          "responseCode":200
    55        },
    56        "input":{"shape":"CommitTransactionRequest"},
    57        "output":{"shape":"CommitTransactionResponse"},
    58        "errors":[
    59          {"shape":"BadRequestException"},
    60          {"shape":"StatementTimeoutException"},
    61          {"shape":"InternalServerErrorException"},
    62          {"shape":"ForbiddenException"},
    63          {"shape":"ServiceUnavailableError"},
    64          {"shape":"NotFoundException"}
    65        ]
    66      },
    67      "ExecuteSql":{
    68        "name":"ExecuteSql",
    69        "http":{
    70          "method":"POST",
    71          "requestUri":"/ExecuteSql",
    72          "responseCode":200
    73        },
    74        "input":{"shape":"ExecuteSqlRequest"},
    75        "output":{"shape":"ExecuteSqlResponse"},
    76        "errors":[
    77          {"shape":"BadRequestException"},
    78          {"shape":"InternalServerErrorException"},
    79          {"shape":"ForbiddenException"},
    80          {"shape":"ServiceUnavailableError"}
    81        ],
    82        "deprecated":true,
    83        "deprecatedMessage":"The ExecuteSql API is deprecated, please use the ExecuteStatement API."
    84      },
    85      "ExecuteStatement":{
    86        "name":"ExecuteStatement",
    87        "http":{
    88          "method":"POST",
    89          "requestUri":"/Execute",
    90          "responseCode":200
    91        },
    92        "input":{"shape":"ExecuteStatementRequest"},
    93        "output":{"shape":"ExecuteStatementResponse"},
    94        "errors":[
    95          {"shape":"BadRequestException"},
    96          {"shape":"StatementTimeoutException"},
    97          {"shape":"InternalServerErrorException"},
    98          {"shape":"ForbiddenException"},
    99          {"shape":"ServiceUnavailableError"}
   100        ]
   101      },
   102      "RollbackTransaction":{
   103        "name":"RollbackTransaction",
   104        "http":{
   105          "method":"POST",
   106          "requestUri":"/RollbackTransaction",
   107          "responseCode":200
   108        },
   109        "input":{"shape":"RollbackTransactionRequest"},
   110        "output":{"shape":"RollbackTransactionResponse"},
   111        "errors":[
   112          {"shape":"BadRequestException"},
   113          {"shape":"StatementTimeoutException"},
   114          {"shape":"InternalServerErrorException"},
   115          {"shape":"ForbiddenException"},
   116          {"shape":"ServiceUnavailableError"},
   117          {"shape":"NotFoundException"}
   118        ]
   119      }
   120    },
   121    "shapes":{
   122      "Arn":{
   123        "type":"string",
   124        "max":100,
   125        "min":11
   126      },
   127      "ArrayOfArray":{
   128        "type":"list",
   129        "member":{"shape":"ArrayValue"}
   130      },
   131      "ArrayValue":{
   132        "type":"structure",
   133        "members":{
   134          "arrayValues":{"shape":"ArrayOfArray"},
   135          "booleanValues":{"shape":"BooleanArray"},
   136          "doubleValues":{"shape":"DoubleArray"},
   137          "longValues":{"shape":"LongArray"},
   138          "stringValues":{"shape":"StringArray"}
   139        },
   140        "union":true
   141      },
   142      "ArrayValueList":{
   143        "type":"list",
   144        "member":{"shape":"Value"}
   145      },
   146      "BadRequestException":{
   147        "type":"structure",
   148        "members":{
   149          "message":{"shape":"ErrorMessage"}
   150        },
   151        "error":{
   152          "httpStatusCode":400,
   153          "senderFault":true
   154        },
   155        "exception":true
   156      },
   157      "BatchExecuteStatementRequest":{
   158        "type":"structure",
   159        "required":[
   160          "resourceArn",
   161          "secretArn",
   162          "sql"
   163        ],
   164        "members":{
   165          "database":{"shape":"DbName"},
   166          "parameterSets":{"shape":"SqlParameterSets"},
   167          "resourceArn":{"shape":"Arn"},
   168          "schema":{"shape":"DbName"},
   169          "secretArn":{"shape":"Arn"},
   170          "sql":{"shape":"SqlStatement"},
   171          "transactionId":{"shape":"Id"}
   172        }
   173      },
   174      "BatchExecuteStatementResponse":{
   175        "type":"structure",
   176        "members":{
   177          "updateResults":{"shape":"UpdateResults"}
   178        }
   179      },
   180      "BeginTransactionRequest":{
   181        "type":"structure",
   182        "required":[
   183          "resourceArn",
   184          "secretArn"
   185        ],
   186        "members":{
   187          "database":{"shape":"DbName"},
   188          "resourceArn":{"shape":"Arn"},
   189          "schema":{"shape":"DbName"},
   190          "secretArn":{"shape":"Arn"}
   191        }
   192      },
   193      "BeginTransactionResponse":{
   194        "type":"structure",
   195        "members":{
   196          "transactionId":{"shape":"Id"}
   197        }
   198      },
   199      "Blob":{"type":"blob"},
   200      "Boolean":{"type":"boolean"},
   201      "BooleanArray":{
   202        "type":"list",
   203        "member":{"shape":"BoxedBoolean"}
   204      },
   205      "BoxedBoolean":{
   206        "type":"boolean",
   207        "box":true
   208      },
   209      "BoxedDouble":{
   210        "type":"double",
   211        "box":true
   212      },
   213      "BoxedFloat":{
   214        "type":"float",
   215        "box":true
   216      },
   217      "BoxedInteger":{
   218        "type":"integer",
   219        "box":true
   220      },
   221      "BoxedLong":{
   222        "type":"long",
   223        "box":true
   224      },
   225      "ColumnMetadata":{
   226        "type":"structure",
   227        "members":{
   228          "arrayBaseColumnType":{"shape":"Integer"},
   229          "isAutoIncrement":{"shape":"Boolean"},
   230          "isCaseSensitive":{"shape":"Boolean"},
   231          "isCurrency":{"shape":"Boolean"},
   232          "isSigned":{"shape":"Boolean"},
   233          "label":{"shape":"String"},
   234          "name":{"shape":"String"},
   235          "nullable":{"shape":"Integer"},
   236          "precision":{"shape":"Integer"},
   237          "scale":{"shape":"Integer"},
   238          "schemaName":{"shape":"String"},
   239          "tableName":{"shape":"String"},
   240          "type":{"shape":"Integer"},
   241          "typeName":{"shape":"String"}
   242        }
   243      },
   244      "CommitTransactionRequest":{
   245        "type":"structure",
   246        "required":[
   247          "resourceArn",
   248          "secretArn",
   249          "transactionId"
   250        ],
   251        "members":{
   252          "resourceArn":{"shape":"Arn"},
   253          "secretArn":{"shape":"Arn"},
   254          "transactionId":{"shape":"Id"}
   255        }
   256      },
   257      "CommitTransactionResponse":{
   258        "type":"structure",
   259        "members":{
   260          "transactionStatus":{"shape":"TransactionStatus"}
   261        }
   262      },
   263      "DbName":{
   264        "type":"string",
   265        "max":64,
   266        "min":0
   267      },
   268      "DecimalReturnType":{
   269        "type":"string",
   270        "enum":[
   271          "STRING",
   272          "DOUBLE_OR_LONG"
   273        ]
   274      },
   275      "DoubleArray":{
   276        "type":"list",
   277        "member":{"shape":"BoxedDouble"}
   278      },
   279      "ErrorMessage":{"type":"string"},
   280      "ExecuteSqlRequest":{
   281        "type":"structure",
   282        "required":[
   283          "awsSecretStoreArn",
   284          "dbClusterOrInstanceArn",
   285          "sqlStatements"
   286        ],
   287        "members":{
   288          "awsSecretStoreArn":{"shape":"Arn"},
   289          "database":{"shape":"DbName"},
   290          "dbClusterOrInstanceArn":{"shape":"Arn"},
   291          "schema":{"shape":"DbName"},
   292          "sqlStatements":{"shape":"SqlStatement"}
   293        }
   294      },
   295      "ExecuteSqlResponse":{
   296        "type":"structure",
   297        "members":{
   298          "sqlStatementResults":{"shape":"SqlStatementResults"}
   299        }
   300      },
   301      "ExecuteStatementRequest":{
   302        "type":"structure",
   303        "required":[
   304          "resourceArn",
   305          "secretArn",
   306          "sql"
   307        ],
   308        "members":{
   309          "continueAfterTimeout":{"shape":"Boolean"},
   310          "database":{"shape":"DbName"},
   311          "includeResultMetadata":{"shape":"Boolean"},
   312          "parameters":{"shape":"SqlParametersList"},
   313          "resourceArn":{"shape":"Arn"},
   314          "resultSetOptions":{"shape":"ResultSetOptions"},
   315          "schema":{"shape":"DbName"},
   316          "secretArn":{"shape":"Arn"},
   317          "sql":{"shape":"SqlStatement"},
   318          "transactionId":{"shape":"Id"}
   319        }
   320      },
   321      "ExecuteStatementResponse":{
   322        "type":"structure",
   323        "members":{
   324          "columnMetadata":{"shape":"Metadata"},
   325          "generatedFields":{"shape":"FieldList"},
   326          "numberOfRecordsUpdated":{"shape":"RecordsUpdated"},
   327          "records":{"shape":"SqlRecords"}
   328        }
   329      },
   330      "Field":{
   331        "type":"structure",
   332        "members":{
   333          "arrayValue":{"shape":"ArrayValue"},
   334          "blobValue":{"shape":"Blob"},
   335          "booleanValue":{"shape":"BoxedBoolean"},
   336          "doubleValue":{"shape":"BoxedDouble"},
   337          "isNull":{"shape":"BoxedBoolean"},
   338          "longValue":{"shape":"BoxedLong"},
   339          "stringValue":{"shape":"String"}
   340        },
   341        "union":true
   342      },
   343      "FieldList":{
   344        "type":"list",
   345        "member":{"shape":"Field"}
   346      },
   347      "ForbiddenException":{
   348        "type":"structure",
   349        "members":{
   350          "message":{"shape":"ErrorMessage"}
   351        },
   352        "error":{
   353          "httpStatusCode":403,
   354          "senderFault":true
   355        },
   356        "exception":true
   357      },
   358      "Id":{
   359        "type":"string",
   360        "max":192,
   361        "min":0
   362      },
   363      "Integer":{"type":"integer"},
   364      "InternalServerErrorException":{
   365        "type":"structure",
   366        "members":{
   367        },
   368        "error":{"httpStatusCode":500},
   369        "exception":true,
   370        "fault":true
   371      },
   372      "Long":{"type":"long"},
   373      "LongArray":{
   374        "type":"list",
   375        "member":{"shape":"BoxedLong"}
   376      },
   377      "Metadata":{
   378        "type":"list",
   379        "member":{"shape":"ColumnMetadata"}
   380      },
   381      "NotFoundException":{
   382        "type":"structure",
   383        "members":{
   384          "message":{"shape":"ErrorMessage"}
   385        },
   386        "error":{
   387          "httpStatusCode":404,
   388          "senderFault":true
   389        },
   390        "exception":true
   391      },
   392      "ParameterName":{"type":"string"},
   393      "Record":{
   394        "type":"structure",
   395        "members":{
   396          "values":{"shape":"Row"}
   397        }
   398      },
   399      "Records":{
   400        "type":"list",
   401        "member":{"shape":"Record"}
   402      },
   403      "RecordsUpdated":{"type":"long"},
   404      "ResultFrame":{
   405        "type":"structure",
   406        "members":{
   407          "records":{"shape":"Records"},
   408          "resultSetMetadata":{"shape":"ResultSetMetadata"}
   409        }
   410      },
   411      "ResultSetMetadata":{
   412        "type":"structure",
   413        "members":{
   414          "columnCount":{"shape":"Long"},
   415          "columnMetadata":{"shape":"Metadata"}
   416        }
   417      },
   418      "ResultSetOptions":{
   419        "type":"structure",
   420        "members":{
   421          "decimalReturnType":{"shape":"DecimalReturnType"}
   422        }
   423      },
   424      "RollbackTransactionRequest":{
   425        "type":"structure",
   426        "required":[
   427          "resourceArn",
   428          "secretArn",
   429          "transactionId"
   430        ],
   431        "members":{
   432          "resourceArn":{"shape":"Arn"},
   433          "secretArn":{"shape":"Arn"},
   434          "transactionId":{"shape":"Id"}
   435        }
   436      },
   437      "RollbackTransactionResponse":{
   438        "type":"structure",
   439        "members":{
   440          "transactionStatus":{"shape":"TransactionStatus"}
   441        }
   442      },
   443      "Row":{
   444        "type":"list",
   445        "member":{"shape":"Value"}
   446      },
   447      "ServiceUnavailableError":{
   448        "type":"structure",
   449        "members":{
   450        },
   451        "error":{"httpStatusCode":503},
   452        "exception":true,
   453        "fault":true
   454      },
   455      "SqlParameter":{
   456        "type":"structure",
   457        "members":{
   458          "name":{"shape":"ParameterName"},
   459          "typeHint":{"shape":"TypeHint"},
   460          "value":{"shape":"Field"}
   461        }
   462      },
   463      "SqlParameterSets":{
   464        "type":"list",
   465        "member":{"shape":"SqlParametersList"}
   466      },
   467      "SqlParametersList":{
   468        "type":"list",
   469        "member":{"shape":"SqlParameter"}
   470      },
   471      "SqlRecords":{
   472        "type":"list",
   473        "member":{"shape":"FieldList"}
   474      },
   475      "SqlStatement":{
   476        "type":"string",
   477        "max":65536,
   478        "min":0
   479      },
   480      "SqlStatementResult":{
   481        "type":"structure",
   482        "members":{
   483          "numberOfRecordsUpdated":{"shape":"RecordsUpdated"},
   484          "resultFrame":{"shape":"ResultFrame"}
   485        }
   486      },
   487      "SqlStatementResults":{
   488        "type":"list",
   489        "member":{"shape":"SqlStatementResult"}
   490      },
   491      "StatementTimeoutException":{
   492        "type":"structure",
   493        "members":{
   494          "dbConnectionId":{"shape":"Long"},
   495          "message":{"shape":"ErrorMessage"}
   496        },
   497        "error":{
   498          "httpStatusCode":400,
   499          "senderFault":true
   500        },
   501        "exception":true
   502      },
   503      "String":{"type":"string"},
   504      "StringArray":{
   505        "type":"list",
   506        "member":{"shape":"String"}
   507      },
   508      "StructValue":{
   509        "type":"structure",
   510        "members":{
   511          "attributes":{"shape":"ArrayValueList"}
   512        }
   513      },
   514      "TransactionStatus":{
   515        "type":"string",
   516        "max":128,
   517        "min":0
   518      },
   519      "TypeHint":{
   520        "type":"string",
   521        "enum":[
   522          "JSON",
   523          "UUID",
   524          "TIMESTAMP",
   525          "DATE",
   526          "TIME",
   527          "DECIMAL"
   528        ]
   529      },
   530      "UpdateResult":{
   531        "type":"structure",
   532        "members":{
   533          "generatedFields":{"shape":"FieldList"}
   534        }
   535      },
   536      "UpdateResults":{
   537        "type":"list",
   538        "member":{"shape":"UpdateResult"}
   539      },
   540      "Value":{
   541        "type":"structure",
   542        "members":{
   543          "arrayValues":{"shape":"ArrayValueList"},
   544          "bigIntValue":{"shape":"BoxedLong"},
   545          "bitValue":{"shape":"BoxedBoolean"},
   546          "blobValue":{"shape":"Blob"},
   547          "doubleValue":{"shape":"BoxedDouble"},
   548          "intValue":{"shape":"BoxedInteger"},
   549          "isNull":{"shape":"BoxedBoolean"},
   550          "realValue":{"shape":"BoxedFloat"},
   551          "stringValue":{"shape":"String"},
   552          "structValue":{"shape":"StructValue"}
   553        },
   554        "union":true
   555      }
   556    }
   557  }