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 using the 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 <i>QLDB Session</i> data plane and manages <c>SendCommand</c> 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 <c>CommitDigest</c> and rejects the commit with an error if the digest computed on the client does not match the digest computed by QLDB.</para><para>The purpose of the <c>CommitDigest</c> 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.</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 /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </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 <c>StartSession</c> command. This <c>SessionToken</c> 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> |