AWS.Tools.QLDBSession

3.3.604.0

AWS.Tools.QLDBSession.dll-Help.xml

                                <helpItems schema="maml">

  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

    <details>

      <name>Send-QLDBSCommand</name>

      <description>

        <para>Calls the Amazon QLDB Session SendCommand API operation.</para>

      </description>

      <verb>Send</verb>

      <noun>QLDBSCommand</noun>

      <copyright>

        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>

      </copyright>

    </details>

    <description>

      <para>Sends a command to an Amazon QLDB ledger. </para>

    </description>

    <syntax>

      <syntaxItem>

        <name>Send-QLDBSCommand</name>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>AbortTransaction</name>

          <description>

            <para>Command to abort the current transaction. </para>

          </description>

          <parameterValue required="true" variableLength="false">Amazon.QLDBSession.Model.AbortTransactionRequest</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>CommitTransaction_CommitDigest</name>

          <description>

            <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>

          </description>

          <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>EndSession</name>

          <description>

            <para>Command to end the current session. </para>

          </description>

          <parameterValue required="true" variableLength="false">Amazon.QLDBSession.Model.EndSessionRequest</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>StartSession_LedgerName</name>

          <description>

            <para>The name of the ledger to start a new session against. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>FetchPage_NextPageToken</name>

          <description>

            <para>Specifies the next page token of the page to be fetched. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>ExecuteStatement_Parameter</name>

          <description>

            <para>Specifies the parameters for the parameterized statement in the request. </para>

          </description>

          <parameterValue required="true" variableLength="false">Amazon.QLDBSession.Model.ValueHolder[]</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>QLDBSessionToken</name>

          <description>

            <para>Specifies the session token for the current command. A session token is constant throughout the life of the session. 

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>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>StartTransaction</name>

          <description>

            <para>Command to start a new transaction. </para>

          </description>

          <parameterValue required="true" variableLength="false">Amazon.QLDBSession.Model.StartTransactionRequest</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>ExecuteStatement_Statement</name>

          <description>

            <para>Specifies the statement of the request. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>CommitTransaction_TransactionId</name>

          <description>

            <para>Specifies the transaction id of the transaction to commit. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>ExecuteStatement_TransactionId</name>

          <description>

            <para>Specifies the transaction id of the request. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>FetchPage_TransactionId</name>

          <description>

            <para>Specifies the transaction id of the page to be fetched. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

          <name>Force</name>

          <description>

            <para>This parameter overrides confirmation prompts to force  the cmdlet to continue its operation. This parameter should always be used with caution. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        </parameter>

      </syntaxItem>

    </syntax>

    <parameters>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>AbortTransaction</name>

        <description>

          <para>Command to abort the current transaction. </para>

        </description>

        <parameterValue required="true" variableLength="false">Amazon.QLDBSession.Model.AbortTransactionRequest</parameterValue>

        <type>

          <name>Amazon.QLDBSession.Model.AbortTransactionRequest</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>CommitTransaction_CommitDigest</name>

        <description>

          <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>

        </description>

        <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue>

        <type>

          <name>System.Byte[]</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>CommitTransaction_TransactionId</name>

        <description>

          <para>Specifies the transaction id of the transaction to commit. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>EndSession</name>

        <description>

          <para>Command to end the current session. </para>

        </description>

        <parameterValue required="true" variableLength="false">Amazon.QLDBSession.Model.EndSessionRequest</parameterValue>

        <type>

          <name>Amazon.QLDBSession.Model.EndSessionRequest</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>ExecuteStatement_Parameter</name>

        <description>

          <para>Specifies the parameters for the parameterized statement in the request. </para>

        </description>

        <parameterValue required="true" variableLength="false">Amazon.QLDBSession.Model.ValueHolder[]</parameterValue>

        <type>

          <name>Amazon.QLDBSession.Model.ValueHolder[]</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>ExecuteStatement_Statement</name>

        <description>

          <para>Specifies the statement of the request. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>ExecuteStatement_TransactionId</name>

        <description>

          <para>Specifies the transaction id of the request. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>FetchPage_NextPageToken</name>

        <description>

          <para>Specifies the next page token of the page to be fetched. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>FetchPage_TransactionId</name>

        <description>

          <para>Specifies the transaction id of the page to be fetched. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>Force</name>

        <description>

          <para>This parameter overrides confirmation prompts to force  the cmdlet to continue its operation. This parameter should always be used with caution. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        <type>

          <name>System.Management.Automation.SwitchParameter</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>QLDBSessionToken</name>

        <description>

          <para>Specifies the session token for the current command. A session token is constant throughout the life of the session. 

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>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>StartSession_LedgerName</name>

        <description>

          <para>The name of the ledger to start a new session against. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.String</parameterValue>

        <type>

          <name>System.String</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">

        <name>StartTransaction</name>

        <description>

          <para>Command to start a new transaction. </para>

        </description>

        <parameterValue required="true" variableLength="false">Amazon.QLDBSession.Model.StartTransactionRequest</parameterValue>

        <type>

          <name>Amazon.QLDBSession.Model.StartTransactionRequest</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

    </parameters>

    <returnValues>

      <returnValue>

        <type>

          <name>Amazon.QLDBSession.Model.SendCommandResponse</name>

          <uri />

          <description />

        </type>

        <description>

          <para>This cmdlet returns a Amazon.QLDBSession.Model.SendCommandResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>

        </description>

      </returnValue>

    </returnValues>

    <relatedLinks>

      <navigationLink>

        <linkText>Online version:</linkText>

        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Send-QLDBSCommand.html&amp;tocid=Send-QLDBSCommand</uri>

      </navigationLink>

      <navigationLink>

        <linkText>Common credential and region parameters: </linkText>

        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>

      </navigationLink>

    </relatedLinks>

  </command>

</helpItems>