AWS.Tools.TimestreamQuery.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.TimestreamQuery</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.TSQ.GetTSQEndpointListCmdlet"> <summary> DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query. <para> Because Timestream’s SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, <i>it is not recommended that you use this API unless</i>: </para><ul><li><para> Your application uses a programming language that does not yet have SDK support </para></li><li><para> You require better control over the client-side implementation </para></li></ul><para> For detailed information on how to use DescribeEndpoints, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/Using-API.endpoint-discovery.html">The Endpoint Discovery Pattern and REST APIs</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TSQ.GetTSQEndpointListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Endpoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TimestreamQuery.Model.DescribeEndpointsResponse). Specifying the name of a property of type Amazon.TimestreamQuery.Model.DescribeEndpointsResponse 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="T:Amazon.PowerShell.Cmdlets.TSQ.InvokeTSQQueryCmdlet"> <summary> Query is a synchronous operation that enables you to execute a query. Query will timeout after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. The result set will be truncated to 1MB. Service quotas apply. For more information, see Quotas in the Timestream Developer Guide.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TSQ.InvokeTSQQueryCmdlet.MaxRow"> <summary> <para> <para> The total number of rows to return in the output. If the total number of rows available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TSQ.InvokeTSQQueryCmdlet.QueryString"> <summary> <para> <para> The query to be executed by Timestream. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TSQ.InvokeTSQQueryCmdlet.ClientToken"> <summary> <para> <para> Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a <code>ClientToken</code> makes the call to <code>Query</code> idempotent, meaning that multiple identical calls have the same effect as one single call. </para><para>Your query request will fail in the following cases:</para><ul><li><para> If you submit a request with the same client token outside the 5-minute idepotency window. </para></li><li><para> If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window. </para></li></ul><para> After 4 hours, any request with the same client token is treated as a new request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TSQ.InvokeTSQQueryCmdlet.NextToken"> <summary> <para> <para> A pagination token passed to get a set of results. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TSQ.InvokeTSQQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Rows'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TimestreamQuery.Model.QueryResponse). Specifying the name of a property of type Amazon.TimestreamQuery.Model.QueryResponse 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.TSQ.InvokeTSQQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryString parameter. The -PassThru parameter is deprecated, use -Select '^QueryString' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TSQ.InvokeTSQQueryCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TSQ.StopTSQQueryCmdlet"> <summary> Cancels a query that has been issued. Cancellation is guaranteed only if the query has not completed execution before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a <code>CancellationMessage</code>, indicating that the query has already been canceled. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TSQ.StopTSQQueryCmdlet.QueryId"> <summary> <para> <para> The id of the query that needs to be cancelled. <code>QueryID</code> is returned as part of QueryResult. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TSQ.StopTSQQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CancellationMessage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TimestreamQuery.Model.CancelQueryResponse). Specifying the name of a property of type Amazon.TimestreamQuery.Model.CancelQueryResponse 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.TSQ.StopTSQQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TSQ.StopTSQQueryCmdlet.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> |