/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::TimestreamQuery

NAME

Paws::TimestreamQuery - Perl Interface to AWS Amazon Timestream Query

SYNOPSIS

use Paws;

my $obj = Paws->service('TimestreamQuery');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/query.timestream-2018-11-01

METHODS

CancelQuery

QueryId => Str

Each argument is described in detail in: Paws::TimestreamQuery::CancelQuery

Returns: a Paws::TimestreamQuery::CancelQueryResponse instance

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 CancellationMessage, indicating that the query has already been canceled.

DescribeEndpoints

Each argument is described in detail in: Paws::TimestreamQuery::DescribeEndpoints

Returns: a Paws::TimestreamQuery::DescribeEndpointsResponse instance

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because Timestream’s SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:

  • Your application uses a programming language that does not yet have SDK support

  • You require better control over the client-side implementation

For detailed information on how to use DescribeEndpoints, see The Endpoint Discovery Pattern and REST APIs (https://docs.aws.amazon.com/timestream/latest/developerguide/Using-API.endpoint-discovery.html).

Query

QueryString => Str
[ClientToken => Str]
[MaxRows => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::TimestreamQuery::Query

Returns: a Paws::TimestreamQuery::QueryResponse instance

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

QueryAll(sub { },QueryString => Str, [ClientToken => Str, MaxRows => Int, NextToken => Str])

QueryAll(QueryString => Str, [ClientToken => Str, MaxRows => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Rows, passing the object as the first parameter, and the string 'Rows' as the second parameter

If not, it will return a a Paws::TimestreamQuery::QueryResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues