github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/qldb-session/2019-07-11/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "service": "<p>The transactional data APIs for Amazon QLDB</p> <note> <p>Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.</p> <ul> <li> <p>If you are working with an AWS SDK, use the QLDB driver. The driver provides a high-level abstraction layer above this <i>QLDB Session</i> data plane and manages <code>SendCommand</code> API calls for you. For information and a list of supported programming languages, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html\">Getting started with the driver</a> in the <i>Amazon QLDB Developer Guide</i>.</p> </li> <li> <p>If you are working with the AWS Command Line Interface (AWS CLI), use the QLDB shell. The shell is a command line interface that uses the QLDB driver to interact with a ledger. For information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html\">Accessing Amazon QLDB using the QLDB shell</a>.</p> </li> </ul> </note>",
     4    "operations": {
     5      "SendCommand": "<p>Sends a command to an Amazon QLDB ledger.</p> <note> <p>Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.</p> <ul> <li> <p>If you are working with an AWS SDK, use the QLDB driver. The driver provides a high-level abstraction layer above this <i>QLDB Session</i> data plane and manages <code>SendCommand</code> API calls for you. For information and a list of supported programming languages, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html\">Getting started with the driver</a> in the <i>Amazon QLDB Developer Guide</i>.</p> </li> <li> <p>If you are working with the AWS Command Line Interface (AWS CLI), use the QLDB shell. The shell is a command line interface that uses the QLDB driver to interact with a ledger. For information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html\">Accessing Amazon QLDB using the QLDB shell</a>.</p> </li> </ul> </note>"
     6    },
     7    "shapes": {
     8      "AbortTransactionRequest": {
     9        "base": "<p>Contains the details of the transaction to abort.</p>",
    10        "refs": {
    11          "SendCommandRequest$AbortTransaction": "<p>Command to abort the current transaction.</p>"
    12        }
    13      },
    14      "AbortTransactionResult": {
    15        "base": "<p>Contains the details of the aborted transaction.</p>",
    16        "refs": {
    17          "SendCommandResult$AbortTransaction": "<p>Contains the details of the aborted transaction.</p>"
    18        }
    19      },
    20      "BadRequestException": {
    21        "base": "<p>Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>",
    22        "refs": {
    23        }
    24      },
    25      "CapacityExceededException": {
    26        "base": "<p>Returned when the request exceeds the processing capacity of the ledger.</p>",
    27        "refs": {
    28        }
    29      },
    30      "CommitDigest": {
    31        "base": null,
    32        "refs": {
    33          "CommitTransactionRequest$CommitDigest": "<p>Specifies the commit digest for the transaction to commit. For every active transaction, the commit digest must be passed. QLDB validates <code>CommitDigest</code> and rejects the commit with an error if the digest computed on the client does not match the digest computed by QLDB.</p> <p>The purpose of the <code>CommitDigest</code> parameter is to ensure that QLDB commits a transaction if and only if the server has processed the exact set of statements sent by the client, in the same order that client sent them, and with no duplicates.</p>",
    34          "CommitTransactionResult$CommitDigest": "<p>The commit digest of the committed transaction.</p>"
    35        }
    36      },
    37      "CommitTransactionRequest": {
    38        "base": "<p>Contains the details of the transaction to commit.</p>",
    39        "refs": {
    40          "SendCommandRequest$CommitTransaction": "<p>Command to commit the specified transaction.</p>"
    41        }
    42      },
    43      "CommitTransactionResult": {
    44        "base": "<p>Contains the details of the committed transaction.</p>",
    45        "refs": {
    46          "SendCommandResult$CommitTransaction": "<p>Contains the details of the committed transaction.</p>"
    47        }
    48      },
    49      "EndSessionRequest": {
    50        "base": "<p>Specifies a request to end the session.</p>",
    51        "refs": {
    52          "SendCommandRequest$EndSession": "<p>Command to end the current session.</p>"
    53        }
    54      },
    55      "EndSessionResult": {
    56        "base": "<p>Contains the details of the ended session.</p>",
    57        "refs": {
    58          "SendCommandResult$EndSession": "<p>Contains the details of the ended session.</p>"
    59        }
    60      },
    61      "ErrorCode": {
    62        "base": null,
    63        "refs": {
    64          "BadRequestException$Code": null,
    65          "InvalidSessionException$Code": null
    66        }
    67      },
    68      "ErrorMessage": {
    69        "base": null,
    70        "refs": {
    71          "BadRequestException$Message": null,
    72          "CapacityExceededException$Message": null,
    73          "InvalidSessionException$Message": null,
    74          "LimitExceededException$Message": null,
    75          "OccConflictException$Message": null,
    76          "RateExceededException$Message": null
    77        }
    78      },
    79      "ExecuteStatementRequest": {
    80        "base": "<p>Specifies a request to execute a statement.</p>",
    81        "refs": {
    82          "SendCommandRequest$ExecuteStatement": "<p>Command to execute a statement in the specified transaction.</p>"
    83        }
    84      },
    85      "ExecuteStatementResult": {
    86        "base": "<p>Contains the details of the executed statement.</p>",
    87        "refs": {
    88          "SendCommandResult$ExecuteStatement": "<p>Contains the details of the executed statement.</p>"
    89        }
    90      },
    91      "FetchPageRequest": {
    92        "base": "<p>Specifies the details of the page to be fetched.</p>",
    93        "refs": {
    94          "SendCommandRequest$FetchPage": "<p>Command to fetch a page.</p>"
    95        }
    96      },
    97      "FetchPageResult": {
    98        "base": "<p>Contains the page that was fetched.</p>",
    99        "refs": {
   100          "SendCommandResult$FetchPage": "<p>Contains the details of the fetched page.</p>"
   101        }
   102      },
   103      "IOUsage": {
   104        "base": "<p>Contains I/O usage metrics for a command that was invoked.</p>",
   105        "refs": {
   106          "CommitTransactionResult$ConsumedIOs": "<p>Contains metrics about the number of I/O requests that were consumed.</p>",
   107          "ExecuteStatementResult$ConsumedIOs": "<p>Contains metrics about the number of I/O requests that were consumed.</p>",
   108          "FetchPageResult$ConsumedIOs": "<p>Contains metrics about the number of I/O requests that were consumed.</p>"
   109        }
   110      },
   111      "InvalidSessionException": {
   112        "base": "<p>Returned if the session doesn't exist anymore because it timed out or expired.</p>",
   113        "refs": {
   114        }
   115      },
   116      "IonBinary": {
   117        "base": null,
   118        "refs": {
   119          "ValueHolder$IonBinary": "<p>An Amazon Ion binary value contained in a <code>ValueHolder</code> structure.</p>"
   120        }
   121      },
   122      "IonText": {
   123        "base": null,
   124        "refs": {
   125          "ValueHolder$IonText": "<p>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</p>"
   126        }
   127      },
   128      "LedgerName": {
   129        "base": null,
   130        "refs": {
   131          "StartSessionRequest$LedgerName": "<p>The name of the ledger to start a new session against.</p>"
   132        }
   133      },
   134      "LimitExceededException": {
   135        "base": "<p>Returned if a resource limit such as number of active sessions is exceeded.</p>",
   136        "refs": {
   137        }
   138      },
   139      "OccConflictException": {
   140        "base": "<p>Returned when a transaction cannot be written to the journal due to a failure in the verification phase of <i>optimistic concurrency control</i> (OCC).</p>",
   141        "refs": {
   142        }
   143      },
   144      "Page": {
   145        "base": "<p>Contains details of the fetched page.</p>",
   146        "refs": {
   147          "ExecuteStatementResult$FirstPage": "<p>Contains the details of the first fetched page.</p>",
   148          "FetchPageResult$Page": "<p>Contains details of the fetched page.</p>"
   149        }
   150      },
   151      "PageToken": {
   152        "base": null,
   153        "refs": {
   154          "FetchPageRequest$NextPageToken": "<p>Specifies the next page token of the page to be fetched.</p>",
   155          "Page$NextPageToken": "<p>The token of the next page.</p>"
   156        }
   157      },
   158      "ProcessingTimeMilliseconds": {
   159        "base": null,
   160        "refs": {
   161          "TimingInformation$ProcessingTimeMilliseconds": "<p>The amount of time that QLDB spent on processing the command, measured in milliseconds.</p>"
   162        }
   163      },
   164      "RateExceededException": {
   165        "base": "<p>Returned when the rate of requests exceeds the allowed throughput.</p>",
   166        "refs": {
   167        }
   168      },
   169      "ReadIOs": {
   170        "base": null,
   171        "refs": {
   172          "IOUsage$ReadIOs": "<p>The number of read I/O requests that the command made.</p>"
   173        }
   174      },
   175      "SendCommandRequest": {
   176        "base": null,
   177        "refs": {
   178        }
   179      },
   180      "SendCommandResult": {
   181        "base": null,
   182        "refs": {
   183        }
   184      },
   185      "SessionToken": {
   186        "base": null,
   187        "refs": {
   188          "SendCommandRequest$SessionToken": "<p>Specifies the session token for the current command. A session token is constant throughout the life of the session.</p> <p>To obtain a session token, run the <code>StartSession</code> command. This <code>SessionToken</code> is required for every subsequent command that is issued during the current session.</p>",
   189          "StartSessionResult$SessionToken": "<p>Session token of the started session. This <code>SessionToken</code> is required for every subsequent command that is issued during the current session.</p>"
   190        }
   191      },
   192      "StartSessionRequest": {
   193        "base": "<p>Specifies a request to start a new session.</p>",
   194        "refs": {
   195          "SendCommandRequest$StartSession": "<p>Command to start a new session. A session token is obtained as part of the response.</p>"
   196        }
   197      },
   198      "StartSessionResult": {
   199        "base": "<p>Contains the details of the started session.</p>",
   200        "refs": {
   201          "SendCommandResult$StartSession": "<p>Contains the details of the started session that includes a session token. This <code>SessionToken</code> is required for every subsequent command that is issued during the current session.</p>"
   202        }
   203      },
   204      "StartTransactionRequest": {
   205        "base": "<p>Specifies a request to start a transaction.</p>",
   206        "refs": {
   207          "SendCommandRequest$StartTransaction": "<p>Command to start a new transaction.</p>"
   208        }
   209      },
   210      "StartTransactionResult": {
   211        "base": "<p>Contains the details of the started transaction.</p>",
   212        "refs": {
   213          "SendCommandResult$StartTransaction": "<p>Contains the details of the started transaction.</p>"
   214        }
   215      },
   216      "Statement": {
   217        "base": null,
   218        "refs": {
   219          "ExecuteStatementRequest$Statement": "<p>Specifies the statement of the request.</p>"
   220        }
   221      },
   222      "StatementParameters": {
   223        "base": null,
   224        "refs": {
   225          "ExecuteStatementRequest$Parameters": "<p>Specifies the parameters for the parameterized statement in the request.</p>"
   226        }
   227      },
   228      "TimingInformation": {
   229        "base": "<p>Contains server-side performance information for a command. Amazon QLDB captures timing information between the times when it receives the request and when it sends the corresponding response.</p>",
   230        "refs": {
   231          "AbortTransactionResult$TimingInformation": "<p>Contains server-side performance information for the command.</p>",
   232          "CommitTransactionResult$TimingInformation": "<p>Contains server-side performance information for the command.</p>",
   233          "EndSessionResult$TimingInformation": "<p>Contains server-side performance information for the command.</p>",
   234          "ExecuteStatementResult$TimingInformation": "<p>Contains server-side performance information for the command.</p>",
   235          "FetchPageResult$TimingInformation": "<p>Contains server-side performance information for the command.</p>",
   236          "StartSessionResult$TimingInformation": "<p>Contains server-side performance information for the command.</p>",
   237          "StartTransactionResult$TimingInformation": "<p>Contains server-side performance information for the command.</p>"
   238        }
   239      },
   240      "TransactionId": {
   241        "base": null,
   242        "refs": {
   243          "CommitTransactionRequest$TransactionId": "<p>Specifies the transaction ID of the transaction to commit.</p>",
   244          "CommitTransactionResult$TransactionId": "<p>The transaction ID of the committed transaction.</p>",
   245          "ExecuteStatementRequest$TransactionId": "<p>Specifies the transaction ID of the request.</p>",
   246          "FetchPageRequest$TransactionId": "<p>Specifies the transaction ID of the page to be fetched.</p>",
   247          "StartTransactionResult$TransactionId": "<p>The transaction ID of the started transaction.</p>"
   248        }
   249      },
   250      "ValueHolder": {
   251        "base": "<p>A structure that can contain a value in multiple encoding formats.</p>",
   252        "refs": {
   253          "StatementParameters$member": null,
   254          "ValueHolders$member": null
   255        }
   256      },
   257      "ValueHolders": {
   258        "base": null,
   259        "refs": {
   260          "Page$Values": "<p>A structure that contains values in multiple encoding formats.</p>"
   261        }
   262      },
   263      "WriteIOs": {
   264        "base": null,
   265        "refs": {
   266          "IOUsage$WriteIOs": "<p>The number of write I/O requests that the command made.</p>"
   267        }
   268      }
   269    }
   270  }