AWS.Tools.QLDBSession.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.QLDBSession</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet"> <summary> Sends a command to an Amazon QLDB ledger. <note><para> Instead of interacting directly with this API, we recommend that you use the Amazon QLDB Driver or the QLDB Shell to execute data transactions on a ledger. </para><ul><li><para> If you are working with an AWS SDK, use the QLDB Driver. The driver provides a high-level abstraction layer above this <code>qldbsession</code> 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>. </para></li><li><para> 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>. </para></li></ul></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.AbortTransaction"> <summary> <para> <para>Command to abort the current transaction.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.CommitTransaction_CommitDigest"> <summary> <para> <para>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.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.EndSession"> <summary> <para> <para>Command to end the current session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.StartSession_LedgerName"> <summary> <para> <para>The name of the ledger to start a new session against.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.FetchPage_NextPageToken"> <summary> <para> <para>Specifies the next page token of the page to be fetched.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.ExecuteStatement_Parameter"> <summary> <para> <para>Specifies the parameters for the parameterized statement in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.QLDBSessionToken"> <summary> <para> <para>Specifies the session token for the current command. A session token is constant throughout the life of the session.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.StartTransaction"> <summary> <para> <para>Command to start a new transaction.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.ExecuteStatement_Statement"> <summary> <para> <para>Specifies the statement of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.CommitTransaction_TransactionId"> <summary> <para> <para>Specifies the transaction ID of the transaction to commit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.ExecuteStatement_TransactionId"> <summary> <para> <para>Specifies the transaction ID of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.FetchPage_TransactionId"> <summary> <para> <para>Specifies the transaction ID of the page to be fetched.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDBSession.Model.SendCommandResponse). Specifying the name of a property of type Amazon.QLDBSession.Model.SendCommandResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDBS.SendQLDBSCommandCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |