/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / timestreamwrite.d.ts
timestreamwrite.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class TimestreamWrite extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: TimestreamWrite.Types.ClientConfiguration) 13 config: Config & TimestreamWrite.Types.ClientConfiguration; 14 /** 15 * 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. Refer to AWS managed KMS keys for more info. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. 16 */ 17 createDatabase(params: TimestreamWrite.Types.CreateDatabaseRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.CreateDatabaseResponse) => void): Request<TimestreamWrite.Types.CreateDatabaseResponse, AWSError>; 18 /** 19 * 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. Refer to AWS managed KMS keys for more info. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. 20 */ 21 createDatabase(callback?: (err: AWSError, data: TimestreamWrite.Types.CreateDatabaseResponse) => void): Request<TimestreamWrite.Types.CreateDatabaseResponse, AWSError>; 22 /** 23 * The CreateTable operation 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 may have identical table names in the same Region if the tables are in seperate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. 24 */ 25 createTable(params: TimestreamWrite.Types.CreateTableRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.CreateTableResponse) => void): Request<TimestreamWrite.Types.CreateTableResponse, AWSError>; 26 /** 27 * The CreateTable operation 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 may have identical table names in the same Region if the tables are in seperate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. 28 */ 29 createTable(callback?: (err: AWSError, data: TimestreamWrite.Types.CreateTableResponse) => void): Request<TimestreamWrite.Types.CreateTableResponse, AWSError>; 30 /** 31 * 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. 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. 32 */ 33 deleteDatabase(params: TimestreamWrite.Types.DeleteDatabaseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 34 /** 35 * 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. 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. 36 */ 37 deleteDatabase(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 38 /** 39 * 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. Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent. 40 */ 41 deleteTable(params: TimestreamWrite.Types.DeleteTableRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 42 /** 43 * 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. Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent. 44 */ 45 deleteTable(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 46 /** 47 * 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. For more information, see Access Management in the Timestream Developer Guide. 48 */ 49 describeDatabase(params: TimestreamWrite.Types.DescribeDatabaseRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.DescribeDatabaseResponse) => void): Request<TimestreamWrite.Types.DescribeDatabaseResponse, AWSError>; 50 /** 51 * 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. For more information, see Access Management in the Timestream Developer Guide. 52 */ 53 describeDatabase(callback?: (err: AWSError, data: TimestreamWrite.Types.DescribeDatabaseResponse) => void): Request<TimestreamWrite.Types.DescribeDatabaseResponse, AWSError>; 54 /** 55 * DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query. Because Timestream’s SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless: Your application uses a programming language that does not yet have SDK support You require better control over the client-side implementation For detailed information on how to use DescribeEndpoints, see The Endpoint Discovery Pattern and REST APIs. 56 */ 57 describeEndpoints(params: TimestreamWrite.Types.DescribeEndpointsRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.DescribeEndpointsResponse) => void): Request<TimestreamWrite.Types.DescribeEndpointsResponse, AWSError>; 58 /** 59 * DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query. Because Timestream’s SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless: Your application uses a programming language that does not yet have SDK support You require better control over the client-side implementation For detailed information on how to use DescribeEndpoints, see The Endpoint Discovery Pattern and REST APIs. 60 */ 61 describeEndpoints(callback?: (err: AWSError, data: TimestreamWrite.Types.DescribeEndpointsResponse) => void): Request<TimestreamWrite.Types.DescribeEndpointsResponse, AWSError>; 62 /** 63 * Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. 64 */ 65 describeTable(params: TimestreamWrite.Types.DescribeTableRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.DescribeTableResponse) => void): Request<TimestreamWrite.Types.DescribeTableResponse, AWSError>; 66 /** 67 * Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. 68 */ 69 describeTable(callback?: (err: AWSError, data: TimestreamWrite.Types.DescribeTableResponse) => void): Request<TimestreamWrite.Types.DescribeTableResponse, AWSError>; 70 /** 71 * Returns a list of your Timestream databases. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. 72 */ 73 listDatabases(params: TimestreamWrite.Types.ListDatabasesRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.ListDatabasesResponse) => void): Request<TimestreamWrite.Types.ListDatabasesResponse, AWSError>; 74 /** 75 * Returns a list of your Timestream databases. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. 76 */ 77 listDatabases(callback?: (err: AWSError, data: TimestreamWrite.Types.ListDatabasesResponse) => void): Request<TimestreamWrite.Types.ListDatabasesResponse, AWSError>; 78 /** 79 * A list of tables, along with the name, status and retention properties of each table. 80 */ 81 listTables(params: TimestreamWrite.Types.ListTablesRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.ListTablesResponse) => void): Request<TimestreamWrite.Types.ListTablesResponse, AWSError>; 82 /** 83 * A list of tables, along with the name, status and retention properties of each table. 84 */ 85 listTables(callback?: (err: AWSError, data: TimestreamWrite.Types.ListTablesResponse) => void): Request<TimestreamWrite.Types.ListTablesResponse, AWSError>; 86 /** 87 * List all tags on a Timestream resource. 88 */ 89 listTagsForResource(params: TimestreamWrite.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.ListTagsForResourceResponse) => void): Request<TimestreamWrite.Types.ListTagsForResourceResponse, AWSError>; 90 /** 91 * List all tags on a Timestream resource. 92 */ 93 listTagsForResource(callback?: (err: AWSError, data: TimestreamWrite.Types.ListTagsForResourceResponse) => void): Request<TimestreamWrite.Types.ListTagsForResourceResponse, AWSError>; 94 /** 95 * Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. 96 */ 97 tagResource(params: TimestreamWrite.Types.TagResourceRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.TagResourceResponse) => void): Request<TimestreamWrite.Types.TagResourceResponse, AWSError>; 98 /** 99 * Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. 100 */ 101 tagResource(callback?: (err: AWSError, data: TimestreamWrite.Types.TagResourceResponse) => void): Request<TimestreamWrite.Types.TagResourceResponse, AWSError>; 102 /** 103 * Removes the association of tags from a Timestream resource. 104 */ 105 untagResource(params: TimestreamWrite.Types.UntagResourceRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.UntagResourceResponse) => void): Request<TimestreamWrite.Types.UntagResourceResponse, AWSError>; 106 /** 107 * Removes the association of tags from a Timestream resource. 108 */ 109 untagResource(callback?: (err: AWSError, data: TimestreamWrite.Types.UntagResourceResponse) => void): Request<TimestreamWrite.Types.UntagResourceResponse, AWSError>; 110 /** 111 * 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. 112 */ 113 updateDatabase(params: TimestreamWrite.Types.UpdateDatabaseRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.UpdateDatabaseResponse) => void): Request<TimestreamWrite.Types.UpdateDatabaseResponse, AWSError>; 114 /** 115 * 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. 116 */ 117 updateDatabase(callback?: (err: AWSError, data: TimestreamWrite.Types.UpdateDatabaseResponse) => void): Request<TimestreamWrite.Types.UpdateDatabaseResponse, AWSError>; 118 /** 119 * 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. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. 120 */ 121 updateTable(params: TimestreamWrite.Types.UpdateTableRequest, callback?: (err: AWSError, data: TimestreamWrite.Types.UpdateTableResponse) => void): Request<TimestreamWrite.Types.UpdateTableResponse, AWSError>; 122 /** 123 * 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. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. 124 */ 125 updateTable(callback?: (err: AWSError, data: TimestreamWrite.Types.UpdateTableResponse) => void): Request<TimestreamWrite.Types.UpdateTableResponse, AWSError>; 126 /** 127 * The WriteRecords operation 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 with 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 support 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. For more information, see Access Management in the Timestream Developer Guide. 128 */ 129 writeRecords(params: TimestreamWrite.Types.WriteRecordsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 130 /** 131 * The WriteRecords operation 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 with 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 support 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. For more information, see Access Management in the Timestream Developer Guide. 132 */ 133 writeRecords(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 134 } 135 declare namespace TimestreamWrite { 136 export type AmazonResourceName = string; 137 export interface CreateDatabaseRequest { 138 /** 139 * The name of the Timestream database. 140 */ 141 DatabaseName: ResourceName; 142 /** 143 * The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. Refer to AWS managed KMS keys for more info. 144 */ 145 KmsKeyId?: StringValue2048; 146 /** 147 * A list of key-value pairs to label the table. 148 */ 149 Tags?: TagList; 150 } 151 export interface CreateDatabaseResponse { 152 /** 153 * The newly created Timestream database. 154 */ 155 Database?: Database; 156 } 157 export interface CreateTableRequest { 158 /** 159 * The name of the Timestream database. 160 */ 161 DatabaseName: ResourceName; 162 /** 163 * The name of the Timestream table. 164 */ 165 TableName: ResourceName; 166 /** 167 * The duration for which your time series data must be stored in the memory store and the magnetic store. 168 */ 169 RetentionProperties?: RetentionProperties; 170 /** 171 * A list of key-value pairs to label the table. 172 */ 173 Tags?: TagList; 174 } 175 export interface CreateTableResponse { 176 /** 177 * The newly created Timestream table. 178 */ 179 Table?: Table; 180 } 181 export interface Database { 182 /** 183 * The Amazon Resource Name that uniquely identifies this database. 184 */ 185 Arn?: String; 186 /** 187 * The name of the Timestream database. 188 */ 189 DatabaseName?: ResourceName; 190 /** 191 * The total number of tables found within a Timestream database. 192 */ 193 TableCount?: Long; 194 /** 195 * The identifier of the KMS key used to encrypt the data stored in the database. 196 */ 197 KmsKeyId?: StringValue2048; 198 /** 199 * The time when the database was created, calculated from the Unix epoch time. 200 */ 201 CreationTime?: _Date; 202 /** 203 * The last time that this database was updated. 204 */ 205 LastUpdatedTime?: _Date; 206 } 207 export type DatabaseList = Database[]; 208 export type _Date = Date; 209 export interface DeleteDatabaseRequest { 210 /** 211 * The name of the Timestream database to be deleted. 212 */ 213 DatabaseName: ResourceName; 214 } 215 export interface DeleteTableRequest { 216 /** 217 * The name of the database where the Timestream database is to be deleted. 218 */ 219 DatabaseName: ResourceName; 220 /** 221 * The name of the Timestream table to be deleted. 222 */ 223 TableName: ResourceName; 224 } 225 export interface DescribeDatabaseRequest { 226 /** 227 * The name of the Timestream database. 228 */ 229 DatabaseName: ResourceName; 230 } 231 export interface DescribeDatabaseResponse { 232 /** 233 * The name of the Timestream table. 234 */ 235 Database?: Database; 236 } 237 export interface DescribeEndpointsRequest { 238 } 239 export interface DescribeEndpointsResponse { 240 /** 241 * An Endpoints object is returned when a DescribeEndpoints request is made. 242 */ 243 Endpoints: Endpoints; 244 } 245 export interface DescribeTableRequest { 246 /** 247 * The name of the Timestream database. 248 */ 249 DatabaseName: ResourceName; 250 /** 251 * The name of the Timestream table. 252 */ 253 TableName: ResourceName; 254 } 255 export interface DescribeTableResponse { 256 /** 257 * The Timestream table. 258 */ 259 Table?: Table; 260 } 261 export interface Dimension { 262 /** 263 * Dimension represents the meta data attributes of the time series. For example, the name and availability zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions. For constraints on Dimension names, see Naming Constraints. 264 */ 265 Name: StringValue256; 266 /** 267 * The value of the dimension. 268 */ 269 Value: StringValue2048; 270 /** 271 * The data type of the dimension for the time series data point. 272 */ 273 DimensionValueType?: DimensionValueType; 274 } 275 export type DimensionValueType = "VARCHAR"|string; 276 export type Dimensions = Dimension[]; 277 export interface Endpoint { 278 /** 279 * An endpoint address. 280 */ 281 Address: String; 282 /** 283 * The TTL for the endpoint, in minutes. 284 */ 285 CachePeriodInMinutes: Long; 286 } 287 export type Endpoints = Endpoint[]; 288 export interface ListDatabasesRequest { 289 /** 290 * The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation. 291 */ 292 NextToken?: String; 293 /** 294 * 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. 295 */ 296 MaxResults?: PaginationLimit; 297 } 298 export interface ListDatabasesResponse { 299 /** 300 * A list of database names. 301 */ 302 Databases?: DatabaseList; 303 /** 304 * The pagination token. This parameter is returned when the response is truncated. 305 */ 306 NextToken?: String; 307 } 308 export interface ListTablesRequest { 309 /** 310 * The name of the Timestream database. 311 */ 312 DatabaseName?: ResourceName; 313 /** 314 * The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation. 315 */ 316 NextToken?: String; 317 /** 318 * 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. 319 */ 320 MaxResults?: PaginationLimit; 321 } 322 export interface ListTablesResponse { 323 /** 324 * A list of tables. 325 */ 326 Tables?: TableList; 327 /** 328 * A token to specify where to start paginating. This is the NextToken from a previously truncated response. 329 */ 330 NextToken?: String; 331 } 332 export interface ListTagsForResourceRequest { 333 /** 334 * The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN). 335 */ 336 ResourceARN: AmazonResourceName; 337 } 338 export interface ListTagsForResourceResponse { 339 /** 340 * The tags currently associated with the Timestream resource. 341 */ 342 Tags?: TagList; 343 } 344 export type Long = number; 345 export type MagneticStoreRetentionPeriodInDays = number; 346 export type MeasureValueType = "DOUBLE"|"BIGINT"|"VARCHAR"|"BOOLEAN"|string; 347 export type MemoryStoreRetentionPeriodInHours = number; 348 export type PaginationLimit = number; 349 export interface Record { 350 /** 351 * Contains the list of dimensions for time series data points. 352 */ 353 Dimensions?: Dimensions; 354 /** 355 * Measure represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures. 356 */ 357 MeasureName?: StringValue256; 358 /** 359 * Contains the measure value for the time series data point. 360 */ 361 MeasureValue?: StringValue2048; 362 /** 363 * Contains the data type of the measure value for the time series data point. 364 */ 365 MeasureValueType?: MeasureValueType; 366 /** 367 * Contains the time at which the measure value for the data point was collected. The time value plus the unit provides the time elapsed since the epoch. For example, if the time value is 12345 and the unit is ms, then 12345 ms have elapsed since the epoch. 368 */ 369 Time?: StringValue256; 370 /** 371 * The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values. 372 */ 373 TimeUnit?: TimeUnit; 374 /** 375 * 64-bit attribute used for record updates. Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated . Default value is to 1. 376 */ 377 Version?: RecordVersion; 378 } 379 export type RecordVersion = number; 380 export type Records = Record[]; 381 export type ResourceName = string; 382 export interface RetentionProperties { 383 /** 384 * The duration for which data must be stored in the memory store. 385 */ 386 MemoryStoreRetentionPeriodInHours: MemoryStoreRetentionPeriodInHours; 387 /** 388 * The duration for which data must be stored in the magnetic store. 389 */ 390 MagneticStoreRetentionPeriodInDays: MagneticStoreRetentionPeriodInDays; 391 } 392 export type String = string; 393 export type StringValue2048 = string; 394 export type StringValue256 = string; 395 export interface Table { 396 /** 397 * The Amazon Resource Name that uniquely identifies this table. 398 */ 399 Arn?: String; 400 /** 401 * The name of the Timestream table. 402 */ 403 TableName?: ResourceName; 404 /** 405 * The name of the Timestream database that contains this table. 406 */ 407 DatabaseName?: ResourceName; 408 /** 409 * The current state of the table: DELETING - The table is being deleted. ACTIVE - The table is ready for use. 410 */ 411 TableStatus?: TableStatus; 412 /** 413 * The retention duration for the memory store and magnetic store. 414 */ 415 RetentionProperties?: RetentionProperties; 416 /** 417 * The time when the Timestream table was created. 418 */ 419 CreationTime?: _Date; 420 /** 421 * The time when the Timestream table was last updated. 422 */ 423 LastUpdatedTime?: _Date; 424 } 425 export type TableList = Table[]; 426 export type TableStatus = "ACTIVE"|"DELETING"|string; 427 export interface Tag { 428 /** 429 * The key of the tag. Tag keys are case sensitive. 430 */ 431 Key: TagKey; 432 /** 433 * The value of the tag. Tag values are case-sensitive and can be null. 434 */ 435 Value: TagValue; 436 } 437 export type TagKey = string; 438 export type TagKeyList = TagKey[]; 439 export type TagList = Tag[]; 440 export interface TagResourceRequest { 441 /** 442 * Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN). 443 */ 444 ResourceARN: AmazonResourceName; 445 /** 446 * The tags to be assigned to the Timestream resource. 447 */ 448 Tags: TagList; 449 } 450 export interface TagResourceResponse { 451 } 452 export type TagValue = string; 453 export type TimeUnit = "MILLISECONDS"|"SECONDS"|"MICROSECONDS"|"NANOSECONDS"|string; 454 export interface UntagResourceRequest { 455 /** 456 * The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN). 457 */ 458 ResourceARN: AmazonResourceName; 459 /** 460 * A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource. 461 */ 462 TagKeys: TagKeyList; 463 } 464 export interface UntagResourceResponse { 465 } 466 export interface UpdateDatabaseRequest { 467 /** 468 * The name of the database. 469 */ 470 DatabaseName: ResourceName; 471 /** 472 * The identifier of the new 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 473 */ 474 KmsKeyId: StringValue2048; 475 } 476 export interface UpdateDatabaseResponse { 477 Database?: Database; 478 } 479 export interface UpdateTableRequest { 480 /** 481 * The name of the Timestream database. 482 */ 483 DatabaseName: ResourceName; 484 /** 485 * The name of the Timesream table. 486 */ 487 TableName: ResourceName; 488 /** 489 * The retention duration of the memory store and the magnetic store. 490 */ 491 RetentionProperties: RetentionProperties; 492 } 493 export interface UpdateTableResponse { 494 /** 495 * The updated Timestream table. 496 */ 497 Table?: Table; 498 } 499 export interface WriteRecordsRequest { 500 /** 501 * The name of the Timestream database. 502 */ 503 DatabaseName: ResourceName; 504 /** 505 * The name of the Timesream table. 506 */ 507 TableName: ResourceName; 508 /** 509 * A record containing the common measure and dimension attributes shared across all the records in the request. The measure and dimension attributes specified in here will be merged with the measure and dimension attributes in the records object when the data is written into Timestream. 510 */ 511 CommonAttributes?: Record; 512 /** 513 * An array of records containing the unique dimension and measure attributes for each time series data point. 514 */ 515 Records: Records; 516 } 517 /** 518 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 519 */ 520 export type apiVersion = "2018-11-01"|"latest"|string; 521 export interface ClientApiVersions { 522 /** 523 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 524 */ 525 apiVersion?: apiVersion; 526 } 527 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 528 /** 529 * Contains interfaces for use with the TimestreamWrite client. 530 */ 531 export import Types = TimestreamWrite; 532 } 533 export = TimestreamWrite;