CancelQuery

$result = $client->cancelQuery([/* ... */]);
$promise = $client->cancelQueryAsync([/* ... */]);

Cancels a query that has been issued. Cancellation is provided only if the query has not completed running 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. See code sample for details.

Parameter Syntax

$result = $client->cancelQuery([
    'QueryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CancellationMessage' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

CreateScheduledQuery

$result = $client->createScheduledQuery([/* ... */]);
$promise = $client->createScheduledQueryAsync([/* ... */]);

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

Parameter Syntax

$result = $client->createScheduledQuery([
    'ClientToken' => '<string>',
    'ErrorReportConfiguration' => [ // REQUIRED
        'S3Configuration' => [ // REQUIRED
            'BucketName' => '<string>', // REQUIRED
            'EncryptionOption' => 'SSE_S3|SSE_KMS',
            'ObjectKeyPrefix' => '<string>',
        ],
    ],
    'KmsKeyId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'NotificationConfiguration' => [ // REQUIRED
        'SnsConfiguration' => [ // REQUIRED
            'TopicArn' => '<string>', // REQUIRED
        ],
    ],
    'QueryString' => '<string>', // REQUIRED
    'ScheduleConfiguration' => [ // REQUIRED
        'ScheduleExpression' => '<string>', // REQUIRED
    ],
    'ScheduledQueryExecutionRoleArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TargetConfiguration' => [
        'TimestreamConfiguration' => [ // REQUIRED
            'DatabaseName' => '<string>', // REQUIRED
            'DimensionMappings' => [ // REQUIRED
                [
                    'DimensionValueType' => 'VARCHAR', // REQUIRED
                    'Name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MeasureNameColumn' => '<string>',
            'MixedMeasureMappings' => [
                [
                    'MeasureName' => '<string>',
                    'MeasureValueType' => 'BIGINT|BOOLEAN|DOUBLE|VARCHAR|MULTI', // REQUIRED
                    'MultiMeasureAttributeMappings' => [
                        [
                            'MeasureValueType' => 'BIGINT|BOOLEAN|DOUBLE|VARCHAR|TIMESTAMP', // REQUIRED
                            'SourceColumn' => '<string>', // REQUIRED
                            'TargetMultiMeasureAttributeName' => '<string>',
                        ],
                        // ...
                    ],
                    'SourceColumn' => '<string>',
                    'TargetMeasureName' => '<string>',
                ],
                // ...
            ],
            'MultiMeasureMappings' => [
                'MultiMeasureAttributeMappings' => [ // REQUIRED
                    [
                        'MeasureValueType' => 'BIGINT|BOOLEAN|DOUBLE|VARCHAR|TIMESTAMP', // REQUIRED
                        'SourceColumn' => '<string>', // REQUIRED
                        'TargetMultiMeasureAttributeName' => '<string>',
                    ],
                    // ...
                ],
                'TargetMultiMeasureName' => '<string>',
            ],
            'TableName' => '<string>', // REQUIRED
            'TimeColumn' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

ConflictException:

Unable to poll results for a cancelled query.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ServiceQuotaExceededException:

You have exceeded the service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

DeleteScheduledQuery

$result = $client->deleteScheduledQuery([/* ... */]);
$promise = $client->deleteScheduledQueryAsync([/* ... */]);

Deletes a given scheduled query. This is an irreversible operation.

Parameter Syntax

$result = $client->deleteScheduledQuery([
    'ScheduledQueryArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

DescribeAccountSettings

$result = $client->describeAccountSettings([/* ... */]);
$promise = $client->describeAccountSettingsAsync([/* ... */]);

Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.

You're charged only for the duration of compute units used for your workloads.

Parameter Syntax

$result = $client->describeAccountSettings([
]);

Parameter Details

Result Syntax

[
    'MaxQueryTCU' => <integer>,
    'QueryPricingModel' => 'BYTES_SCANNED|COMPUTE_UNITS',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ThrottlingException:

The request was denied due to request throttling.

InvalidEndpointException:

The requested endpoint was not valid.

DescribeEndpoints

$result = $client->describeEndpoints([/* ... */]);
$promise = $client->describeEndpointsAsync([/* ... */]);

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

Because the Timestream 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:

• You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream

• 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 and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.

Parameter Syntax

$result = $client->describeEndpoints([
]);

Parameter Details

Result Syntax

[
    'Endpoints' => [
        [
            'Address' => '<string>',
            'CachePeriodInMinutes' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ValidationException:

Invalid or malformed request.

ThrottlingException:

The request was denied due to request throttling.

DescribeScheduledQuery

$result = $client->describeScheduledQuery([/* ... */]);
$promise = $client->describeScheduledQueryAsync([/* ... */]);

Provides detailed information about a scheduled query.

Parameter Syntax

$result = $client->describeScheduledQuery([
    'ScheduledQueryArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ScheduledQuery' => [
        'Arn' => '<string>',
        'CreationTime' => <DateTime>,
        'ErrorReportConfiguration' => [
            'S3Configuration' => [
                'BucketName' => '<string>',
                'EncryptionOption' => 'SSE_S3|SSE_KMS',
                'ObjectKeyPrefix' => '<string>',
            ],
        ],
        'KmsKeyId' => '<string>',
        'LastRunSummary' => [
            'ErrorReportLocation' => [
                'S3ReportLocation' => [
                    'BucketName' => '<string>',
                    'ObjectKey' => '<string>',
                ],
            ],
            'ExecutionStats' => [
                'BytesMetered' => <integer>,
                'CumulativeBytesScanned' => <integer>,
                'DataWrites' => <integer>,
                'ExecutionTimeInMillis' => <integer>,
                'QueryResultRows' => <integer>,
                'RecordsIngested' => <integer>,
            ],
            'FailureReason' => '<string>',
            'InvocationTime' => <DateTime>,
            'RunStatus' => 'AUTO_TRIGGER_SUCCESS|AUTO_TRIGGER_FAILURE|MANUAL_TRIGGER_SUCCESS|MANUAL_TRIGGER_FAILURE',
            'TriggerTime' => <DateTime>,
        ],
        'Name' => '<string>',
        'NextInvocationTime' => <DateTime>,
        'NotificationConfiguration' => [
            'SnsConfiguration' => [
                'TopicArn' => '<string>',
            ],
        ],
        'PreviousInvocationTime' => <DateTime>,
        'QueryString' => '<string>',
        'RecentlyFailedRuns' => [
            [
                'ErrorReportLocation' => [
                    'S3ReportLocation' => [
                        'BucketName' => '<string>',
                        'ObjectKey' => '<string>',
                    ],
                ],
                'ExecutionStats' => [
                    'BytesMetered' => <integer>,
                    'CumulativeBytesScanned' => <integer>,
                    'DataWrites' => <integer>,
                    'ExecutionTimeInMillis' => <integer>,
                    'QueryResultRows' => <integer>,
                    'RecordsIngested' => <integer>,
                ],
                'FailureReason' => '<string>',
                'InvocationTime' => <DateTime>,
                'RunStatus' => 'AUTO_TRIGGER_SUCCESS|AUTO_TRIGGER_FAILURE|MANUAL_TRIGGER_SUCCESS|MANUAL_TRIGGER_FAILURE',
                'TriggerTime' => <DateTime>,
            ],
            // ...
        ],
        'ScheduleConfiguration' => [
            'ScheduleExpression' => '<string>',
        ],
        'ScheduledQueryExecutionRoleArn' => '<string>',
        'State' => 'ENABLED|DISABLED',
        'TargetConfiguration' => [
            'TimestreamConfiguration' => [
                'DatabaseName' => '<string>',
                'DimensionMappings' => [
                    [
                        'DimensionValueType' => 'VARCHAR',
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'MeasureNameColumn' => '<string>',
                'MixedMeasureMappings' => [
                    [
                        'MeasureName' => '<string>',
                        'MeasureValueType' => 'BIGINT|BOOLEAN|DOUBLE|VARCHAR|MULTI',
                        'MultiMeasureAttributeMappings' => [
                            [
                                'MeasureValueType' => 'BIGINT|BOOLEAN|DOUBLE|VARCHAR|TIMESTAMP',
                                'SourceColumn' => '<string>',
                                'TargetMultiMeasureAttributeName' => '<string>',
                            ],
                            // ...
                        ],
                        'SourceColumn' => '<string>',
                        'TargetMeasureName' => '<string>',
                    ],
                    // ...
                ],
                'MultiMeasureMappings' => [
                    'MultiMeasureAttributeMappings' => [
                        [
                            'MeasureValueType' => 'BIGINT|BOOLEAN|DOUBLE|VARCHAR|TIMESTAMP',
                            'SourceColumn' => '<string>',
                            'TargetMultiMeasureAttributeName' => '<string>',
                        ],
                        // ...
                    ],
                    'TargetMultiMeasureName' => '<string>',
                ],
                'TableName' => '<string>',
                'TimeColumn' => '<string>',
            ],
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

ExecuteScheduledQuery

$result = $client->executeScheduledQuery([/* ... */]);
$promise = $client->executeScheduledQueryAsync([/* ... */]);

You can use this API to run a scheduled query manually.

Parameter Syntax

$result = $client->executeScheduledQuery([
    'ClientToken' => '<string>',
    'InvocationTime' => <integer || string || DateTime>, // REQUIRED
    'ScheduledQueryArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

ListScheduledQueries

$result = $client->listScheduledQueries([/* ... */]);
$promise = $client->listScheduledQueriesAsync([/* ... */]);

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

Parameter Syntax

$result = $client->listScheduledQueries([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ScheduledQueries' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'ErrorReportConfiguration' => [
                'S3Configuration' => [
                    'BucketName' => '<string>',
                    'EncryptionOption' => 'SSE_S3|SSE_KMS',
                    'ObjectKeyPrefix' => '<string>',
                ],
            ],
            'LastRunStatus' => 'AUTO_TRIGGER_SUCCESS|AUTO_TRIGGER_FAILURE|MANUAL_TRIGGER_SUCCESS|MANUAL_TRIGGER_FAILURE',
            'Name' => '<string>',
            'NextInvocationTime' => <DateTime>,
            'PreviousInvocationTime' => <DateTime>,
            'State' => 'ENABLED|DISABLED',
            'TargetDestination' => [
                'TimestreamDestination' => [
                    'DatabaseName' => '<string>',
                    'TableName' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List all tags on a Timestream query resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

PrepareQuery

$result = $client->prepareQuery([/* ... */]);
$promise = $client->prepareQueryAsync([/* ... */]);

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with ValidateOnly set to true.

Parameter Syntax

$result = $client->prepareQuery([
    'QueryString' => '<string>', // REQUIRED
    'ValidateOnly' => true || false,
]);

Parameter Details

Result Syntax

[
    'Columns' => [
        [
            'Aliased' => true || false,
            'DatabaseName' => '<string>',
            'Name' => '<string>',
            'TableName' => '<string>',
            'Type' => [
                'ArrayColumnInfo' => [
                    'Name' => '<string>',
                    'Type' => [...], // RECURSIVE
                ],
                'RowColumnInfo' => [
                    [
                        'Name' => '<string>',
                        'Type' => [...], // RECURSIVE
                    ],
                    // ...
                ],
                'ScalarType' => 'VARCHAR|BOOLEAN|BIGINT|DOUBLE|TIMESTAMP|DATE|TIME|INTERVAL_DAY_TO_SECOND|INTERVAL_YEAR_TO_MONTH|UNKNOWN|INTEGER',
                'TimeSeriesMeasureValueColumnInfo' => [
                    'Name' => '<string>',
                    'Type' => [...], // RECURSIVE
                ],
            ],
        ],
        // ...
    ],
    'Parameters' => [
        [
            'Name' => '<string>',
            'Type' => [
                'ArrayColumnInfo' => [
                    'Name' => '<string>',
                    'Type' => [...], // RECURSIVE
                ],
                'RowColumnInfo' => [
                    [
                        'Name' => '<string>',
                        'Type' => [...], // RECURSIVE
                    ],
                    // ...
                ],
                'ScalarType' => 'VARCHAR|BOOLEAN|BIGINT|DOUBLE|TIMESTAMP|DATE|TIME|INTERVAL_DAY_TO_SECOND|INTERVAL_YEAR_TO_MONTH|UNKNOWN|INTEGER',
                'TimeSeriesMeasureValueColumnInfo' => [
                    'Name' => '<string>',
                    'Type' => [...], // RECURSIVE
                ],
            ],
        ],
        // ...
    ],
    'QueryString' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

Query

$result = $client->query([/* ... */]);
$promise = $client->queryAsync([/* ... */]);

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:

• If you submit a Query request with the same client token outside of the 5-minute idempotency window.

• If you submit a Query request with the same client token, but change other parameters, within the 5-minute idempotency window.

• If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message:

  Query aborted as max page response size has been exceeded by the output result row

• If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an Invalid pagination token error.

Parameter Syntax

$result = $client->query([
    'ClientToken' => '<string>',
    'MaxRows' => <integer>,
    'NextToken' => '<string>',
    'QueryString' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ColumnInfo' => [
        [
            'Name' => '<string>',
            'Type' => [
                'ArrayColumnInfo' => [...], // RECURSIVE
                'RowColumnInfo' => [...], // RECURSIVE
                'ScalarType' => 'VARCHAR|BOOLEAN|BIGINT|DOUBLE|TIMESTAMP|DATE|TIME|INTERVAL_DAY_TO_SECOND|INTERVAL_YEAR_TO_MONTH|UNKNOWN|INTEGER',
                'TimeSeriesMeasureValueColumnInfo' => [...], // RECURSIVE
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'QueryId' => '<string>',
    'QueryStatus' => [
        'CumulativeBytesMetered' => <integer>,
        'CumulativeBytesScanned' => <integer>,
        'ProgressPercentage' => <float>,
    ],
    'Rows' => [
        [
            'Data' => [
                [
                    'ArrayValue' => [...], // RECURSIVE
                    'NullValue' => true || false,
                    'RowValue' => [...], // RECURSIVE
                    'ScalarValue' => '<string>',
                    'TimeSeriesValue' => [
                        [
                            'Time' => '<string>',
                            'Value' => [...], // RECURSIVE
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

ConflictException:

Unable to poll results for a cancelled query.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

QueryExecutionException:

Timestream was unable to run the query successfully.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

ServiceQuotaExceededException:

You have exceeded the service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the association of tags from a Timestream query resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Invalid or malformed request.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource could not be found.

InvalidEndpointException:

The requested endpoint was not valid.

UpdateAccountSettings

$result = $client->updateAccountSettings([/* ... */]);
$promise = $client->updateAccountSettingsAsync([/* ... */]);

Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective.

Parameter Syntax

$result = $client->updateAccountSettings([
    'MaxQueryTCU' => <integer>,
    'QueryPricingModel' => 'BYTES_SCANNED|COMPUTE_UNITS',
]);

Parameter Details

Result Syntax

[
    'MaxQueryTCU' => <integer>,
    'QueryPricingModel' => 'BYTES_SCANNED|COMPUTE_UNITS',
]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

UpdateScheduledQuery

$result = $client->updateScheduledQuery([/* ... */]);
$promise = $client->updateScheduledQueryAsync([/* ... */]);

Update a scheduled query.

Parameter Syntax

$result = $client->updateScheduledQuery([
    'ScheduledQueryArn' => '<string>', // REQUIRED
    'State' => 'ENABLED|DISABLED', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You are not authorized to perform this action.

InternalServerException:

The service was unable to fully process this request because of an internal server error.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

Invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.