openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 50.8 kB

JSON

{"openapi":"3.0.0","info":{"version":"2018-08-01","x-release":"v4","title":"AWS RDS DataService","description":"<fullname>Amazon RDS Data Service</fullname> 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. <note> The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters. </note> For more information about the Data Service API, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API</a> in the Amazon Aurora User Guide.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"rds-data","x-aws-signingName":"rds-data","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/rds-data-2018-08-01.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/rds-data/"},"servers":[{"url":"http://rds-data.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS RDS DataService multi-region endpoint"},{"url":"https://rds-data.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS RDS DataService multi-region endpoint"},{"url":"http://rds-data.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS RDS DataService endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://rds-data.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS RDS DataService endpoint for China (Beijing) and China (Ningxia)"}],"paths":{"/BatchExecute":{"post":{"operationId":"BatchExecuteStatement","description":"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. <note> If a call isn't part of a transaction because it doesn't include the <code>transactionID</code> 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. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchExecuteStatementResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"StatementTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementTimeoutException"}}}},"483":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"485":{"description":"ServiceUnavailableError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resourceArn","secretArn","sql"],"properties":{"resourceArn":{"description":"The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.","type":"string","minLength":11,"maxLength":100},"secretArn":{"description":"The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html\">Create a database secret</a>.","type":"string","minLength":11,"maxLength":100},"sql":{"description":"The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.","type":"string","minLength":0,"maxLength":65536},"database":{"description":"The name of the database.","type":"string","minLength":0,"maxLength":64},"schema":{"description":"The name of the database schema. <note> Currently, the <code>schema</code> parameter isn't supported. </note>","type":"string","minLength":0,"maxLength":64},"parameterSets":{"description":"The parameter set for the batch operation. The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options: <ul> <li> Specify one or more empty parameter sets. </li> <li> Use the <code>ExecuteStatement</code> operation instead of the <code>BatchExecuteStatement</code> operation. </li> </ul> <note> Array parameters are not supported. </note>","type":"array","items":{"$ref":"#/components/schemas/SqlParametersList"}},"transactionId":{"description":"The identifier of a transaction that was started by using the <code>BeginTransaction</code> operation. Specify the 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","minLength":0,"maxLength":192}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/BeginTransaction":{"post":{"operationId":"BeginTransaction","description":"Starts a SQL transaction. <note> 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 <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeginTransactionResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"StatementTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementTimeoutException"}}}},"483":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"485":{"description":"ServiceUnavailableError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resourceArn","secretArn"],"properties":{"resourceArn":{"description":"The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.","type":"string","minLength":11,"maxLength":100},"secretArn":{"description":"The name or ARN of the secret that enables access to the DB cluster.","type":"string","minLength":11,"maxLength":100},"database":{"description":"The name of the database.","type":"string","minLength":0,"maxLength":64},"schema":{"description":"The name of the database schema.","type":"string","minLength":0,"maxLength":64}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/CommitTransaction":{"post":{"operationId":"CommitTransaction","description":"Ends a SQL transaction started with the <code>BeginTransaction</code> operation and commits the changes.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommitTransactionResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"StatementTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementTimeoutException"}}}},"483":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"485":{"description":"ServiceUnavailableError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}}},"486":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resourceArn","secretArn","transactionId"],"properties":{"resourceArn":{"description":"The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.","type":"string","minLength":11,"maxLength":100},"secretArn":{"description":"The name or ARN of the secret that enables access to the DB cluster.","type":"string","minLength":11,"maxLength":100},"transactionId":{"description":"The identifier of the transaction to end and commit.","type":"string","minLength":0,"maxLength":192}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/ExecuteSql":{"post":{"deprecated":true,"operationId":"ExecuteSql","description":"Runs one or more SQL statements. <note> This operation is deprecated. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteSqlResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"ServiceUnavailableError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dbClusterOrInstanceArn","awsSecretStoreArn","sqlStatements"],"properties":{"dbClusterOrInstanceArn":{"description":"The ARN of the Aurora Serverless DB cluster.","type":"string","minLength":11,"maxLength":100},"awsSecretStoreArn":{"description":"The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html\">Create a database secret</a>.","type":"string","minLength":11,"maxLength":100},"sqlStatements":{"description":"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 is permitted, including data definition, data manipulation, and commit statements. ","type":"string","minLength":0,"maxLength":65536},"database":{"description":"The name of the database.","type":"string","minLength":0,"maxLength":64},"schema":{"description":"The name of the database schema.","type":"string","minLength":0,"maxLength":64}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/Execute":{"post":{"operationId":"ExecuteStatement","description":"Runs a SQL statement against a database. <note> If a call isn't part of a transaction because it doesn't include the <code>transactionID</code> 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. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteStatementResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"StatementTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementTimeoutException"}}}},"483":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"485":{"description":"ServiceUnavailableError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resourceArn","secretArn","sql"],"properties":{"resourceArn":{"description":"The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.","type":"string","minLength":11,"maxLength":100},"secretArn":{"description":"The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html\">Create a database secret</a>.","type":"string","minLength":11,"maxLength":100},"sql":{"description":"The SQL statement to run.","type":"string","minLength":0,"maxLength":65536},"database":{"description":"The name of the database.","type":"string","minLength":0,"maxLength":64},"schema":{"description":"The name of the database schema. <note> Currently, the <code>schema</code> parameter isn't supported. </note>","type":"string","minLength":0,"maxLength":64},"parameters":{"description":"The parameters for the SQL statement. <note> Array parameters are not supported. </note>","type":"array","items":{"$ref":"#/components/schemas/SqlParameter"}},"transactionId":{"description":"The identifier of a transaction that was started by using the <code>BeginTransaction</code> operation. Specify the 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","minLength":0,"maxLength":192},"includeResultMetadata":{"description":"A value that indicates whether to include metadata in the results.","type":"boolean"},"continueAfterTimeout":{"description":"A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out. <note> For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures. </note>","type":"boolean"},"resultSetOptions":{"description":"Options that control how the result set is returned.","type":"object","properties":{"decimalReturnType":{"allOf":[{"$ref":"#/components/schemas/DecimalReturnType"},{"description":"A value that indicates how a field of <code>DECIMAL</code> type is represented in the response. The value of <code>STRING</code>, the default, specifies that it is converted to a String value. The value of <code>DOUBLE_OR_LONG</code> specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise. <note> Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values. </note>"}]},"longReturnType":{"allOf":[{"$ref":"#/components/schemas/LongReturnType"},{"description":"A value that indicates how a field of <code>LONG</code> type is represented. Allowed values are <code>LONG</code> and <code>STRING</code>. The default is <code>LONG</code>. Specify <code>STRING</code> if the length or precision of numeric values might cause truncation or rounding errors. "}]}}},"formatRecordsAs":{"description":"A value that indicates whether to format the result set as a single JSON string. This parameter only applies to <code>SELECT</code> statements and is ignored for other types of statements. Allowed values are <code>NONE</code> and <code>JSON</code>. The default value is <code>NONE</code>. The result is returned in the <code>formattedRecords</code> field. For usage information about the JSON format for result sets, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API</a> in the Amazon Aurora User Guide.","type":"string","enum":["NONE","JSON"]}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/RollbackTransaction":{"post":{"operationId":"RollbackTransaction","description":"Performs a rollback of a transaction. Rolling back a transaction cancels its changes.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollbackTransactionResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"StatementTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementTimeoutException"}}}},"483":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"485":{"description":"ServiceUnavailableError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}}},"486":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resourceArn","secretArn","transactionId"],"properties":{"resourceArn":{"description":"The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.","type":"string","minLength":11,"maxLength":100},"secretArn":{"description":"The name or ARN of the secret that enables access to the DB cluster.","type":"string","minLength":11,"maxLength":100},"transactionId":{"description":"The identifier of the transaction to roll back.","type":"string","minLength":0,"maxLength":192}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"BatchExecuteStatementResponse":{"type":"object","properties":{"updateResults":{"allOf":[{"$ref":"#/components/schemas/UpdateResults"},{"description":"The execution results of each batch entry."}]}},"description":"The response elements represent the output of a SQL statement over an array of data."},"SqlParametersList":{"type":"array","items":{"$ref":"#/components/schemas/SqlParameter"}},"AccessDeniedException":{},"BadRequestException":{},"StatementTimeoutException":{},"InternalServerErrorException":{},"ForbiddenException":{},"ServiceUnavailableError":{},"BeginTransactionResponse":{"type":"object","properties":{"transactionId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"description":"The transaction ID of the transaction started by the call."}]}},"description":"The response elements represent the output of a request to start a SQL transaction."},"CommitTransactionResponse":{"type":"object","properties":{"transactionStatus":{"allOf":[{"$ref":"#/components/schemas/TransactionStatus"},{"description":"The status of the commit operation."}]}},"description":"The response elements represent the output of a commit transaction request."},"NotFoundException":{},"ExecuteSqlResponse":{"type":"object","properties":{"sqlStatementResults":{"allOf":[{"$ref":"#/components/schemas/SqlStatementResults"},{"description":"The results of the SQL statement or statements."}]}},"description":"The response elements represent the output of a request to run one or more SQL statements."},"ExecuteStatementResponse":{"type":"object","properties":{"records":{"allOf":[{"$ref":"#/components/schemas/SqlRecords"},{"description":"The records returned by the SQL statement. This field is blank if the <code>formatRecordsAs</code> parameter is set to <code>JSON</code>."}]},"columnMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"description":"Metadata for the columns included in the results. This field is blank if the <code>formatRecordsAs</code> parameter is set to <code>JSON</code>."}]},"numberOfRecordsUpdated":{"allOf":[{"$ref":"#/components/schemas/RecordsUpdated"},{"description":"The number of records updated by the request."}]},"generatedFields":{"allOf":[{"$ref":"#/components/schemas/FieldList"},{"description":"Values for fields generated during a DML request. <pre><code> <note> The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation. </note> </code></pre>"}]},"formattedRecords":{"allOf":[{"$ref":"#/components/schemas/FormattedSqlRecords"},{"description":"A string value that represents the result set of a <code>SELECT</code> statement in JSON format. This value is only present when the <code>formatRecordsAs</code> parameter is set to <code>JSON</code>. The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error."}]}},"description":"The response elements represent the output of a request to run a SQL statement against a database."},"SqlParameter":{"type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/ParameterName"},{"description":"The name of the parameter."}]},"value":{"allOf":[{"$ref":"#/components/schemas/Field"},{"description":"The value of the parameter."}]},"typeHint":{"allOf":[{"$ref":"#/components/schemas/TypeHint"},{"description":"A hint that specifies the correct object type for data type mapping. Possible values are as follows: <ul> <li> <code>DATE</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>DATE</code> type to the database. The accepted format is <code>YYYY-MM-DD</code>. </li> <li> <code>DECIMAL</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>DECIMAL</code> type to the database. </li> <li> <code>JSON</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>JSON</code> type to the database. </li> <li> <code>TIME</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>TIME</code> type to the database. The accepted format is <code>HH:MM:SS[.FFF]</code>. </li> <li> <code>TIMESTAMP</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>TIMESTAMP</code> type to the database. The accepted format is <code>YYYY-MM-DD HH:MM:SS[.FFF]</code>. </li> <li> <code>UUID</code> - The corresponding <code>String</code> parameter value is sent as an object of <code>UUID</code> type to the database. </li> </ul>"}]}},"description":"A parameter used in a SQL statement."},"DecimalReturnType":{"type":"string","enum":["STRING","DOUBLE_OR_LONG"]},"LongReturnType":{"type":"string","enum":["STRING","LONG"]},"RollbackTransactionResponse":{"type":"object","properties":{"transactionStatus":{"allOf":[{"$ref":"#/components/schemas/TransactionStatus"},{"description":"The status of the rollback operation."}]}},"description":"The response elements represent the output of a request to perform a rollback of a transaction."},"Arn":{"type":"string","minLength":11,"maxLength":100},"ArrayValue":{"type":"object","properties":{"booleanValues":{"allOf":[{"$ref":"#/components/schemas/BooleanArray"},{"description":"An array of Boolean values."}]},"longValues":{"allOf":[{"$ref":"#/components/schemas/LongArray"},{"description":"An array of integers."}]},"doubleValues":{"allOf":[{"$ref":"#/components/schemas/DoubleArray"},{"description":"An array of floating-point numbers."}]},"stringValues":{"allOf":[{"$ref":"#/components/schemas/StringArray"},{"description":"An array of strings."}]},"arrayValues":{"allOf":[{"$ref":"#/components/schemas/ArrayOfArray"},{"description":"An array of arrays."}]}},"description":"Contains an array."},"ArrayOfArray":{"type":"array","description":"An array of arrays. <note> Some array entries can be null. </note>","items":{"$ref":"#/components/schemas/ArrayValue"}},"BooleanArray":{"type":"array","description":"An array of Boolean values. <note> Some array entries can be null. </note>","items":{"$ref":"#/components/schemas/BoxedBoolean"}},"LongArray":{"type":"array","description":"An array of integers. <note> Some array entries can be null. </note>","items":{"$ref":"#/components/schemas/BoxedLong"}},"DoubleArray":{"type":"array","description":"An array of floating-point numbers. <note> Some array entries can be null. </note>","items":{"$ref":"#/components/schemas/BoxedDouble"}},"StringArray":{"type":"array","description":"An array of strings. <note> Some array entries can be null. </note>","items":{"$ref":"#/components/schemas/String"}},"Value":{"type":"object","properties":{"isNull":{"allOf":[{"$ref":"#/components/schemas/BoxedBoolean"},{"description":"A NULL value."}]},"bitValue":{"allOf":[{"$ref":"#/components/schemas/BoxedBoolean"},{"description":"A value for a column of BIT data type."}]},"bigIntValue":{"allOf":[{"$ref":"#/components/schemas/BoxedLong"},{"description":"A value for a column of big integer data type."}]},"intValue":{"allOf":[{"$ref":"#/components/schemas/BoxedInteger"},{"description":"A value for a column of integer data type."}]},"doubleValue":{"allOf":[{"$ref":"#/components/schemas/BoxedDouble"},{"description":"A value for a column of double data type."}]},"realValue":{"allOf":[{"$ref":"#/components/schemas/BoxedFloat"},{"description":"A value for a column of real data type."}]},"stringValue":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A value for a column of string data type."}]},"blobValue":{"allOf":[{"$ref":"#/components/schemas/Blob"},{"description":"A value for a column of BLOB data type."}]},"arrayValues":{"allOf":[{"$ref":"#/components/schemas/ArrayValueList"},{"description":"An array of column values."}]},"structValue":{"allOf":[{"$ref":"#/components/schemas/StructValue"},{"description":"A value for a column of STRUCT data type."}]}},"description":"Contains the value of a column. <pre><code> <note> This data structure is only used with the deprecated <code>ExecuteSql</code> operation. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead. </note> </code></pre>"},"ArrayValueList":{"type":"array","items":{"$ref":"#/components/schemas/Value"}},"SqlStatement":{"type":"string","minLength":0,"maxLength":65536},"DbName":{"type":"string","minLength":0,"maxLength":64},"SqlParameterSets":{"type":"array","items":{"$ref":"#/components/schemas/SqlParametersList"}},"Id":{"type":"string","minLength":0,"maxLength":192},"BatchExecuteStatementRequest":{"type":"object","required":["resourceArn","secretArn","sql"],"title":"BatchExecuteStatementRequest","properties":{"resourceArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster."}]},"secretArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html\">Create a database secret</a>."}]},"sql":{"allOf":[{"$ref":"#/components/schemas/SqlStatement"},{"description":"The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement."}]},"database":{"allOf":[{"$ref":"#/components/schemas/DbName"},{"description":"The name of the database."}]},"schema":{"allOf":[{"$ref":"#/components/schemas/DbName"},{"description":"The name of the database schema. <note> Currently, the <code>schema</code> parameter isn't supported. </note>"}]},"parameterSets":{"allOf":[{"$ref":"#/components/schemas/SqlParameterSets"},{"description":"The parameter set for the batch operation. The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options: <ul> <li> Specify one or more empty parameter sets. </li> <li> Use the <code>ExecuteStatement</code> operation instead of the <code>BatchExecuteStatement</code> operation. </li> </ul> <note> Array parameters are not supported. </note>"}]},"transactionId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"description":"The identifier of a transaction that was started by using the <code>BeginTransaction</code> operation. Specify the 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."}]}},"description":"The request parameters represent the input of a SQL statement over an array of data."},"UpdateResults":{"type":"array","items":{"$ref":"#/components/schemas/UpdateResult"}},"BeginTransactionRequest":{"type":"object","required":["resourceArn","secretArn"],"title":"BeginTransactionRequest","properties":{"resourceArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster."}]},"secretArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The name or ARN of the secret that enables access to the DB cluster."}]},"database":{"allOf":[{"$ref":"#/components/schemas/DbName"},{"description":"The name of the database."}]},"schema":{"allOf":[{"$ref":"#/components/schemas/DbName"},{"description":"The name of the database schema."}]}},"description":"The request parameters represent the input of a request to start a SQL transaction."},"Blob":{"type":"string"},"Boolean":{"type":"boolean"},"BoxedBoolean":{"type":"boolean"},"BoxedDouble":{"type":"number","format":"double"},"BoxedFloat":{"type":"number","format":"float"},"BoxedInteger":{"type":"integer"},"BoxedLong":{"type":"integer"},"String":{"type":"string"},"Integer":{"type":"integer"},"ColumnMetadata":{"type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the column."}]},"type":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The type of the column."}]},"typeName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The database-specific data type of the column."}]},"label":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The label for the column."}]},"schemaName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the schema that owns the table that includes the column."}]},"tableName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the table that includes the column."}]},"isAutoIncrement":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A value that indicates whether the column increments automatically."}]},"isSigned":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A value that indicates whether an integer column is signed."}]},"isCurrency":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A value that indicates whether the column contains currency values."}]},"isCaseSensitive":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A value that indicates whether the column is case-sensitive."}]},"nullable":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"A value that indicates whether the column is nullable."}]},"precision":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The precision value of a decimal number column."}]},"scale":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The scale value of a decimal number column."}]},"arrayBaseColumnType":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The type of the column."}]}},"description":"Contains the metadata for a column."},"CommitTransactionRequest":{"type":"object","required":["resourceArn","secretArn","transactionId"],"title":"CommitTransactionRequest","properties":{"resourceArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster."}]},"secretArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The name or ARN of the secret that enables access to the DB cluster."}]},"transactionId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"description":"The identifier of the transaction to end and commit."}]}},"description":"The request parameters represent the input of a commit transaction request."},"TransactionStatus":{"type":"string","minLength":0,"maxLength":128},"ExecuteSqlRequest":{"type":"object","required":["dbClusterOrInstanceArn","awsSecretStoreArn","sqlStatements"],"title":"ExecuteSqlRequest","properties":{"dbClusterOrInstanceArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The ARN of the Aurora Serverless DB cluster."}]},"awsSecretStoreArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html\">Create a database secret</a>."}]},"sqlStatements":{"allOf":[{"$ref":"#/components/schemas/SqlStatement"},{"description":"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 is permitted, including data definition, data manipulation, and commit statements. "}]},"database":{"allOf":[{"$ref":"#/components/schemas/DbName"},{"description":"The name of the database."}]},"schema":{"allOf":[{"$ref":"#/components/schemas/DbName"},{"description":"The name of the database schema."}]}},"description":"The request parameters represent the input of a request to run one or more SQL statements."},"SqlStatementResults":{"type":"array","items":{"$ref":"#/components/schemas/SqlStatementResult"}},"ResultSetOptions":{"type":"object","properties":{"decimalReturnType":{"allOf":[{"$ref":"#/components/schemas/DecimalReturnType"},{"description":"A value that indicates how a field of <code>DECIMAL</code> type is represented in the response. The value of <code>STRING</code>, the default, specifies that it is converted to a String value. The value of <code>DOUBLE_OR_LONG</code> specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise. <note> Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values. </note>"}]},"longReturnType":{"allOf":[{"$ref":"#/components/schemas/LongReturnType"},{"description":"A value that indicates how a field of <code>LONG</code> type is represented. Allowed values are <code>LONG</code> and <code>STRING</code>. The default is <code>LONG</code>. Specify <code>STRING</code> if the length or precision of numeric values might cause truncation or rounding errors. "}]}},"description":"Options that control how the result set is returned."},"RecordsFormatType":{"type":"string","enum":["NONE","JSON"]},"ExecuteStatementRequest":{"type":"object","required":["resourceArn","secretArn","sql"],"title":"ExecuteStatementRequest","properties":{"resourceArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster."}]},"secretArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html\">Create a database secret</a>."}]},"sql":{"allOf":[{"$ref":"#/components/schemas/SqlStatement"},{"description":"The SQL statement to run."}]},"database":{"allOf":[{"$ref":"#/components/schemas/DbName"},{"description":"The name of the database."}]},"schema":{"allOf":[{"$ref":"#/components/schemas/DbName"},{"description":"The name of the database schema. <note> Currently, the <code>schema</code> parameter isn't supported. </note>"}]},"parameters":{"allOf":[{"$ref":"#/components/schemas/SqlParametersList"},{"description":"The parameters for the SQL statement. <note> Array parameters are not supported. </note>"}]},"transactionId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"description":"The identifier of a transaction that was started by using the <code>BeginTransaction</code> operation. Specify the 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."}]},"includeResultMetadata":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A value that indicates whether to include metadata in the results."}]},"continueAfterTimeout":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out. <note> For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures. </note>"}]},"resultSetOptions":{"allOf":[{"$ref":"#/components/schemas/ResultSetOptions"},{"description":"Options that control how the result set is returned."}]},"formatRecordsAs":{"allOf":[{"$ref":"#/components/schemas/RecordsFormatType"},{"description":"A value that indicates whether to format the result set as a single JSON string. This parameter only applies to <code>SELECT</code> statements and is ignored for other types of statements. Allowed values are <code>NONE</code> and <code>JSON</code>. The default value is <code>NONE</code>. The result is returned in the <code>formattedRecords</code> field. For usage information about the JSON format for result sets, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API</a> in the Amazon Aurora User Guide."}]}},"description":"The request parameters represent the input of a request to run a SQL statement against a database."},"SqlRecords":{"type":"array","items":{"$ref":"#/components/schemas/FieldList"}},"Metadata":{"type":"array","items":{"$ref":"#/components/schemas/ColumnMetadata"}},"RecordsUpdated":{"type":"integer"},"FieldList":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"FormattedSqlRecords":{"type":"string"},"Field":{"type":"object","properties":{"isNull":{"allOf":[{"$ref":"#/components/schemas/BoxedBoolean"},{"description":"A NULL value."}]},"booleanValue":{"allOf":[{"$ref":"#/components/schemas/BoxedBoolean"},{"description":"A value of Boolean data type."}]},"longValue":{"allOf":[{"$ref":"#/components/schemas/BoxedLong"},{"description":"A value of long data type."}]},"doubleValue":{"allOf":[{"$ref":"#/components/schemas/BoxedDouble"},{"description":"A value of double data type."}]},"stringValue":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A value of string data type."}]},"blobValue":{"allOf":[{"$ref":"#/components/schemas/Blob"},{"description":"A value of BLOB data type."}]},"arrayValue":{"allOf":[{"$ref":"#/components/schemas/ArrayValue"},{"description":"An array of values."}]}},"description":"Contains a value."},"Long":{"type":"integer"},"ParameterName":{"type":"string"},"Row":{"type":"array","items":{"$ref":"#/components/schemas/Value"}},"Record":{"type":"object","properties":{"values":{"allOf":[{"$ref":"#/components/schemas/Row"},{"description":"The values returned in the record."}]}},"description":"A record returned by a call. <note> This data structure is only used with the deprecated <code>ExecuteSql</code> operation. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead. </note>"},"Records":{"type":"array","items":{"$ref":"#/components/schemas/Record"}},"ResultSetMetadata":{"type":"object","properties":{"columnCount":{"allOf":[{"$ref":"#/components/schemas/Long"},{"description":"The number of columns in the result set."}]},"columnMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"description":"The metadata of the columns in the result set."}]}},"description":"The metadata of the result set returned by a SQL statement."},"ResultFrame":{"type":"object","properties":{"resultSetMetadata":{"allOf":[{"$ref":"#/components/schemas/ResultSetMetadata"},{"description":"The result-set metadata in the result set."}]},"records":{"allOf":[{"$ref":"#/components/schemas/Records"},{"description":"The records in the result set."}]}},"description":"The result set returned by a SQL statement. <note> This data structure is only used with the deprecated <code>ExecuteSql</code> operation. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead. </note>"},"RollbackTransactionRequest":{"type":"object","required":["resourceArn","secretArn","transactionId"],"title":"RollbackTransactionRequest","properties":{"resourceArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster."}]},"secretArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The name or ARN of the secret that enables access to the DB cluster."}]},"transactionId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"description":"The identifier of the transaction to roll back."}]}},"description":"The request parameters represent the input of a request to perform a rollback of a transaction."},"TypeHint":{"type":"string","enum":["JSON","UUID","TIMESTAMP","DATE","TIME","DECIMAL"]},"SqlStatementResult":{"type":"object","properties":{"resultFrame":{"allOf":[{"$ref":"#/components/schemas/ResultFrame"},{"description":"The result set of the SQL statement."}]},"numberOfRecordsUpdated":{"allOf":[{"$ref":"#/components/schemas/RecordsUpdated"},{"description":"The number of records updated by a SQL statement."}]}},"description":"The result of a SQL statement. <pre><code> <note> This data structure is only used with the deprecated <code>ExecuteSql</code> operation. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement<