CreateBatchLoadTask

$result = $client->createBatchLoadTask([/* ... */]);
$promise = $client->createBatchLoadTaskAsync([/* ... */]);

Creates a new Timestream batch load task. A batch load task processes data from a CSV source in an S3 location and writes to a Timestream table. A mapping from source to target is defined in a batch load task. Errors and events are written to a report at an S3 location. For the report, if the KMS key is not specified, the report will be encrypted with an S3 managed key when SSE_S3 is the option. Otherwise an error is thrown. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.

Parameter Syntax

$result = $client->createBatchLoadTask([
    'ClientToken' => '<string>',
    'DataModelConfiguration' => [
        'DataModel' => [
            'DimensionMappings' => [ // REQUIRED
                [
                    'DestinationColumn' => '<string>',
                    'SourceColumn' => '<string>',
                ],
                // ...
            ],
            'MeasureNameColumn' => '<string>',
            'MixedMeasureMappings' => [
                [
                    'MeasureName' => '<string>',
                    'MeasureValueType' => 'DOUBLE|BIGINT|VARCHAR|BOOLEAN|TIMESTAMP|MULTI', // REQUIRED
                    'MultiMeasureAttributeMappings' => [
                        [
                            'MeasureValueType' => 'DOUBLE|BIGINT|BOOLEAN|VARCHAR|TIMESTAMP',
                            'SourceColumn' => '<string>', // REQUIRED
                            'TargetMultiMeasureAttributeName' => '<string>',
                        ],
                        // ...
                    ],
                    'SourceColumn' => '<string>',
                    'TargetMeasureName' => '<string>',
                ],
                // ...
            ],
            'MultiMeasureMappings' => [
                'MultiMeasureAttributeMappings' => [ // REQUIRED
                    [
                        'MeasureValueType' => 'DOUBLE|BIGINT|BOOLEAN|VARCHAR|TIMESTAMP',
                        'SourceColumn' => '<string>', // REQUIRED
                        'TargetMultiMeasureAttributeName' => '<string>',
                    ],
                    // ...
                ],
                'TargetMultiMeasureName' => '<string>',
            ],
            'TimeColumn' => '<string>',
            'TimeUnit' => 'MILLISECONDS|SECONDS|MICROSECONDS|NANOSECONDS',
        ],
        'DataModelS3Configuration' => [
            'BucketName' => '<string>',
            'ObjectKey' => '<string>',
        ],
    ],
    'DataSourceConfiguration' => [ // REQUIRED
        'CsvConfiguration' => [
            'ColumnSeparator' => '<string>',
            'EscapeChar' => '<string>',
            'NullValue' => '<string>',
            'QuoteChar' => '<string>',
            'TrimWhiteSpace' => true || false,
        ],
        'DataFormat' => 'CSV', // REQUIRED
        'DataSourceS3Configuration' => [ // REQUIRED
            'BucketName' => '<string>', // REQUIRED
            'ObjectKeyPrefix' => '<string>',
        ],
    ],
    'RecordVersion' => <integer>,
    'ReportConfiguration' => [ // REQUIRED
        'ReportS3Configuration' => [
            'BucketName' => '<string>', // REQUIRED
            'EncryptionOption' => 'SSE_S3|SSE_KMS',
            'KmsKeyId' => '<string>',
            'ObjectKeyPrefix' => '<string>',
        ],
    ],
    'TargetDatabaseName' => '<string>', // REQUIRED
    'TargetTableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalServerException:

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

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

AccessDeniedException:

You are not authorized to perform this action.

ValidationException:

An invalid or malformed request.

ConflictException:

Timestream was unable to process this request because it contains resource that already exists.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ServiceQuotaExceededException:

The instance quota of resource exceeded for this account.

InvalidEndpointException:

The requested endpoint was not valid.

CreateDatabase

$result = $client->createDatabase([/* ... */]);
$promise = $client->createDatabaseAsync([/* ... */]);

Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Database' => [
        'Arn' => '<string>',
        'CreationTime' => <DateTime>,
        'DatabaseName' => '<string>',
        'KmsKeyId' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'TableCount' => <integer>,
    ],
]

Result Details

Errors

ConflictException:

Timestream was unable to process this request because it contains resource that already exists.

ValidationException:

An invalid or malformed request.

AccessDeniedException:

You are not authorized to perform this action.

ServiceQuotaExceededException:

The instance quota of resource exceeded for this account.

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

InvalidEndpointException:

The requested endpoint was not valid.

InternalServerException:

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

InvalidEndpointException:

The requested endpoint was not valid.

CreateTable

$result = $client->createTable([/* ... */]);
$promise = $client->createTableAsync([/* ... */]);

Adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same database. You might have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. See code sample for details.

Parameter Syntax

$result = $client->createTable([
    'DatabaseName' => '<string>', // REQUIRED
    'MagneticStoreWriteProperties' => [
        'EnableMagneticStoreWrites' => true || false, // REQUIRED
        'MagneticStoreRejectedDataLocation' => [
            'S3Configuration' => [
                'BucketName' => '<string>',
                'EncryptionOption' => 'SSE_S3|SSE_KMS',
                'KmsKeyId' => '<string>',
                'ObjectKeyPrefix' => '<string>',
            ],
        ],
    ],
    'RetentionProperties' => [
        'MagneticStoreRetentionPeriodInDays' => <integer>, // REQUIRED
        'MemoryStoreRetentionPeriodInHours' => <integer>, // REQUIRED
    ],
    'Schema' => [
        'CompositePartitionKey' => [
            [
                'EnforcementInRecord' => 'REQUIRED|OPTIONAL',
                'Name' => '<string>',
                'Type' => 'DIMENSION|MEASURE', // REQUIRED
            ],
            // ...
        ],
    ],
    'TableName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Table' => [
        'Arn' => '<string>',
        'CreationTime' => <DateTime>,
        'DatabaseName' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'MagneticStoreWriteProperties' => [
            'EnableMagneticStoreWrites' => true || false,
            'MagneticStoreRejectedDataLocation' => [
                'S3Configuration' => [
                    'BucketName' => '<string>',
                    'EncryptionOption' => 'SSE_S3|SSE_KMS',
                    'KmsKeyId' => '<string>',
                    'ObjectKeyPrefix' => '<string>',
                ],
            ],
        ],
        'RetentionProperties' => [
            'MagneticStoreRetentionPeriodInDays' => <integer>,
            'MemoryStoreRetentionPeriodInHours' => <integer>,
        ],
        'Schema' => [
            'CompositePartitionKey' => [
                [
                    'EnforcementInRecord' => 'REQUIRED|OPTIONAL',
                    'Name' => '<string>',
                    'Type' => 'DIMENSION|MEASURE',
                ],
                // ...
            ],
        ],
        'TableName' => '<string>',
        'TableStatus' => 'ACTIVE|DELETING|RESTORING',
    ],
]

Result Details

Errors

ConflictException:

Timestream was unable to process this request because it contains resource that already exists.

ValidationException:

An invalid or malformed request.

AccessDeniedException:

You are not authorized to perform this action.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ServiceQuotaExceededException:

The instance quota of resource exceeded for this account.

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

InvalidEndpointException:

The requested endpoint was not valid.

InternalServerException:

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

InvalidEndpointException:

The requested endpoint was not valid.

DeleteDatabase

$result = $client->deleteDatabase([/* ... */]);
$promise = $client->deleteDatabaseAsync([/* ... */]);

Deletes a given Timestream database. This is an irreversible operation. After a database is deleted, the time-series data from its tables cannot be recovered.

See code sample for details.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ValidationException:

An invalid or malformed request.

AccessDeniedException:

You are not authorized to perform this action.

InvalidEndpointException:

The requested endpoint was not valid.

DeleteTable

$result = $client->deleteTable([/* ... */]);
$promise = $client->deleteTableAsync([/* ... */]);

Deletes a given Timestream table. This is an irreversible operation. After a Timestream database table is deleted, the time-series data stored in the table cannot be recovered.

See code sample for details.

Parameter Syntax

$result = $client->deleteTable([
    'DatabaseName' => '<string>', // REQUIRED
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

ValidationException:

An invalid or malformed request.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

AccessDeniedException:

You are not authorized to perform this action.

InvalidEndpointException:

The requested endpoint was not valid.

DescribeBatchLoadTask

$result = $client->describeBatchLoadTask([/* ... */]);
$promise = $client->describeBatchLoadTaskAsync([/* ... */]);

Returns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply. See code sample for details.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'BatchLoadTaskDescription' => [
        'CreationTime' => <DateTime>,
        'DataModelConfiguration' => [
            'DataModel' => [
                'DimensionMappings' => [
                    [
                        'DestinationColumn' => '<string>',
                        'SourceColumn' => '<string>',
                    ],
                    // ...
                ],
                'MeasureNameColumn' => '<string>',
                'MixedMeasureMappings' => [
                    [
                        'MeasureName' => '<string>',
                        'MeasureValueType' => 'DOUBLE|BIGINT|VARCHAR|BOOLEAN|TIMESTAMP|MULTI',
                        'MultiMeasureAttributeMappings' => [
                            [
                                'MeasureValueType' => 'DOUBLE|BIGINT|BOOLEAN|VARCHAR|TIMESTAMP',
                                'SourceColumn' => '<string>',
                                'TargetMultiMeasureAttributeName' => '<string>',
                            ],
                            // ...
                        ],
                        'SourceColumn' => '<string>',
                        'TargetMeasureName' => '<string>',
                    ],
                    // ...
                ],
                'MultiMeasureMappings' => [
                    'MultiMeasureAttributeMappings' => [
                        [
                            'MeasureValueType' => 'DOUBLE|BIGINT|BOOLEAN|VARCHAR|TIMESTAMP',
                            'SourceColumn' => '<string>',
                            'TargetMultiMeasureAttributeName' => '<string>',
                        ],
                        // ...
                    ],
                    'TargetMultiMeasureName' => '<string>',
                ],
                'TimeColumn' => '<string>',
                'TimeUnit' => 'MILLISECONDS|SECONDS|MICROSECONDS|NANOSECONDS',
            ],
            'DataModelS3Configuration' => [
                'BucketName' => '<string>',
                'ObjectKey' => '<string>',
            ],
        ],
        'DataSourceConfiguration' => [
            'CsvConfiguration' => [
                'ColumnSeparator' => '<string>',
                'EscapeChar' => '<string>',
                'NullValue' => '<string>',
                'QuoteChar' => '<string>',
                'TrimWhiteSpace' => true || false,
            ],
            'DataFormat' => 'CSV',
            'DataSourceS3Configuration' => [
                'BucketName' => '<string>',
                'ObjectKeyPrefix' => '<string>',
            ],
        ],
        'ErrorMessage' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'ProgressReport' => [
            'BytesMetered' => <integer>,
            'FileFailures' => <integer>,
            'ParseFailures' => <integer>,
            'RecordIngestionFailures' => <integer>,
            'RecordsIngested' => <integer>,
            'RecordsProcessed' => <integer>,
        ],
        'RecordVersion' => <integer>,
        'ReportConfiguration' => [
            'ReportS3Configuration' => [
                'BucketName' => '<string>',
                'EncryptionOption' => 'SSE_S3|SSE_KMS',
                'KmsKeyId' => '<string>',
                'ObjectKeyPrefix' => '<string>',
            ],
        ],
        'ResumableUntil' => <DateTime>,
        'TargetDatabaseName' => '<string>',
        'TargetTableName' => '<string>',
        'TaskId' => '<string>',
        'TaskStatus' => 'CREATED|IN_PROGRESS|FAILED|SUCCEEDED|PROGRESS_STOPPED|PENDING_RESUME',
    ],
]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

AccessDeniedException:

You are not authorized to perform this action.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

InvalidEndpointException:

The requested endpoint was not valid.

DescribeDatabase

$result = $client->describeDatabase([/* ... */]);
$promise = $client->describeDatabaseAsync([/* ... */]);

Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. See code sample for details.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Database' => [
        'Arn' => '<string>',
        'CreationTime' => <DateTime>,
        'DatabaseName' => '<string>',
        'KmsKeyId' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'TableCount' => <integer>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ValidationException:

An invalid or malformed request.

AccessDeniedException:

You are not authorized to perform this action.

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

InternalServerException:

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

InvalidEndpointException:

The requested endpoint was not valid.

DescribeEndpoints

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

Returns a list of available endpoints to make Timestream API calls against. This API operation is available through both the Write and Query APIs.

Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, we don't recommend that you use this API operation 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:

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

ValidationException:

An invalid or malformed request.

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

DescribeTable

$result = $client->describeTable([/* ... */]);
$promise = $client->describeTableAsync([/* ... */]);

Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. See code sample for details.

Parameter Syntax

$result = $client->describeTable([
    'DatabaseName' => '<string>', // REQUIRED
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Table' => [
        'Arn' => '<string>',
        'CreationTime' => <DateTime>,
        'DatabaseName' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'MagneticStoreWriteProperties' => [
            'EnableMagneticStoreWrites' => true || false,
            'MagneticStoreRejectedDataLocation' => [
                'S3Configuration' => [
                    'BucketName' => '<string>',
                    'EncryptionOption' => 'SSE_S3|SSE_KMS',
                    'KmsKeyId' => '<string>',
                    'ObjectKeyPrefix' => '<string>',
                ],
            ],
        ],
        'RetentionProperties' => [
            'MagneticStoreRetentionPeriodInDays' => <integer>,
            'MemoryStoreRetentionPeriodInHours' => <integer>,
        ],
        'Schema' => [
            'CompositePartitionKey' => [
                [
                    'EnforcementInRecord' => 'REQUIRED|OPTIONAL',
                    'Name' => '<string>',
                    'Type' => 'DIMENSION|MEASURE',
                ],
                // ...
            ],
        ],
        'TableName' => '<string>',
        'TableStatus' => 'ACTIVE|DELETING|RESTORING',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ValidationException:

An invalid or malformed request.

AccessDeniedException:

You are not authorized to perform this action.

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

InternalServerException:

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

InvalidEndpointException:

The requested endpoint was not valid.

ListBatchLoadTasks

$result = $client->listBatchLoadTasks([/* ... */]);
$promise = $client->listBatchLoadTasksAsync([/* ... */]);

Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See code sample for details.

Parameter Syntax

$result = $client->listBatchLoadTasks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TaskStatus' => 'CREATED|IN_PROGRESS|FAILED|SUCCEEDED|PROGRESS_STOPPED|PENDING_RESUME',
]);

Parameter Details

Result Syntax

[
    'BatchLoadTasks' => [
        [
            'CreationTime' => <DateTime>,
            'DatabaseName' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'ResumableUntil' => <DateTime>,
            'TableName' => '<string>',
            'TaskId' => '<string>',
            'TaskStatus' => 'CREATED|IN_PROGRESS|FAILED|SUCCEEDED|PROGRESS_STOPPED|PENDING_RESUME',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

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

AccessDeniedException:

You are not authorized to perform this action.

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

ValidationException:

An invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

ListDatabases

$result = $client->listDatabases([/* ... */]);
$promise = $client->listDatabasesAsync([/* ... */]);

Returns a list of your Timestream databases. Service quotas apply. See code sample for details.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Databases' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'DatabaseName' => '<string>',
            'KmsKeyId' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'TableCount' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

ValidationException:

An invalid or malformed request.

AccessDeniedException:

You are not authorized to perform this action.

InvalidEndpointException:

The requested endpoint was not valid.

ListTables

$result = $client->listTables([/* ... */]);
$promise = $client->listTablesAsync([/* ... */]);

Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tables' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'DatabaseName' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'MagneticStoreWriteProperties' => [
                'EnableMagneticStoreWrites' => true || false,
                'MagneticStoreRejectedDataLocation' => [
                    'S3Configuration' => [
                        'BucketName' => '<string>',
                        'EncryptionOption' => 'SSE_S3|SSE_KMS',
                        'KmsKeyId' => '<string>',
                        'ObjectKeyPrefix' => '<string>',
                    ],
                ],
            ],
            'RetentionProperties' => [
                'MagneticStoreRetentionPeriodInDays' => <integer>,
                'MemoryStoreRetentionPeriodInHours' => <integer>,
            ],
            'Schema' => [
                'CompositePartitionKey' => [
                    [
                        'EnforcementInRecord' => 'REQUIRED|OPTIONAL',
                        'Name' => '<string>',
                        'Type' => 'DIMENSION|MEASURE',
                    ],
                    // ...
                ],
            ],
            'TableName' => '<string>',
            'TableStatus' => 'ACTIVE|DELETING|RESTORING',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

ValidationException:

An invalid or malformed request.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

AccessDeniedException:

You are not authorized to perform this action.

InvalidEndpointException:

The requested endpoint was not valid.

ListTagsForResource

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

Lists all tags on a Timestream resource.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

ValidationException:

An invalid or malformed request.

InvalidEndpointException:

The requested endpoint was not valid.

ResumeBatchLoadTask

$result = $client->resumeBatchLoadTask([/* ... */]);
$promise = $client->resumeBatchLoadTaskAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

AccessDeniedException:

You are not authorized to perform this action.

ValidationException:

An invalid or malformed request.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

InvalidEndpointException:

The requested endpoint was not valid.

TagResource

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

Associates 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 operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ServiceQuotaExceededException:

The instance quota of resource exceeded for this account.

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

ValidationException:

An 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 resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

An invalid or malformed request.

ServiceQuotaExceededException:

The instance quota of resource exceeded for this account.

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

InvalidEndpointException:

The requested endpoint was not valid.

UpdateDatabase

$result = $client->updateDatabase([/* ... */]);
$promise = $client->updateDatabaseAsync([/* ... */]);

Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent UpdateDatabase requests, first writer wins.

See code sample for details.

Parameter Syntax

$result = $client->updateDatabase([
    'DatabaseName' => '<string>', // REQUIRED
    'KmsKeyId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Database' => [
        'Arn' => '<string>',
        'CreationTime' => <DateTime>,
        'DatabaseName' => '<string>',
        'KmsKeyId' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'TableCount' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

An invalid or malformed request.

AccessDeniedException:

You are not authorized to perform this action.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ServiceQuotaExceededException:

The instance quota of resource exceeded for this account.

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

InternalServerException:

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

InvalidEndpointException:

The requested endpoint was not valid.

UpdateTable

$result = $client->updateTable([/* ... */]);
$promise = $client->updateTableAsync([/* ... */]);

Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store.

See code sample for details.

Parameter Syntax

$result = $client->updateTable([
    'DatabaseName' => '<string>', // REQUIRED
    'MagneticStoreWriteProperties' => [
        'EnableMagneticStoreWrites' => true || false, // REQUIRED
        'MagneticStoreRejectedDataLocation' => [
            'S3Configuration' => [
                'BucketName' => '<string>',
                'EncryptionOption' => 'SSE_S3|SSE_KMS',
                'KmsKeyId' => '<string>',
                'ObjectKeyPrefix' => '<string>',
            ],
        ],
    ],
    'RetentionProperties' => [
        'MagneticStoreRetentionPeriodInDays' => <integer>, // REQUIRED
        'MemoryStoreRetentionPeriodInHours' => <integer>, // REQUIRED
    ],
    'Schema' => [
        'CompositePartitionKey' => [
            [
                'EnforcementInRecord' => 'REQUIRED|OPTIONAL',
                'Name' => '<string>',
                'Type' => 'DIMENSION|MEASURE', // REQUIRED
            ],
            // ...
        ],
    ],
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Table' => [
        'Arn' => '<string>',
        'CreationTime' => <DateTime>,
        'DatabaseName' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'MagneticStoreWriteProperties' => [
            'EnableMagneticStoreWrites' => true || false,
            'MagneticStoreRejectedDataLocation' => [
                'S3Configuration' => [
                    'BucketName' => '<string>',
                    'EncryptionOption' => 'SSE_S3|SSE_KMS',
                    'KmsKeyId' => '<string>',
                    'ObjectKeyPrefix' => '<string>',
                ],
            ],
        ],
        'RetentionProperties' => [
            'MagneticStoreRetentionPeriodInDays' => <integer>,
            'MemoryStoreRetentionPeriodInHours' => <integer>,
        ],
        'Schema' => [
            'CompositePartitionKey' => [
                [
                    'EnforcementInRecord' => 'REQUIRED|OPTIONAL',
                    'Name' => '<string>',
                    'Type' => 'DIMENSION|MEASURE',
                ],
                // ...
            ],
        ],
        'TableName' => '<string>',
        'TableStatus' => 'ACTIVE|DELETING|RESTORING',
    ],
]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

ValidationException:

An invalid or malformed request.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

AccessDeniedException:

You are not authorized to perform this action.

InvalidEndpointException:

The requested endpoint was not valid.

WriteRecords

$result = $client->writeRecords([/* ... */]);
$promise = $client->writeRecordsAsync([/* ... */]);

Enables you to write your time-series data into Timestream. You can specify a single data point or a batch of data points to be inserted into the system. Timestream offers you a flexible schema that auto detects the column names and data types for your Timestream tables based on the dimension names and data types of the data points you specify when invoking writes into the database.

Timestream supports eventual consistency read semantics. This means that when you query data immediately after writing a batch of data into Timestream, the query results might not reflect the results of a recently completed write operation. The results may also include some stale data. If you repeat the query request after a short time, the results should return the latest data. Service quotas apply.

See code sample for details.

Upserts

You can use the Version parameter in a WriteRecords request to update data points. Timestream tracks a version number with each record. Version defaults to 1 when it's not specified for the record in the request. Timestream updates an existing record’s measure value along with its Version when it receives a write request with a higher Version number for that record. When it receives an update request where the measure value is the same as that of the existing record, Timestream still updates Version, if it is greater than the existing value of Version. You can update a data point as many times as desired, as long as the value of Version continuously increases.

For example, suppose you write a new record without indicating Version in the request. Timestream stores this record, and set Version to 1. Now, suppose you try to update this record with a WriteRecords request of the same record with a different measure value but, like before, do not provide Version. In this case, Timestream will reject this update with a RejectedRecordsException since the updated record’s version is not greater than the existing value of Version.

However, if you were to resend the update request with Version set to 2, Timestream would then succeed in updating the record’s value, and the Version would be set to 2. Next, suppose you sent a WriteRecords request with this same record and an identical measure value, but with Version set to 3. In this case, Timestream would only update Version to 3. Any further updates would need to send a version number greater than 3, or the update requests would receive a RejectedRecordsException.

Parameter Syntax

$result = $client->writeRecords([
    'CommonAttributes' => [
        'Dimensions' => [
            [
                'DimensionValueType' => 'VARCHAR',
                'Name' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'MeasureName' => '<string>',
        'MeasureValue' => '<string>',
        'MeasureValueType' => 'DOUBLE|BIGINT|VARCHAR|BOOLEAN|TIMESTAMP|MULTI',
        'MeasureValues' => [
            [
                'Name' => '<string>', // REQUIRED
                'Type' => 'DOUBLE|BIGINT|VARCHAR|BOOLEAN|TIMESTAMP|MULTI', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Time' => '<string>',
        'TimeUnit' => 'MILLISECONDS|SECONDS|MICROSECONDS|NANOSECONDS',
        'Version' => <integer>,
    ],
    'DatabaseName' => '<string>', // REQUIRED
    'Records' => [ // REQUIRED
        [
            'Dimensions' => [
                [
                    'DimensionValueType' => 'VARCHAR',
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MeasureName' => '<string>',
            'MeasureValue' => '<string>',
            'MeasureValueType' => 'DOUBLE|BIGINT|VARCHAR|BOOLEAN|TIMESTAMP|MULTI',
            'MeasureValues' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Type' => 'DOUBLE|BIGINT|VARCHAR|BOOLEAN|TIMESTAMP|MULTI', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Time' => '<string>',
            'TimeUnit' => 'MILLISECONDS|SECONDS|MICROSECONDS|NANOSECONDS',
            'Version' => <integer>,
        ],
        // ...
    ],
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RecordsIngested' => [
        'MagneticStore' => <integer>,
        'MemoryStore' => <integer>,
        'Total' => <integer>,
    ],
]

Result Details

Errors

InternalServerException:

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

ThrottlingException:

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

ValidationException:

An invalid or malformed request.

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

AccessDeniedException:

You are not authorized to perform this action.

RejectedRecordsException:

WriteRecords would throw this exception in the following cases:

• Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but:

  • Measure values are different

  • Version is not present in the request or the value of version in the new record is equal to or lower than the existing value

  In this case, if Timestream rejects data, the ExistingVersion field in the RejectedRecords response will indicate the current record’s version. To force an update, you can resend the request with a version for the record set to a value greater than the ExistingVersion.

• Records with timestamps that lie outside the retention duration of the memory store.

• Records with dimensions or measures that exceed the Timestream defined limits.

For more information, see Quotas in the Amazon Timestream Developer Guide.

InvalidEndpointException:

The requested endpoint was not valid.