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.
Invoke-TSQQuery-QueryString <String>-MaxRow <Int32>-ClientToken <String>-NextToken <String>-Select <String>-PassThru <SwitchParameter>-NoAutoIteration <SwitchParameter>
Query
is a synchronous operation that enables you to run a query against your Amazon Timestream data. Query
will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the code sample for details.
Your query request will fail in the following cases: Query
request with the same client token outside of the 5-minute idempotency window. Query
request with the same client token, but change other parameters, within the 5-minute idempotency window. Query aborted as max page response size has been exceeded by the output result row
Invalid pagination token
error. Query
request is made. Providing a ClientToken
makes the call to Query
idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query
requests has the same effect as making a single request. When using ClientToken
in a query, note the following: ClientToken
, the Query SDK generates a ClientToken
on your behalf.Query
invocation only contains the ClientToken
but does not include a NextToken
, that invocation of Query
is assumed to be a new query run.NextToken
, that particular invocation is assumed to be a subsequent invocation of a prior call to the Query API, and a result set is returned.ClientToken
is treated as a new request. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Query
output. The initial run of Query
with a MaxRows
value specified will return the result set of the query in two cases: 1MB
.maxRows
.Query
only returns a NextToken
, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken
value in the subsequent command.If the row size is large (e.g. a row has many columns), Timestream may return fewer rows to keep the response size from exceeding the 1 MB limit. If MaxRows
is not provided, Timestream will send the necessary number of rows to meet the 1 MB limit. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | MaxRows |
Query
API is invoked using NextToken
, that particular invocation is assumed to be a subsequent invocation of a prior call to Query
, and a result set is returned. However, if the Query
invocation only contains the ClientToken
, that invocation of Query
is assumed to be a new query run. Note the following when using NextToken in a query:Query
invocations, OR for a duration of up to 1 hour – whichever comes first.NextToken
will return the same set of records. To keep paginating through the result set, you must to use the most recent nextToken
.Query
invocation returns two NextToken
values, TokenA
and TokenB
. If TokenB
is used in a subsequent Query
invocation, then TokenA
is invalidated and cannot be reused.NextToken
should be used to paginate until null
is returned, at which point a new NextToken
should be used.Invalid pagination token
error. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z