AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon QLDB Session SendCommand API operation.

Syntax

Send-QLDBSCommand
-AbortTransaction <AbortTransactionRequest>
-CommitTransaction_CommitDigest <Byte[]>
-EndSession <EndSessionRequest>
-StartSession_LedgerName <String>
-FetchPage_NextPageToken <String>
-ExecuteStatement_Parameter <ValueHolder[]>
-QLDBSessionToken <String>
-StartTransaction <StartTransactionRequest>
-ExecuteStatement_Statement <String>
-CommitTransaction_TransactionId <String>
-ExecuteStatement_TransactionId <String>
-FetchPage_TransactionId <String>
-Select <String>
-Force <SwitchParameter>

Description

Sends a command to an Amazon QLDB ledger. Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.
  • If you are working with an AWS SDK, use the QLDB driver. The driver provides a high-level abstraction layer above this QLDB Session data plane and manages SendCommand API calls for you. For information and a list of supported programming languages, see Getting started with the driver in the Amazon QLDB Developer Guide.
  • 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 Accessing Amazon QLDB using the QLDB shell.

Parameters

-AbortTransaction <AbortTransactionRequest>
Command to abort the current transaction.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CommitTransaction_CommitDigest <Byte[]>
Specifies the commit digest for the transaction to commit. For every active transaction, the commit digest must be passed. QLDB validates CommitDigest and rejects the commit with an error if the digest computed on the client does not match the digest computed by QLDB.The purpose of the CommitDigest 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.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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CommitTransaction_TransactionId <String>
Specifies the transaction ID of the transaction to commit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndSession <EndSessionRequest>
Command to end the current session.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecuteStatement_Parameter <ValueHolder[]>
Specifies the parameters for the parameterized statement in the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExecuteStatement_Parameters
-ExecuteStatement_Statement <String>
Specifies the statement of the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecuteStatement_TransactionId <String>
Specifies the transaction ID of the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FetchPage_NextPageToken <String>
Specifies the next page token of the page to be fetched.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FetchPage_TransactionId <String>
Specifies the transaction ID of the page to be fetched.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-QLDBSessionToken <String>
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 StartSession command. This SessionToken is required for every subsequent command that is issued during the current session.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartSession_LedgerName <String>
The name of the ledger to start a new session against.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartTransaction <StartTransactionRequest>
Command to start a new transaction.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.QLDBSession.Model.SendCommandResponse
This cmdlet returns an 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.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z