For similar capabilities to Amazon Timestream for LiveAnalytics, consider Amazon Timestream for InfluxDB. It offers simplified data ingestion and single-digit millisecond query response times for real-time analytics. Learn more [here](https://docs.aws.amazon.com//timestream/latest/developerguide/timestream-for-influxdb.html).
# Amazon Timestream Write
The following actions are supported by Amazon Timestream Write:
+ [CreateBatchLoadTask](API_CreateBatchLoadTask.md)
+ [CreateDatabase](API_CreateDatabase.md)
+ [CreateTable](API_CreateTable.md)
+ [DeleteDatabase](API_DeleteDatabase.md)
+ [DeleteTable](API_DeleteTable.md)
+ [DescribeBatchLoadTask](API_DescribeBatchLoadTask.md)
+ [DescribeDatabase](API_DescribeDatabase.md)
+ [DescribeEndpoints](API_DescribeEndpoints.md)
+ [DescribeTable](API_DescribeTable.md)
+ [ListBatchLoadTasks](API_ListBatchLoadTasks.md)
+ [ListDatabases](API_ListDatabases.md)
+ [ListTables](API_ListTables.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ResumeBatchLoadTask](API_ResumeBatchLoadTask.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateDatabase](API_UpdateDatabase.md)
+ [UpdateTable](API_UpdateTable.md)
+ [WriteRecords](API_WriteRecords.md)
# CreateBatchLoadTask
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 AWS 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 [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). For details, see [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html).
## Request Syntax
```
{
"ClientToken": "string",
"DataModelConfiguration": {
"DataModel": {
"DimensionMappings": [
{
"DestinationColumn": "string",
"SourceColumn": "string"
}
],
"MeasureNameColumn": "string",
"MixedMeasureMappings": [
{
"MeasureName": "string",
"MeasureValueType": "string",
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"SourceColumn": "string",
"TargetMeasureName": "string"
}
],
"MultiMeasureMappings": {
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"TargetMultiMeasureName": "string"
},
"TimeColumn": "string",
"TimeUnit": "string"
},
"DataModelS3Configuration": {
"BucketName": "string",
"ObjectKey": "string"
}
},
"DataSourceConfiguration": {
"CsvConfiguration": {
"ColumnSeparator": "string",
"EscapeChar": "string",
"NullValue": "string",
"QuoteChar": "string",
"TrimWhiteSpace": boolean
},
"DataFormat": "string",
"DataSourceS3Configuration": {
"BucketName": "string",
"ObjectKeyPrefix": "string"
}
},
"RecordVersion": number,
"ReportConfiguration": {
"ReportS3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
},
"TargetDatabaseName": "string",
"TargetTableName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ClientToken](#API_CreateBatchLoadTask_RequestSyntax) **
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
** [DataModelConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **
Type: [DataModelConfiguration](API_DataModelConfiguration.md) object
Required: No
** [DataSourceConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **
Defines configuration details about the data source for a batch load task.
Type: [DataSourceConfiguration](API_DataSourceConfiguration.md) object
Required: Yes
** [RecordVersion](#API_CreateBatchLoadTask_RequestSyntax) **
Type: Long
Required: No
** [ReportConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **
Report configuration for a batch load task. This contains details about where error reports are stored.
Type: [ReportConfiguration](API_ReportConfiguration.md) object
Required: Yes
** [TargetDatabaseName](#API_CreateBatchLoadTask_RequestSyntax) **
Target Timestream database for a batch load task.
Type: String
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
** [TargetTableName](#API_CreateBatchLoadTask_RequestSyntax) **
Target Timestream table for a batch load task.
Type: String
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
## Response Syntax
```
{
"TaskId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TaskId](#API_CreateBatchLoadTask_ResponseSyntax) **
The ID of the batch load task.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 32.
Pattern: `[A-Z0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** ConflictException **
Timestream was unable to process this request because it contains resource that already exists.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ServiceQuotaExceededException **
The instance quota of resource exceeded for this account.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateBatchLoadTask)
# CreateDatabase
Creates a new Timestream database. If the AWS KMS key is not specified, the database will be encrypted with a Timestream managed AWS KMS key located in your account. For more information, see [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). For details, see [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html).
## Request Syntax
```
{
"DatabaseName": "string",
"KmsKeyId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [DatabaseName](#API_CreateDatabase_RequestSyntax) **
The name of the Timestream database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
** [KmsKeyId](#API_CreateDatabase_RequestSyntax) **
The AWS KMS key for the database. If the AWS KMS key is not specified, the database will be encrypted with a Timestream managed AWS KMS key located in your account. For more information, see [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** [Tags](#API_CreateDatabase_RequestSyntax) **
A list of key-value pairs to label the table.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"Database": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Database](#API_CreateDatabase_ResponseSyntax) **
The newly created Timestream database.
Type: [Database](API_Database.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** ConflictException **
Timestream was unable to process this request because it contains resource that already exists.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ServiceQuotaExceededException **
The instance quota of resource exceeded for this account.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateDatabase)
# CreateTable
Adds a new table to an existing database in your account. In an AWS 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](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html) for details.
## Request Syntax
```
{
"DatabaseName": "string",
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [DatabaseName](#API_CreateTable_RequestSyntax) **
The name of the Timestream database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
** [MagneticStoreWriteProperties](#API_CreateTable_RequestSyntax) **
Contains properties to set on the table when enabling magnetic store writes.
Type: [MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md) object
Required: No
** [RetentionProperties](#API_CreateTable_RequestSyntax) **
The duration for which your time-series data must be stored in the memory store and the magnetic store.
Type: [RetentionProperties](API_RetentionProperties.md) object
Required: No
** [Schema](#API_CreateTable_RequestSyntax) **
The schema of the table.
Type: [Schema](API_Schema.md) object
Required: No
** [TableName](#API_CreateTable_RequestSyntax) **
The name of the Timestream table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
** [Tags](#API_CreateTable_RequestSyntax) **
A list of key-value pairs to label the table.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"Table": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string",
"TableStatus": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Table](#API_CreateTable_ResponseSyntax) **
The newly created Timestream table.
Type: [Table](API_Table.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** ConflictException **
Timestream was unable to process this request because it contains resource that already exists.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ServiceQuotaExceededException **
The instance quota of resource exceeded for this account.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateTable)
# DeleteDatabase
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.*
**Note**
All tables in the database must be deleted first, or a ValidationException error will be thrown.
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html) for details.
## Request Syntax
```
{
"DatabaseName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [DatabaseName](#API_DeleteDatabase_RequestSyntax) **
The name of the Timestream database to be deleted.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DeleteDatabase)
# DeleteTable
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.
**Note**
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html) for details.
## Request Syntax
```
{
"DatabaseName": "string",
"TableName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [DatabaseName](#API_DeleteTable_RequestSyntax) **
The name of the database where the Timestream database is to be deleted.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
** [TableName](#API_DeleteTable_RequestSyntax) **
The name of the Timestream table to be deleted.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DeleteTable)
# DescribeBatchLoadTask
Returns information about the batch load task, including configurations, mappings, progress, and other details. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html) for details.
## Request Syntax
```
{
"TaskId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [TaskId](#API_DescribeBatchLoadTask_RequestSyntax) **
The ID of the batch load task.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 32.
Pattern: `[A-Z0-9]+`
Required: Yes
## Response Syntax
```
{
"BatchLoadTaskDescription": {
"CreationTime": number,
"DataModelConfiguration": {
"DataModel": {
"DimensionMappings": [
{
"DestinationColumn": "string",
"SourceColumn": "string"
}
],
"MeasureNameColumn": "string",
"MixedMeasureMappings": [
{
"MeasureName": "string",
"MeasureValueType": "string",
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"SourceColumn": "string",
"TargetMeasureName": "string"
}
],
"MultiMeasureMappings": {
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string",
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string"
}
],
"TargetMultiMeasureName": "string"
},
"TimeColumn": "string",
"TimeUnit": "string"
},
"DataModelS3Configuration": {
"BucketName": "string",
"ObjectKey": "string"
}
},
"DataSourceConfiguration": {
"CsvConfiguration": {
"ColumnSeparator": "string",
"EscapeChar": "string",
"NullValue": "string",
"QuoteChar": "string",
"TrimWhiteSpace": boolean
},
"DataFormat": "string",
"DataSourceS3Configuration": {
"BucketName": "string",
"ObjectKeyPrefix": "string"
}
},
"ErrorMessage": "string",
"LastUpdatedTime": number,
"ProgressReport": {
"BytesMetered": number,
"FileFailures": number,
"ParseFailures": number,
"RecordIngestionFailures": number,
"RecordsIngested": number,
"RecordsProcessed": number
},
"RecordVersion": number,
"ReportConfiguration": {
"ReportS3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
},
"ResumableUntil": number,
"TargetDatabaseName": "string",
"TargetTableName": "string",
"TaskId": "string",
"TaskStatus": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BatchLoadTaskDescription](#API_DescribeBatchLoadTask_ResponseSyntax) **
Description of the batch load task.
Type: [BatchLoadTaskDescription](API_BatchLoadTaskDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeBatchLoadTask)
# DescribeDatabase
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](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html) for details.
## Request Syntax
```
{
"DatabaseName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [DatabaseName](#API_DescribeDatabase_RequestSyntax) **
The name of the Timestream database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
## Response Syntax
```
{
"Database": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Database](#API_DescribeDatabase_ResponseSyntax) **
The name of the Timestream table.
Type: [Database](API_Database.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeDatabase)
# DescribeEndpoints
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 (AWS PrivateLink) with Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints)
+ 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](https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery).
## Response Syntax
```
{
"Endpoints": [
{
"Address": "string",
"CachePeriodInMinutes": number
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Endpoints](#API_DescribeEndpoints_ResponseSyntax) **
An `Endpoints` object is returned when a `DescribeEndpoints` request is made.
Type: Array of [Endpoint](API_Endpoint.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeEndpoints)
# DescribeTable
Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html) for details.
## Request Syntax
```
{
"DatabaseName": "string",
"TableName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [DatabaseName](#API_DescribeTable_RequestSyntax) **
The name of the Timestream database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
** [TableName](#API_DescribeTable_RequestSyntax) **
The name of the Timestream table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
## Response Syntax
```
{
"Table": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string",
"TableStatus": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Table](#API_DescribeTable_ResponseSyntax) **
The Timestream table.
Type: [Table](API_Table.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeTable)
# ListBatchLoadTasks
Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html) for details.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "string",
"TaskStatus": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [MaxResults](#API_ListBatchLoadTasks_RequestSyntax) **
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListBatchLoadTasks_RequestSyntax) **
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
Required: No
** [TaskStatus](#API_ListBatchLoadTasks_RequestSyntax) **
Status of the batch load task.
Type: String
Valid Values: `CREATED | IN_PROGRESS | FAILED | SUCCEEDED | PROGRESS_STOPPED | PENDING_RESUME`
Required: No
## Response Syntax
```
{
"BatchLoadTasks": [
{
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"ResumableUntil": number,
"TableName": "string",
"TaskId": "string",
"TaskStatus": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BatchLoadTasks](#API_ListBatchLoadTasks_ResponseSyntax) **
A list of batch load task details.
Type: Array of [BatchLoadTask](API_BatchLoadTask.md) objects
** [NextToken](#API_ListBatchLoadTasks_ResponseSyntax) **
A token to specify where to start paginating. Provide the next ListBatchLoadTasksRequest.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListBatchLoadTasks)
# ListDatabases
Returns a list of your Timestream databases. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html) for details.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [MaxResults](#API_ListDatabases_RequestSyntax) **
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
** [NextToken](#API_ListDatabases_RequestSyntax) **
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Type: String
Required: No
## Response Syntax
```
{
"Databases": [
{
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Databases](#API_ListDatabases_ResponseSyntax) **
A list of database names.
Type: Array of [Database](API_Database.md) objects
** [NextToken](#API_ListDatabases_ResponseSyntax) **
The pagination token. This parameter is returned when the response is truncated.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListDatabases)
# ListTables
Provides a list of tables, along with the name, status, and retention properties of each table. See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html) for details.
## Request Syntax
```
{
"DatabaseName": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [DatabaseName](#API_ListTables_RequestSyntax) **
The name of the Timestream database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: No
** [MaxResults](#API_ListTables_RequestSyntax) **
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
** [NextToken](#API_ListTables_RequestSyntax) **
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Type: String
Required: No
## Response Syntax
```
{
"NextToken": "string",
"Tables": [
{
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string",
"TableStatus": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListTables_ResponseSyntax) **
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
** [Tables](#API_ListTables_ResponseSyntax) **
A list of tables.
Type: Array of [Table](API_Table.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListTables)
# ListTagsForResource
Lists all tags on a Timestream resource.
## Request Syntax
```
{
"ResourceARN": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **
The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
## Response Syntax
```
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Tags](#API_ListTagsForResource_ResponseSyntax) **
The tags currently associated with the Timestream resource.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListTagsForResource)
# ResumeBatchLoadTask
## Request Syntax
```
{
"TaskId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [TaskId](#API_ResumeBatchLoadTask_RequestSyntax) **
The ID of the batch load task to resume.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 32.
Pattern: `[A-Z0-9]+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ResumeBatchLoadTask)
# TagResource
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.
## Request Syntax
```
{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceARN](#API_TagResource_RequestSyntax) **
Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
** [Tags](#API_TagResource_RequestSyntax) **
The tags to be assigned to the Timestream resource.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ServiceQuotaExceededException **
The instance quota of resource exceeded for this account.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/TagResource)
# UntagResource
Removes the association of tags from a Timestream resource.
## Request Syntax
```
{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceARN](#API_UntagResource_RequestSyntax) **
The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
** [TagKeys](#API_UntagResource_RequestSyntax) **
A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ServiceQuotaExceededException **
The instance quota of resource exceeded for this account.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UntagResource)
# UpdateDatabase
Modifies the AWS KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new AWS KMS key to be used (`KmsKeyId`). If there are any concurrent `UpdateDatabase` requests, first writer wins.
See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html) for details.
## Request Syntax
```
{
"DatabaseName": "string",
"KmsKeyId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [DatabaseName](#API_UpdateDatabase_RequestSyntax) **
The name of the database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
** [KmsKeyId](#API_UpdateDatabase_RequestSyntax) **
The identifier of the new AWS KMS key (`KmsKeyId`) to be used to encrypt the data stored in the database. If the `KmsKeyId` currently registered with the database is the same as the `KmsKeyId` in the request, there will not be any update.
You can specify the `KmsKeyId` using any of the following:
+ Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
+ Key ARN: `arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ Alias name: `alias/ExampleAlias`
+ Alias ARN: `arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias`
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
## Response Syntax
```
{
"Database": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Database](#API_UpdateDatabase_ResponseSyntax) **
A top-level container for a table. Databases and tables are the fundamental management concepts in Amazon Timestream. All tables in a database are encrypted with the same AWS KMS key.
Type: [Database](API_Database.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ServiceQuotaExceededException **
The instance quota of resource exceeded for this account.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UpdateDatabase)
# UpdateTable
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](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html) for details.
## Request Syntax
```
{
"DatabaseName": "string",
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [DatabaseName](#API_UpdateTable_RequestSyntax) **
The name of the Timestream database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
** [MagneticStoreWriteProperties](#API_UpdateTable_RequestSyntax) **
Contains properties to set on the table when enabling magnetic store writes.
Type: [MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md) object
Required: No
** [RetentionProperties](#API_UpdateTable_RequestSyntax) **
The retention duration of the memory store and the magnetic store.
Type: [RetentionProperties](API_RetentionProperties.md) object
Required: No
** [Schema](#API_UpdateTable_RequestSyntax) **
The schema of the table.
Type: [Schema](API_Schema.md) object
Required: No
** [TableName](#API_UpdateTable_RequestSyntax) **
The name of the Timestream table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
## Response Syntax
```
{
"Table": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"MagneticStoreWriteProperties": {
"EnableMagneticStoreWrites": boolean,
"MagneticStoreRejectedDataLocation": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"KmsKeyId": "string",
"ObjectKeyPrefix": "string"
}
}
},
"RetentionProperties": {
"MagneticStoreRetentionPeriodInDays": number,
"MemoryStoreRetentionPeriodInHours": number
},
"Schema": {
"CompositePartitionKey": [
{
"EnforcementInRecord": "string",
"Name": "string",
"Type": "string"
}
]
},
"TableName": "string",
"TableStatus": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Table](#API_UpdateTable_ResponseSyntax) **
The updated Timestream table.
Type: [Table](API_Table.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UpdateTable)
# WriteRecords
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](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html).
See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html) 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`.
## Request Syntax
```
{
"CommonAttributes": {
"Dimensions": [
{
"DimensionValueType": "string",
"Name": "string",
"Value": "string"
}
],
"MeasureName": "string",
"MeasureValue": "string",
"MeasureValues": [
{
"Name": "string",
"Type": "string",
"Value": "string"
}
],
"MeasureValueType": "string",
"Time": "string",
"TimeUnit": "string",
"Version": number
},
"DatabaseName": "string",
"Records": [
{
"Dimensions": [
{
"DimensionValueType": "string",
"Name": "string",
"Value": "string"
}
],
"MeasureName": "string",
"MeasureValue": "string",
"MeasureValues": [
{
"Name": "string",
"Type": "string",
"Value": "string"
}
],
"MeasureValueType": "string",
"Time": "string",
"TimeUnit": "string",
"Version": number
}
],
"TableName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [CommonAttributes](#API_WriteRecords_RequestSyntax) **
A record that contains the common measure, dimension, time, and version attributes shared across all the records in the request. The measure and dimension attributes specified will be merged with the measure and dimension attributes in the records object when the data is written into Timestream. Dimensions may not overlap, or a `ValidationException` will be thrown. In other words, a record must contain dimensions with unique names.
Type: [Record](API_Record.md) object
Required: No
** [DatabaseName](#API_WriteRecords_RequestSyntax) **
The name of the Timestream database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
** [Records](#API_WriteRecords_RequestSyntax) **
An array of records that contain the unique measure, dimension, time, and version attributes for each time-series data point.
Type: Array of [Record](API_Record.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
** [TableName](#API_WriteRecords_RequestSyntax) **
The name of the Timestream table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Required: Yes
## Response Syntax
```
{
"RecordsIngested": {
"MagneticStore": number,
"MemoryStore": number,
"Total": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RecordsIngested](#API_WriteRecords_ResponseSyntax) **
Information on the records ingested by this request.
Type: [RecordsIngested](API_RecordsIngested.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You are not authorized to perform this action.
HTTP Status Code: 400
** InternalServerException **
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
** InvalidEndpointException **
The requested endpoint was not valid.
HTTP Status Code: 400
** 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](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) in the Amazon Timestream Developer Guide.
** RejectedRecords **
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
HTTP Status Code: 400
** ThrottlingException **
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
** ValidationException **
An invalid or malformed request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/WriteRecords)