{
"smithy": "2.0",
"shapes": {
"com.amazonaws.timestreamwrite#AccessDeniedException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamwrite#ErrorMessage",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>You are not authorized to perform this action.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 403
}
},
"com.amazonaws.timestreamwrite#AmazonResourceName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1011
}
}
},
"com.amazonaws.timestreamwrite#BatchLoadDataFormat": {
"type": "enum",
"members": {
"CSV": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CSV"
}
}
}
},
"com.amazonaws.timestreamwrite#BatchLoadProgressReport": {
"type": "structure",
"members": {
"RecordsProcessed": {
"target": "com.amazonaws.timestreamwrite#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p></p>"
}
},
"RecordsIngested": {
"target": "com.amazonaws.timestreamwrite#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p></p>"
}
},
"ParseFailures": {
"target": "com.amazonaws.timestreamwrite#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p></p>"
}
},
"RecordIngestionFailures": {
"target": "com.amazonaws.timestreamwrite#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p></p>"
}
},
"FileFailures": {
"target": "com.amazonaws.timestreamwrite#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p></p>"
}
},
"BytesMetered": {
"target": "com.amazonaws.timestreamwrite#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p></p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details about the progress of a batch load task.</p>"
}
},
"com.amazonaws.timestreamwrite#BatchLoadStatus": {
"type": "enum",
"members": {
"CREATED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CREATED"
}
},
"IN_PROGRESS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "IN_PROGRESS"
}
},
"FAILED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "FAILED"
}
},
"SUCCEEDED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SUCCEEDED"
}
},
"PROGRESS_STOPPED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PROGRESS_STOPPED"
}
},
"PENDING_RESUME": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PENDING_RESUME"
}
}
}
},
"com.amazonaws.timestreamwrite#BatchLoadTask": {
"type": "structure",
"members": {
"TaskId": {
"target": "com.amazonaws.timestreamwrite#BatchLoadTaskId",
"traits": {
"smithy.api#documentation": "<p>The ID of the batch load task.</p>"
}
},
"TaskStatus": {
"target": "com.amazonaws.timestreamwrite#BatchLoadStatus",
"traits": {
"smithy.api#documentation": "<p>Status of the batch load task.</p>"
}
},
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>Database name for the database into which a batch load task loads data.</p>"
}
},
"TableName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>Table name for the table into which a batch load task loads data.</p>"
}
},
"CreationTime": {
"target": "com.amazonaws.timestreamwrite#Date",
"traits": {
"smithy.api#documentation": "<p>The time when the Timestream batch load task was created.</p>"
}
},
"LastUpdatedTime": {
"target": "com.amazonaws.timestreamwrite#Date",
"traits": {
"smithy.api#documentation": "<p>The time when the Timestream batch load task was last updated.</p>"
}
},
"ResumableUntil": {
"target": "com.amazonaws.timestreamwrite#Date",
"traits": {
"smithy.api#documentation": "<p>\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details about a batch load task.</p>"
}
},
"com.amazonaws.timestreamwrite#BatchLoadTaskDescription": {
"type": "structure",
"members": {
"TaskId": {
"target": "com.amazonaws.timestreamwrite#BatchLoadTaskId",
"traits": {
"smithy.api#documentation": "<p>The ID of the batch load task.</p>"
}
},
"ErrorMessage": {
"target": "com.amazonaws.timestreamwrite#StringValue2048",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"DataSourceConfiguration": {
"target": "com.amazonaws.timestreamwrite#DataSourceConfiguration",
"traits": {
"smithy.api#documentation": "<p>Configuration details about the data source for a batch load task.</p>"
}
},
"ProgressReport": {
"target": "com.amazonaws.timestreamwrite#BatchLoadProgressReport",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"ReportConfiguration": {
"target": "com.amazonaws.timestreamwrite#ReportConfiguration",
"traits": {
"smithy.api#documentation": "<p>Report configuration for a batch load task. This contains details about where error\n reports are stored.</p>"
}
},
"DataModelConfiguration": {
"target": "com.amazonaws.timestreamwrite#DataModelConfiguration",
"traits": {
"smithy.api#documentation": "<p>Data model configuration for a batch load task. This contains details about where a data\n model for a batch load task is stored.</p>"
}
},
"TargetDatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"TargetTableName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"TaskStatus": {
"target": "com.amazonaws.timestreamwrite#BatchLoadStatus",
"traits": {
"smithy.api#documentation": "<p>Status of the batch load task.</p>"
}
},
"RecordVersion": {
"target": "com.amazonaws.timestreamwrite#RecordVersion",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p></p>"
}
},
"CreationTime": {
"target": "com.amazonaws.timestreamwrite#Date",
"traits": {
"smithy.api#documentation": "<p>The time when the Timestream batch load task was created.</p>"
}
},
"LastUpdatedTime": {
"target": "com.amazonaws.timestreamwrite#Date",
"traits": {
"smithy.api#documentation": "<p>The time when the Timestream batch load task was last updated.</p>"
}
},
"ResumableUntil": {
"target": "com.amazonaws.timestreamwrite#Date",
"traits": {
"smithy.api#documentation": "<p>\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details about a batch load task.</p>"
}
},
"com.amazonaws.timestreamwrite#BatchLoadTaskId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 3,
"max": 32
},
"smithy.api#pattern": "^[A-Z0-9]+$"
}
},
"com.amazonaws.timestreamwrite#BatchLoadTaskList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#BatchLoadTask"
}
},
"com.amazonaws.timestreamwrite#Boolean": {
"type": "boolean"
},
"com.amazonaws.timestreamwrite#ClientRequestToken": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 64
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.timestreamwrite#ConflictException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamwrite#ErrorMessage",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Timestream was unable to process this request because it contains resource that\n already exists.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.timestreamwrite#CreateBatchLoadTask": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#CreateBatchLoadTaskRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#CreateBatchLoadTaskResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#ConflictException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Creates a new Timestream batch load task. A batch load task processes data from\n a CSV source in an S3 location and writes to a Timestream table. A mapping from\n source to target is defined in a batch load task. Errors and events are written to a report\n at an S3 location. For the report, if the KMS key is not specified, the\n report will be encrypted with an S3 managed key when <code>SSE_S3</code> is the option.\n Otherwise an error is thrown. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed\n keys</a>. <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Service quotas apply</a>. For\n details, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html\">code\n sample</a>.</p>"
}
},
"com.amazonaws.timestreamwrite#CreateBatchLoadTaskRequest": {
"type": "structure",
"members": {
"ClientToken": {
"target": "com.amazonaws.timestreamwrite#ClientRequestToken",
"traits": {
"smithy.api#documentation": "<p></p>",
"smithy.api#idempotencyToken": {}
}
},
"DataModelConfiguration": {
"target": "com.amazonaws.timestreamwrite#DataModelConfiguration"
},
"DataSourceConfiguration": {
"target": "com.amazonaws.timestreamwrite#DataSourceConfiguration",
"traits": {
"smithy.api#documentation": "<p>Defines configuration details about the data source for a batch load task.</p>",
"smithy.api#required": {}
}
},
"ReportConfiguration": {
"target": "com.amazonaws.timestreamwrite#ReportConfiguration",
"traits": {
"smithy.api#required": {}
}
},
"TargetDatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceCreateAPIName",
"traits": {
"smithy.api#documentation": "<p>Target Timestream database for a batch load task.</p>",
"smithy.api#required": {}
}
},
"TargetTableName": {
"target": "com.amazonaws.timestreamwrite#ResourceCreateAPIName",
"traits": {
"smithy.api#documentation": "<p>Target Timestream table for a batch load task.</p>",
"smithy.api#required": {}
}
},
"RecordVersion": {
"target": "com.amazonaws.timestreamwrite#RecordVersion",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p></p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#CreateBatchLoadTaskResponse": {
"type": "structure",
"members": {
"TaskId": {
"target": "com.amazonaws.timestreamwrite#BatchLoadTaskId",
"traits": {
"smithy.api#documentation": "<p>The ID of the batch load task.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#CreateDatabase": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#CreateDatabaseRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#CreateDatabaseResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#ConflictException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Creates a new Timestream database. If the KMS key is not\n specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed keys</a>. <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Service quotas apply</a>. For\n details, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html\">code sample</a>.\n </p>"
}
},
"com.amazonaws.timestreamwrite#CreateDatabaseRequest": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceCreateAPIName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream database.</p>",
"smithy.api#required": {}
}
},
"KmsKeyId": {
"target": "com.amazonaws.timestreamwrite#StringValue2048",
"traits": {
"smithy.api#documentation": "<p>The KMS key for the database. If the KMS key is not\n specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed keys</a>.</p>"
}
},
"Tags": {
"target": "com.amazonaws.timestreamwrite#TagList",
"traits": {
"smithy.api#documentation": "<p> A list of key-value pairs to label the table. </p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#CreateDatabaseResponse": {
"type": "structure",
"members": {
"Database": {
"target": "com.amazonaws.timestreamwrite#Database",
"traits": {
"smithy.api#documentation": "<p>The newly created Timestream database.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#CreateTable": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#CreateTableRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#CreateTableResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#ConflictException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same\n database. You might have identical table names in the same Region if the tables are in\n separate databases. While creating the table, you must specify the table name, database\n name, and the retention properties. <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Service quotas apply</a>. See\n <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html\">code\n sample</a> for details. </p>"
}
},
"com.amazonaws.timestreamwrite#CreateTableRequest": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceCreateAPIName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream database.</p>",
"smithy.api#required": {}
}
},
"TableName": {
"target": "com.amazonaws.timestreamwrite#ResourceCreateAPIName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream table.</p>",
"smithy.api#required": {}
}
},
"RetentionProperties": {
"target": "com.amazonaws.timestreamwrite#RetentionProperties",
"traits": {
"smithy.api#documentation": "<p>The duration for which your time-series data must be stored in the memory store and the\n magnetic store.</p>"
}
},
"Tags": {
"target": "com.amazonaws.timestreamwrite#TagList",
"traits": {
"smithy.api#documentation": "<p> A list of key-value pairs to label the table. </p>"
}
},
"MagneticStoreWriteProperties": {
"target": "com.amazonaws.timestreamwrite#MagneticStoreWriteProperties",
"traits": {
"smithy.api#documentation": "<p>Contains properties to set on the table when enabling magnetic store writes.</p>"
}
},
"Schema": {
"target": "com.amazonaws.timestreamwrite#Schema",
"traits": {
"smithy.api#documentation": "<p> The schema of the table. </p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#CreateTableResponse": {
"type": "structure",
"members": {
"Table": {
"target": "com.amazonaws.timestreamwrite#Table",
"traits": {
"smithy.api#documentation": "<p>The newly created Timestream table.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#CsvConfiguration": {
"type": "structure",
"members": {
"ColumnSeparator": {
"target": "com.amazonaws.timestreamwrite#StringValue1",
"traits": {
"smithy.api#documentation": "<p>Column separator can be one of comma (','), pipe ('|), semicolon (';'), tab('/t'), or\n blank space (' '). </p>"
}
},
"EscapeChar": {
"target": "com.amazonaws.timestreamwrite#StringValue1",
"traits": {
"smithy.api#documentation": "<p>Escape character can be one of </p>"
}
},
"QuoteChar": {
"target": "com.amazonaws.timestreamwrite#StringValue1",
"traits": {
"smithy.api#documentation": "<p>Can be single quote (') or double quote (\").</p>"
}
},
"NullValue": {
"target": "com.amazonaws.timestreamwrite#StringValue256",
"traits": {
"smithy.api#documentation": "<p>Can be blank space (' ').</p>"
}
},
"TrimWhiteSpace": {
"target": "com.amazonaws.timestreamwrite#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies to trim leading and trailing white space.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A delimited data format where the column separator can be a comma and the record\n separator is a newline character.</p>"
}
},
"com.amazonaws.timestreamwrite#DataModel": {
"type": "structure",
"members": {
"TimeColumn": {
"target": "com.amazonaws.timestreamwrite#StringValue256",
"traits": {
"smithy.api#documentation": "<p>Source column to be mapped to time.</p>"
}
},
"TimeUnit": {
"target": "com.amazonaws.timestreamwrite#TimeUnit",
"traits": {
"smithy.api#documentation": "<p> The granularity of the timestamp unit. It indicates if the time value is in seconds,\n milliseconds, nanoseconds, or other supported values. Default is <code>MILLISECONDS</code>.\n </p>"
}
},
"DimensionMappings": {
"target": "com.amazonaws.timestreamwrite#DimensionMappings",
"traits": {
"smithy.api#documentation": "<p>Source to target mappings for dimensions.</p>",
"smithy.api#required": {}
}
},
"MultiMeasureMappings": {
"target": "com.amazonaws.timestreamwrite#MultiMeasureMappings",
"traits": {
"smithy.api#documentation": "<p>Source to target mappings for multi-measure records.</p>"
}
},
"MixedMeasureMappings": {
"target": "com.amazonaws.timestreamwrite#MixedMeasureMappingList",
"traits": {
"smithy.api#documentation": "<p>Source to target mappings for measures.</p>"
}
},
"MeasureNameColumn": {
"target": "com.amazonaws.timestreamwrite#StringValue256",
"traits": {
"smithy.api#documentation": "<p></p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Data model for a batch load task.</p>"
}
},
"com.amazonaws.timestreamwrite#DataModelConfiguration": {
"type": "structure",
"members": {
"DataModel": {
"target": "com.amazonaws.timestreamwrite#DataModel",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"DataModelS3Configuration": {
"target": "com.amazonaws.timestreamwrite#DataModelS3Configuration",
"traits": {
"smithy.api#documentation": "<p></p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"com.amazonaws.timestreamwrite#DataModelS3Configuration": {
"type": "structure",
"members": {
"BucketName": {
"target": "com.amazonaws.timestreamwrite#S3BucketName",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"ObjectKey": {
"target": "com.amazonaws.timestreamwrite#S3ObjectKey",
"traits": {
"smithy.api#documentation": "<p></p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"com.amazonaws.timestreamwrite#DataSourceConfiguration": {
"type": "structure",
"members": {
"DataSourceS3Configuration": {
"target": "com.amazonaws.timestreamwrite#DataSourceS3Configuration",
"traits": {
"smithy.api#documentation": "<p>Configuration of an S3 location for a file which contains data to load.</p>",
"smithy.api#required": {}
}
},
"CsvConfiguration": {
"target": "com.amazonaws.timestreamwrite#CsvConfiguration"
},
"DataFormat": {
"target": "com.amazonaws.timestreamwrite#BatchLoadDataFormat",
"traits": {
"smithy.api#documentation": "<p>This is currently CSV.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Defines configuration details about the data source.</p>"
}
},
"com.amazonaws.timestreamwrite#DataSourceS3Configuration": {
"type": "structure",
"members": {
"BucketName": {
"target": "com.amazonaws.timestreamwrite#S3BucketName",
"traits": {
"smithy.api#documentation": "<p>The bucket name of the customer S3 bucket.</p>",
"smithy.api#required": {}
}
},
"ObjectKeyPrefix": {
"target": "com.amazonaws.timestreamwrite#S3ObjectKey",
"traits": {
"smithy.api#documentation": "<p>\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>\n </p>"
}
},
"com.amazonaws.timestreamwrite#Database": {
"type": "structure",
"members": {
"Arn": {
"target": "com.amazonaws.timestreamwrite#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name that uniquely identifies this database.</p>"
}
},
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream database.</p>"
}
},
"TableCount": {
"target": "com.amazonaws.timestreamwrite#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The total number of tables found within a Timestream database. </p>"
}
},
"KmsKeyId": {
"target": "com.amazonaws.timestreamwrite#StringValue2048",
"traits": {
"smithy.api#documentation": "<p>The identifier of the KMS key used to encrypt the data stored in the\n database.</p>"
}
},
"CreationTime": {
"target": "com.amazonaws.timestreamwrite#Date",
"traits": {
"smithy.api#documentation": "<p>The time when the database was created, calculated from the Unix epoch time.</p>"
}
},
"LastUpdatedTime": {
"target": "com.amazonaws.timestreamwrite#Date",
"traits": {
"smithy.api#documentation": "<p> The last time that this database was updated. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A top-level container for a table. Databases and tables are the fundamental management\n concepts in Amazon Timestream. All tables in a database are encrypted with the\n same KMS key.</p>"
}
},
"com.amazonaws.timestreamwrite#DatabaseList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#Database"
}
},
"com.amazonaws.timestreamwrite#Date": {
"type": "timestamp"
},
"com.amazonaws.timestreamwrite#DeleteDatabase": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#DeleteDatabaseRequest"
},
"output": {
"target": "smithy.api#Unit"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Deletes a given Timestream database. <i>This is an irreversible\n operation. After a database is deleted, the time-series data from its tables cannot be\n recovered.</i>\n </p>\n <note>\n <p>All tables in the database must be deleted first, or a ValidationException error will\n be thrown. </p>\n <p>Due to the nature of distributed retries, the operation can return either success or\n a ResourceNotFoundException. Clients should consider them equivalent.</p>\n </note>\n <p>See <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html\">code sample</a>\n for details.</p>"
}
},
"com.amazonaws.timestreamwrite#DeleteDatabaseRequest": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream database to be deleted.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#DeleteTable": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#DeleteTableRequest"
},
"output": {
"target": "smithy.api#Unit"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Deletes a given Timestream table. This is an irreversible operation. After a\n Timestream database table is deleted, the time-series data stored in the table\n cannot be recovered. </p>\n <note>\n <p>Due to the nature of distributed retries, the operation can return either success or\n a ResourceNotFoundException. Clients should consider them equivalent.</p>\n </note>\n <p>See <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html\">code\n sample</a> for details.</p>"
}
},
"com.amazonaws.timestreamwrite#DeleteTableRequest": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the database where the Timestream database is to be deleted.</p>",
"smithy.api#required": {}
}
},
"TableName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream table to be deleted.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#DescribeBatchLoadTask": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#DescribeBatchLoadTaskRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#DescribeBatchLoadTaskResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Returns information about the batch load task, including configurations, mappings,\n progress, and other details. <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Service quotas apply</a>. See\n <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html\">code\n sample</a> for details.</p>"
}
},
"com.amazonaws.timestreamwrite#DescribeBatchLoadTaskRequest": {
"type": "structure",
"members": {
"TaskId": {
"target": "com.amazonaws.timestreamwrite#BatchLoadTaskId",
"traits": {
"smithy.api#documentation": "<p>The ID of the batch load task.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#DescribeBatchLoadTaskResponse": {
"type": "structure",
"members": {
"BatchLoadTaskDescription": {
"target": "com.amazonaws.timestreamwrite#BatchLoadTaskDescription",
"traits": {
"smithy.api#documentation": "<p>Description of the batch load task.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#DescribeDatabase": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#DescribeDatabaseRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#DescribeDatabaseResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Returns information about the database, including the database name, time that the\n database was created, and the total number of tables found within the database. <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Service\n quotas apply</a>. See <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html\">code sample</a>\n for details.</p>"
}
},
"com.amazonaws.timestreamwrite#DescribeDatabaseRequest": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream database.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#DescribeDatabaseResponse": {
"type": "structure",
"members": {
"Database": {
"target": "com.amazonaws.timestreamwrite#Database",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream table.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#DescribeEndpoints": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#DescribeEndpointsRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#DescribeEndpointsResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of available endpoints to make Timestream API calls against.\n This API operation is available through both the Write and Query APIs.</p>\n <p>Because the Timestream SDKs are designed to transparently work with the\n service\u2019s architecture, including the management and mapping of the service endpoints,\n <i>we don't recommend that you use this API operation unless</i>:</p>\n <ul>\n <li>\n <p>You are using <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints\">VPC endpoints (Amazon Web Services PrivateLink) with Timestream</a>\n </p>\n </li>\n <li>\n <p>Your application uses a programming language that does not yet have SDK\n support</p>\n </li>\n <li>\n <p>You require better control over the client-side implementation</p>\n </li>\n </ul>\n <p>For detailed information on how and when to use and implement DescribeEndpoints, see\n <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery\">The\n Endpoint Discovery Pattern</a>.</p>"
}
},
"com.amazonaws.timestreamwrite#DescribeEndpointsRequest": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#DescribeEndpointsResponse": {
"type": "structure",
"members": {
"Endpoints": {
"target": "com.amazonaws.timestreamwrite#Endpoints",
"traits": {
"smithy.api#documentation": "<p>An <code>Endpoints</code> object is returned when a <code>DescribeEndpoints</code>\n request is made.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#DescribeTable": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#DescribeTableRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#DescribeTableResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Returns information about the table, including the table name, database name, retention\n duration of the memory store and the magnetic store. <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Service quotas apply</a>. See\n <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html\">code\n sample</a> for details. </p>"
}
},
"com.amazonaws.timestreamwrite#DescribeTableRequest": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream database.</p>",
"smithy.api#required": {}
}
},
"TableName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream table.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#DescribeTableResponse": {
"type": "structure",
"members": {
"Table": {
"target": "com.amazonaws.timestreamwrite#Table",
"traits": {
"smithy.api#documentation": "<p>The Timestream table.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#Dimension": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p> Dimension represents the metadata attributes of the time series. For example, the name\n and Availability Zone of an EC2 instance or the name of the manufacturer of a wind turbine\n are dimensions. </p>\n <p>For constraints on dimension names, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming\">Naming\n Constraints</a>.</p>",
"smithy.api#required": {}
}
},
"Value": {
"target": "com.amazonaws.timestreamwrite#SchemaValue",
"traits": {
"smithy.api#documentation": "<p>The value of the dimension.</p>",
"smithy.api#required": {}
}
},
"DimensionValueType": {
"target": "com.amazonaws.timestreamwrite#DimensionValueType",
"traits": {
"smithy.api#documentation": "<p>The data type of the dimension for the time-series data point.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the metadata attributes of the time series. For example, the name and\n Availability Zone of an EC2 instance or the name of the manufacturer of a wind turbine are\n dimensions. </p>"
}
},
"com.amazonaws.timestreamwrite#DimensionMapping": {
"type": "structure",
"members": {
"SourceColumn": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"DestinationColumn": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p>\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"com.amazonaws.timestreamwrite#DimensionMappings": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#DimensionMapping"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.timestreamwrite#DimensionValueType": {
"type": "enum",
"members": {
"VARCHAR": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "VARCHAR"
}
}
}
},
"com.amazonaws.timestreamwrite#Dimensions": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#Dimension"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 128
}
}
},
"com.amazonaws.timestreamwrite#Endpoint": {
"type": "structure",
"members": {
"Address": {
"target": "com.amazonaws.timestreamwrite#String",
"traits": {
"smithy.api#documentation": "<p>An endpoint address.</p>",
"smithy.api#required": {}
}
},
"CachePeriodInMinutes": {
"target": "com.amazonaws.timestreamwrite#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The TTL for the endpoint, in minutes.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents an available endpoint against which to make API calls against, as well as the\n TTL for that endpoint.</p>"
}
},
"com.amazonaws.timestreamwrite#Endpoints": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#Endpoint"
}
},
"com.amazonaws.timestreamwrite#ErrorMessage": {
"type": "string"
},
"com.amazonaws.timestreamwrite#Integer": {
"type": "integer",
"traits": {
"smithy.api#default": 0
}
},
"com.amazonaws.timestreamwrite#InternalServerException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamwrite#ErrorMessage",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>\n Timestream was unable to fully process this request because of an internal server\n error.</p>",
"smithy.api#error": "server",
"smithy.api#httpError": 500
}
},
"com.amazonaws.timestreamwrite#InvalidEndpointException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamwrite#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The requested endpoint was not valid.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 421
}
},
"com.amazonaws.timestreamwrite#ListBatchLoadTasks": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#ListBatchLoadTasksRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#ListBatchLoadTasksResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Provides a list of batch load tasks, along with the name, status, when the task is\n resumable until, and other details. See <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html\">code\n sample</a> for details.</p>",
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "MaxResults"
}
}
},
"com.amazonaws.timestreamwrite#ListBatchLoadTasksRequest": {
"type": "structure",
"members": {
"NextToken": {
"target": "com.amazonaws.timestreamwrite#String",
"traits": {
"smithy.api#documentation": "<p>A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.</p>"
}
},
"MaxResults": {
"target": "com.amazonaws.timestreamwrite#PageLimit",
"traits": {
"smithy.api#documentation": "<p>The total number of items to return in the output. If the total number of items\n available is more than the value specified, a NextToken is provided in the output. To\n resume pagination, provide the NextToken value as argument of a subsequent API\n invocation.</p>"
}
},
"TaskStatus": {
"target": "com.amazonaws.timestreamwrite#BatchLoadStatus",
"traits": {
"smithy.api#documentation": "<p>Status of the batch load task.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#ListBatchLoadTasksResponse": {
"type": "structure",
"members": {
"NextToken": {
"target": "com.amazonaws.timestreamwrite#String",
"traits": {
"smithy.api#documentation": "<p>A token to specify where to start paginating. Provide the next\n ListBatchLoadTasksRequest.</p>"
}
},
"BatchLoadTasks": {
"target": "com.amazonaws.timestreamwrite#BatchLoadTaskList",
"traits": {
"smithy.api#documentation": "<p>A list of batch load task details.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#ListDatabases": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#ListDatabasesRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#ListDatabasesResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Returns a list of your Timestream databases. <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Service quotas apply</a>. See\n <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html\">code sample</a> for\n details. </p>",
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "MaxResults"
}
}
},
"com.amazonaws.timestreamwrite#ListDatabasesRequest": {
"type": "structure",
"members": {
"NextToken": {
"target": "com.amazonaws.timestreamwrite#String",
"traits": {
"smithy.api#documentation": "<p>The pagination token. To resume pagination, provide the NextToken value as argument of a\n subsequent API invocation.</p>"
}
},
"MaxResults": {
"target": "com.amazonaws.timestreamwrite#PaginationLimit",
"traits": {
"smithy.api#documentation": "<p>The total number of items to return in the output. If the total number of items\n available is more than the value specified, a NextToken is provided in the output. To\n resume pagination, provide the NextToken value as argument of a subsequent API\n invocation.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#ListDatabasesResponse": {
"type": "structure",
"members": {
"Databases": {
"target": "com.amazonaws.timestreamwrite#DatabaseList",
"traits": {
"smithy.api#documentation": "<p>A list of database names.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.timestreamwrite#String",
"traits": {
"smithy.api#documentation": "<p>The pagination token. This parameter is returned when the response is truncated.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#ListTables": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#ListTablesRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#ListTablesResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Provides a list of tables, along with the name, status, and retention properties of each\n table. See <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html\">code sample</a>\n for details. </p>",
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "MaxResults"
}
}
},
"com.amazonaws.timestreamwrite#ListTablesRequest": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream database.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.timestreamwrite#String",
"traits": {
"smithy.api#documentation": "<p>The pagination token. To resume pagination, provide the NextToken value as argument of a\n subsequent API invocation.</p>"
}
},
"MaxResults": {
"target": "com.amazonaws.timestreamwrite#PaginationLimit",
"traits": {
"smithy.api#documentation": "<p>The total number of items to return in the output. If the total number of items\n available is more than the value specified, a NextToken is provided in the output. To\n resume pagination, provide the NextToken value as argument of a subsequent API\n invocation.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#ListTablesResponse": {
"type": "structure",
"members": {
"Tables": {
"target": "com.amazonaws.timestreamwrite#TableList",
"traits": {
"smithy.api#documentation": "<p>A list of tables.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.timestreamwrite#String",
"traits": {
"smithy.api#documentation": "<p>A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#ListTagsForResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#ListTagsForResourceRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#ListTagsForResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p> Lists all tags on a Timestream resource. </p>"
}
},
"com.amazonaws.timestreamwrite#ListTagsForResourceRequest": {
"type": "structure",
"members": {
"ResourceARN": {
"target": "com.amazonaws.timestreamwrite#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p> The Timestream resource with tags to be listed. This value is an Amazon\n Resource Name (ARN). </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#ListTagsForResourceResponse": {
"type": "structure",
"members": {
"Tags": {
"target": "com.amazonaws.timestreamwrite#TagList",
"traits": {
"smithy.api#documentation": "<p> The tags currently associated with the Timestream resource. </p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#Long": {
"type": "long",
"traits": {
"smithy.api#default": 0
}
},
"com.amazonaws.timestreamwrite#MagneticStoreRejectedDataLocation": {
"type": "structure",
"members": {
"S3Configuration": {
"target": "com.amazonaws.timestreamwrite#S3Configuration",
"traits": {
"smithy.api#documentation": "<p>Configuration of an S3 location to write error reports for records rejected,\n asynchronously, during magnetic store writes.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The location to write error reports for records rejected, asynchronously, during\n magnetic store writes.</p>"
}
},
"com.amazonaws.timestreamwrite#MagneticStoreRetentionPeriodInDays": {
"type": "long",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 73000
}
}
},
"com.amazonaws.timestreamwrite#MagneticStoreWriteProperties": {
"type": "structure",
"members": {
"EnableMagneticStoreWrites": {
"target": "com.amazonaws.timestreamwrite#Boolean",
"traits": {
"smithy.api#documentation": "<p>A flag to enable magnetic store writes.</p>",
"smithy.api#required": {}
}
},
"MagneticStoreRejectedDataLocation": {
"target": "com.amazonaws.timestreamwrite#MagneticStoreRejectedDataLocation",
"traits": {
"smithy.api#documentation": "<p>The location to write error reports for records rejected asynchronously during magnetic\n store writes.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The set of properties on a table for configuring magnetic store writes.</p>"
}
},
"com.amazonaws.timestreamwrite#MeasureValue": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p> The name of the MeasureValue. </p>\n <p> For constraints on MeasureValue names, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming\"> Naming Constraints</a> in the Amazon Timestream Developer Guide.</p>",
"smithy.api#required": {}
}
},
"Value": {
"target": "com.amazonaws.timestreamwrite#StringValue2048",
"traits": {
"smithy.api#documentation": "<p> The value for the MeasureValue. For information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types\">Data\n types</a>.</p>",
"smithy.api#required": {}
}
},
"Type": {
"target": "com.amazonaws.timestreamwrite#MeasureValueType",
"traits": {
"smithy.api#documentation": "<p>Contains the data type of the MeasureValue for the time-series data point.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p> Represents the data attribute of the time series. For example, the CPU utilization of\n an EC2 instance or the RPM of a wind turbine are measures. MeasureValue has both name and\n value. </p>\n <p> MeasureValue is only allowed for type <code>MULTI</code>. Using <code>MULTI</code>\n type, you can pass multiple data attributes associated with the same time series in a\n single record </p>"
}
},
"com.amazonaws.timestreamwrite#MeasureValueType": {
"type": "enum",
"members": {
"DOUBLE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DOUBLE"
}
},
"BIGINT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BIGINT"
}
},
"VARCHAR": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "VARCHAR"
}
},
"BOOLEAN": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BOOLEAN"
}
},
"TIMESTAMP": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "TIMESTAMP"
}
},
"MULTI": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MULTI"
}
}
}
},
"com.amazonaws.timestreamwrite#MeasureValues": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#MeasureValue"
}
},
"com.amazonaws.timestreamwrite#MemoryStoreRetentionPeriodInHours": {
"type": "long",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 8766
}
}
},
"com.amazonaws.timestreamwrite#MixedMeasureMapping": {
"type": "structure",
"members": {
"MeasureName": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"SourceColumn": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"TargetMeasureName": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"MeasureValueType": {
"target": "com.amazonaws.timestreamwrite#MeasureValueType",
"traits": {
"smithy.api#documentation": "<p></p>",
"smithy.api#required": {}
}
},
"MultiMeasureAttributeMappings": {
"target": "com.amazonaws.timestreamwrite#MultiMeasureAttributeMappingList",
"traits": {
"smithy.api#documentation": "<p></p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"com.amazonaws.timestreamwrite#MixedMeasureMappingList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#MixedMeasureMapping"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.timestreamwrite#MultiMeasureAttributeMapping": {
"type": "structure",
"members": {
"SourceColumn": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p></p>",
"smithy.api#required": {}
}
},
"TargetMultiMeasureAttributeName": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"MeasureValueType": {
"target": "com.amazonaws.timestreamwrite#ScalarMeasureValueType",
"traits": {
"smithy.api#documentation": "<p></p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"com.amazonaws.timestreamwrite#MultiMeasureAttributeMappingList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#MultiMeasureAttributeMapping"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.timestreamwrite#MultiMeasureMappings": {
"type": "structure",
"members": {
"TargetMultiMeasureName": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"MultiMeasureAttributeMappings": {
"target": "com.amazonaws.timestreamwrite#MultiMeasureAttributeMappingList",
"traits": {
"smithy.api#documentation": "<p></p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"com.amazonaws.timestreamwrite#PageLimit": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.timestreamwrite#PaginationLimit": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 20
}
}
},
"com.amazonaws.timestreamwrite#PartitionKey": {
"type": "structure",
"members": {
"Type": {
"target": "com.amazonaws.timestreamwrite#PartitionKeyType",
"traits": {
"smithy.api#documentation": "<p> The type of the partition key. Options are DIMENSION (dimension key) and MEASURE\n (measure key). </p>",
"smithy.api#required": {}
}
},
"Name": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p> The name of the attribute used for a dimension key. </p>"
}
},
"EnforcementInRecord": {
"target": "com.amazonaws.timestreamwrite#PartitionKeyEnforcementLevel",
"traits": {
"smithy.api#documentation": "<p> The level of enforcement for the specification of a dimension key in ingested records.\n Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not\n have to be specified). </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p> An attribute used in partitioning data in a table. A dimension key partitions data\n using the values of the dimension specified by the dimension-name as partition key, while a\n measure key partitions data using measure names (values of the 'measure_name' column).\n </p>"
}
},
"com.amazonaws.timestreamwrite#PartitionKeyEnforcementLevel": {
"type": "enum",
"members": {
"REQUIRED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "REQUIRED"
}
},
"OPTIONAL": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "OPTIONAL"
}
}
}
},
"com.amazonaws.timestreamwrite#PartitionKeyList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#PartitionKey"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.timestreamwrite#PartitionKeyType": {
"type": "enum",
"members": {
"DIMENSION": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DIMENSION"
}
},
"MEASURE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MEASURE"
}
}
}
},
"com.amazonaws.timestreamwrite#Record": {
"type": "structure",
"members": {
"Dimensions": {
"target": "com.amazonaws.timestreamwrite#Dimensions",
"traits": {
"smithy.api#documentation": "<p>Contains the list of dimensions for time-series data points.</p>"
}
},
"MeasureName": {
"target": "com.amazonaws.timestreamwrite#SchemaName",
"traits": {
"smithy.api#documentation": "<p>Measure represents the data attribute of the time series. For example, the CPU\n utilization of an EC2 instance or the RPM of a wind turbine are measures. </p>"
}
},
"MeasureValue": {
"target": "com.amazonaws.timestreamwrite#StringValue2048",
"traits": {
"smithy.api#documentation": "<p> Contains the measure value for the time-series data point. </p>"
}
},
"MeasureValueType": {
"target": "com.amazonaws.timestreamwrite#MeasureValueType",
"traits": {
"smithy.api#documentation": "<p> Contains the data type of the measure value for the time-series data point. Default\n type is <code>DOUBLE</code>. For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types\">Data\n types</a>.</p>"
}
},
"Time": {
"target": "com.amazonaws.timestreamwrite#StringValue256",
"traits": {
"smithy.api#documentation": "<p> Contains the time at which the measure value for the data point was collected. The time\n value plus the unit provides the time elapsed since the epoch. For example, if the time\n value is <code>12345</code> and the unit is <code>ms</code>, then <code>12345 ms</code>\n have elapsed since the epoch. </p>"
}
},
"TimeUnit": {
"target": "com.amazonaws.timestreamwrite#TimeUnit",
"traits": {
"smithy.api#documentation": "<p> The granularity of the timestamp unit. It indicates if the time value is in seconds,\n milliseconds, nanoseconds, or other supported values. Default is <code>MILLISECONDS</code>.\n </p>"
}
},
"Version": {
"target": "com.amazonaws.timestreamwrite#RecordVersion",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>64-bit attribute used for record updates. Write requests for duplicate data with a\n higher version number will update the existing measure value and version. In cases where\n the measure value is the same, <code>Version</code> will still be updated. Default value is\n <code>1</code>.</p>\n <note>\n <p>\n <code>Version</code> must be <code>1</code> or greater, or you will receive a\n <code>ValidationException</code> error.</p>\n </note>"
}
},
"MeasureValues": {
"target": "com.amazonaws.timestreamwrite#MeasureValues",
"traits": {
"smithy.api#documentation": "<p> Contains the list of MeasureValue for time-series data points. </p>\n <p> This is only allowed for type <code>MULTI</code>. For scalar values, use\n <code>MeasureValue</code> attribute of the record directly. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a time-series data point being written into Timestream. Each record\n contains an array of dimensions. Dimensions represent the metadata attributes of a\n time-series data point, such as the instance name or Availability Zone of an EC2 instance.\n A record also contains the measure name, which is the name of the measure being collected\n (for example, the CPU utilization of an EC2 instance). Additionally, a record contains the\n measure value and the value type, which is the data type of the measure value. Also, the\n record contains the timestamp of when the measure was collected and the timestamp unit,\n which represents the granularity of the timestamp. </p>\n <p> Records have a <code>Version</code> field, which is a 64-bit <code>long</code> that you\n can use for updating data points. Writes of a duplicate record with the same dimension,\n timestamp, and measure name but different measure value will only succeed if the\n <code>Version</code> attribute of the record in the write request is higher than that of\n the existing record. Timestream defaults to a <code>Version</code> of\n <code>1</code> for records without the <code>Version</code> field. </p>"
}
},
"com.amazonaws.timestreamwrite#RecordIndex": {
"type": "integer",
"traits": {
"smithy.api#default": 0
}
},
"com.amazonaws.timestreamwrite#RecordVersion": {
"type": "long",
"traits": {
"smithy.api#default": 0
}
},
"com.amazonaws.timestreamwrite#Records": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#Record"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.timestreamwrite#RecordsIngested": {
"type": "structure",
"members": {
"Total": {
"target": "com.amazonaws.timestreamwrite#Integer",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Total count of successfully ingested records.</p>"
}
},
"MemoryStore": {
"target": "com.amazonaws.timestreamwrite#Integer",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Count of records ingested into the memory store.</p>"
}
},
"MagneticStore": {
"target": "com.amazonaws.timestreamwrite#Integer",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Count of records ingested into the magnetic store.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information on the records ingested by this request.</p>"
}
},
"com.amazonaws.timestreamwrite#RejectedRecord": {
"type": "structure",
"members": {
"RecordIndex": {
"target": "com.amazonaws.timestreamwrite#RecordIndex",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p> The index of the record in the input request for WriteRecords. Indexes begin with 0.\n </p>"
}
},
"Reason": {
"target": "com.amazonaws.timestreamwrite#ErrorMessage",
"traits": {
"smithy.api#documentation": "<p> The reason why a record was not successfully inserted into Timestream.\n Possible causes of failure include: </p>\n <ul>\n <li>\n <p>Records with duplicate data where there are multiple records with the same\n dimensions, timestamps, and measure names but: </p>\n <ul>\n <li>\n <p>Measure values are different</p>\n </li>\n <li>\n <p>Version is not present in the request, <i>or</i> the value of\n version in the new record is equal to or lower than the existing value</p>\n </li>\n </ul>\n <p>If Timestream rejects data for this case, the\n <code>ExistingVersion</code> field in the <code>RejectedRecords</code> response\n will indicate the current record\u2019s version. To force an update, you can resend the\n request with a version for the record set to a value greater than the\n <code>ExistingVersion</code>.</p>\n </li>\n <li>\n <p> Records with timestamps that lie outside the retention duration of the memory\n store. </p>\n <note>\n <p>When the retention window is updated, you will receive a\n <code>RejectedRecords</code> exception if you immediately try to ingest data\n within the new window. To avoid a <code>RejectedRecords</code> exception, wait\n until the duration of the new window to ingest new data. For further information,\n see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/best-practices.html#configuration\"> Best\n Practices for Configuring Timestream</a> and <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html\">the\n explanation of how storage works in Timestream</a>.</p>\n </note>\n </li>\n <li>\n <p> Records with dimensions or measures that exceed the Timestream defined\n limits. </p>\n </li>\n </ul>\n <p> For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Access Management</a> in the\n Timestream Developer Guide. </p>"
}
},
"ExistingVersion": {
"target": "com.amazonaws.timestreamwrite#RecordVersion",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>The existing version of the record. This value is populated in scenarios where an\n identical record exists with a higher version than the version in the write request.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p> Represents records that were not successfully inserted into Timestream due to\n data validation issues that must be resolved before reinserting time-series data into the\n system. </p>"
}
},
"com.amazonaws.timestreamwrite#RejectedRecords": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#RejectedRecord"
}
},
"com.amazonaws.timestreamwrite#RejectedRecordsException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamwrite#ErrorMessage"
},
"RejectedRecords": {
"target": "com.amazonaws.timestreamwrite#RejectedRecords",
"traits": {
"smithy.api#documentation": "<p>\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p> WriteRecords would throw this exception in the following cases: </p>\n <ul>\n <li>\n <p>Records with duplicate data where there are multiple records with the same\n dimensions, timestamps, and measure names but: </p>\n <ul>\n <li>\n <p>Measure values are different</p>\n </li>\n <li>\n <p>Version is not present in the request <i>or</i> the value of\n version in the new record is equal to or lower than the existing value</p>\n </li>\n </ul>\n <p> In this case, if Timestream rejects data, the\n <code>ExistingVersion</code> field in the <code>RejectedRecords</code> response\n will indicate the current record\u2019s version. To force an update, you can resend the\n request with a version for the record set to a value greater than the\n <code>ExistingVersion</code>.</p>\n </li>\n <li>\n <p> Records with timestamps that lie outside the retention duration of the memory\n store. </p>\n </li>\n <li>\n <p> Records with dimensions or measures that exceed the Timestream defined\n limits. </p>\n </li>\n </ul>\n <p> For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Quotas</a> in the Amazon Timestream Developer Guide. </p>",
"smithy.api#error": "client",
"smithy.api#httpError": 419
}
},
"com.amazonaws.timestreamwrite#ReportConfiguration": {
"type": "structure",
"members": {
"ReportS3Configuration": {
"target": "com.amazonaws.timestreamwrite#ReportS3Configuration",
"traits": {
"smithy.api#documentation": "<p>Configuration of an S3 location to write error reports and events for a batch\n load.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Report configuration for a batch load task. This contains details about where error\n reports are stored.</p>"
}
},
"com.amazonaws.timestreamwrite#ReportS3Configuration": {
"type": "structure",
"members": {
"BucketName": {
"target": "com.amazonaws.timestreamwrite#S3BucketName",
"traits": {
"smithy.api#documentation": "<p></p>",
"smithy.api#required": {}
}
},
"ObjectKeyPrefix": {
"target": "com.amazonaws.timestreamwrite#S3ObjectKeyPrefix",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"EncryptionOption": {
"target": "com.amazonaws.timestreamwrite#S3EncryptionOption",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"KmsKeyId": {
"target": "com.amazonaws.timestreamwrite#StringValue2048",
"traits": {
"smithy.api#documentation": "<p></p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"com.amazonaws.timestreamwrite#ResourceCreateAPIName": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[a-zA-Z0-9_.-]+$"
}
},
"com.amazonaws.timestreamwrite#ResourceName": {
"type": "string"
},
"com.amazonaws.timestreamwrite#ResourceNotFoundException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamwrite#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The operation tried to access a nonexistent resource. The resource might not be\n specified correctly, or its status might not be ACTIVE.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 404
}
},
"com.amazonaws.timestreamwrite#ResumeBatchLoadTask": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#ResumeBatchLoadTaskRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#ResumeBatchLoadTaskResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>\n </p>"
}
},
"com.amazonaws.timestreamwrite#ResumeBatchLoadTaskRequest": {
"type": "structure",
"members": {
"TaskId": {
"target": "com.amazonaws.timestreamwrite#BatchLoadTaskId",
"traits": {
"smithy.api#documentation": "<p>The ID of the batch load task to resume.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#ResumeBatchLoadTaskResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#RetentionProperties": {
"type": "structure",
"members": {
"MemoryStoreRetentionPeriodInHours": {
"target": "com.amazonaws.timestreamwrite#MemoryStoreRetentionPeriodInHours",
"traits": {
"smithy.api#documentation": "<p>The duration for which data must be stored in the memory store. </p>",
"smithy.api#required": {}
}
},
"MagneticStoreRetentionPeriodInDays": {
"target": "com.amazonaws.timestreamwrite#MagneticStoreRetentionPeriodInDays",
"traits": {
"smithy.api#documentation": "<p>The duration for which data must be stored in the magnetic store. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retention properties contain the duration for which your time-series data must be stored\n in the magnetic store and the memory store. </p>"
}
},
"com.amazonaws.timestreamwrite#S3BucketName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 3,
"max": 63
},
"smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$"
}
},
"com.amazonaws.timestreamwrite#S3Configuration": {
"type": "structure",
"members": {
"BucketName": {
"target": "com.amazonaws.timestreamwrite#S3BucketName",
"traits": {
"smithy.api#documentation": "<p>The bucket name of the customer S3 bucket.</p>"
}
},
"ObjectKeyPrefix": {
"target": "com.amazonaws.timestreamwrite#S3ObjectKeyPrefix",
"traits": {
"smithy.api#documentation": "<p>The object key preview for the customer S3 location.</p>"
}
},
"EncryptionOption": {
"target": "com.amazonaws.timestreamwrite#S3EncryptionOption",
"traits": {
"smithy.api#documentation": "<p>The encryption option for the customer S3 location. Options are S3 server-side\n encryption with an S3 managed key or Amazon Web Services managed key.</p>"
}
},
"KmsKeyId": {
"target": "com.amazonaws.timestreamwrite#StringValue2048",
"traits": {
"smithy.api#documentation": "<p>The KMS key ID for the customer S3 location when encrypting with an\n Amazon Web Services managed key.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The configuration that specifies an S3 location.</p>"
}
},
"com.amazonaws.timestreamwrite#S3EncryptionOption": {
"type": "enum",
"members": {
"SSE_S3": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SSE_S3"
}
},
"SSE_KMS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SSE_KMS"
}
}
}
},
"com.amazonaws.timestreamwrite#S3ObjectKey": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
},
"smithy.api#pattern": "^[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+$"
}
},
"com.amazonaws.timestreamwrite#S3ObjectKeyPrefix": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 928
},
"smithy.api#pattern": "^[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+$"
}
},
"com.amazonaws.timestreamwrite#ScalarMeasureValueType": {
"type": "enum",
"members": {
"DOUBLE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DOUBLE"
}
},
"BIGINT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BIGINT"
}
},
"BOOLEAN": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BOOLEAN"
}
},
"VARCHAR": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "VARCHAR"
}
},
"TIMESTAMP": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "TIMESTAMP"
}
}
}
},
"com.amazonaws.timestreamwrite#Schema": {
"type": "structure",
"members": {
"CompositePartitionKey": {
"target": "com.amazonaws.timestreamwrite#PartitionKeyList",
"traits": {
"smithy.api#documentation": "<p>A non-empty list of partition keys defining the attributes used to partition the table\n data. The order of the list determines the partition hierarchy. The name and type of each\n partition key as well as the partition key order cannot be changed after the table is\n created. However, the enforcement level of each partition key can be changed. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p> A Schema specifies the expected data model of the table. </p>"
}
},
"com.amazonaws.timestreamwrite#SchemaName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.timestreamwrite#SchemaValue": {
"type": "string"
},
"com.amazonaws.timestreamwrite#ServiceQuotaExceededException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamwrite#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p> The instance quota of resource exceeded for this account.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 402
}
},
"com.amazonaws.timestreamwrite#String": {
"type": "string"
},
"com.amazonaws.timestreamwrite#StringValue1": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1
}
}
},
"com.amazonaws.timestreamwrite#StringValue2048": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 2048
}
}
},
"com.amazonaws.timestreamwrite#StringValue256": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 256
}
}
},
"com.amazonaws.timestreamwrite#Table": {
"type": "structure",
"members": {
"Arn": {
"target": "com.amazonaws.timestreamwrite#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name that uniquely identifies this table.</p>"
}
},
"TableName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream table.</p>"
}
},
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream database that contains this table.</p>"
}
},
"TableStatus": {
"target": "com.amazonaws.timestreamwrite#TableStatus",
"traits": {
"smithy.api#documentation": "<p>The current state of the table:</p>\n <ul>\n <li>\n <p>\n <code>DELETING</code> - The table is being deleted.</p>\n </li>\n <li>\n <p>\n <code>ACTIVE</code> - The table is ready for use.</p>\n </li>\n </ul>"
}
},
"RetentionProperties": {
"target": "com.amazonaws.timestreamwrite#RetentionProperties",
"traits": {
"smithy.api#documentation": "<p>The retention duration for the memory store and magnetic store.</p>"
}
},
"CreationTime": {
"target": "com.amazonaws.timestreamwrite#Date",
"traits": {
"smithy.api#documentation": "<p>The time when the Timestream table was created. </p>"
}
},
"LastUpdatedTime": {
"target": "com.amazonaws.timestreamwrite#Date",
"traits": {
"smithy.api#documentation": "<p>The time when the Timestream table was last updated.</p>"
}
},
"MagneticStoreWriteProperties": {
"target": "com.amazonaws.timestreamwrite#MagneticStoreWriteProperties",
"traits": {
"smithy.api#documentation": "<p>Contains properties to set on the table when enabling magnetic store writes.</p>"
}
},
"Schema": {
"target": "com.amazonaws.timestreamwrite#Schema",
"traits": {
"smithy.api#documentation": "<p> The schema of the table. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a database table in Timestream. Tables contain one or more related\n time series. You can modify the retention duration of the memory store and the magnetic\n store for a table. </p>"
}
},
"com.amazonaws.timestreamwrite#TableList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#Table"
}
},
"com.amazonaws.timestreamwrite#TableStatus": {
"type": "enum",
"members": {
"ACTIVE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ACTIVE"
}
},
"DELETING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DELETING"
}
},
"RESTORING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "RESTORING"
}
}
}
},
"com.amazonaws.timestreamwrite#Tag": {
"type": "structure",
"members": {
"Key": {
"target": "com.amazonaws.timestreamwrite#TagKey",
"traits": {
"smithy.api#documentation": "<p> The key of the tag. Tag keys are case sensitive. </p>",
"smithy.api#required": {}
}
},
"Value": {
"target": "com.amazonaws.timestreamwrite#TagValue",
"traits": {
"smithy.api#documentation": "<p> The value of the tag. Tag values are case-sensitive and can be null. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p> A tag is a label that you assign to a Timestream database and/or table. Each\n tag consists of a key and an optional value, both of which you define. With tags, you can\n categorize databases and/or tables, for example, by purpose, owner, or environment. </p>"
}
},
"com.amazonaws.timestreamwrite#TagKey": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 128
}
}
},
"com.amazonaws.timestreamwrite#TagKeyList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#TagKey"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 200
}
}
},
"com.amazonaws.timestreamwrite#TagList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamwrite#Tag"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 200
}
}
},
"com.amazonaws.timestreamwrite#TagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#TagResourceRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#TagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p> Associates a set of tags with a Timestream resource. You can then activate\n these user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. </p>"
}
},
"com.amazonaws.timestreamwrite#TagResourceRequest": {
"type": "structure",
"members": {
"ResourceARN": {
"target": "com.amazonaws.timestreamwrite#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p> Identifies the Timestream resource to which tags should be added. This value\n is an Amazon Resource Name (ARN). </p>",
"smithy.api#required": {}
}
},
"Tags": {
"target": "com.amazonaws.timestreamwrite#TagList",
"traits": {
"smithy.api#documentation": "<p> The tags to be assigned to the Timestream resource. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#TagResourceResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#TagValue": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 256
}
}
},
"com.amazonaws.timestreamwrite#ThrottlingException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamwrite#ErrorMessage",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p> Too many requests were made by a user and they exceeded the service quotas. The request\n was throttled.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 429
}
},
"com.amazonaws.timestreamwrite#TimeUnit": {
"type": "enum",
"members": {
"MILLISECONDS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MILLISECONDS"
}
},
"SECONDS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SECONDS"
}
},
"MICROSECONDS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MICROSECONDS"
}
},
"NANOSECONDS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "NANOSECONDS"
}
}
}
},
"com.amazonaws.timestreamwrite#Timestream_20181101": {
"type": "service",
"version": "2018-11-01",
"operations": [
{
"target": "com.amazonaws.timestreamwrite#CreateBatchLoadTask"
},
{
"target": "com.amazonaws.timestreamwrite#CreateDatabase"
},
{
"target": "com.amazonaws.timestreamwrite#CreateTable"
},
{
"target": "com.amazonaws.timestreamwrite#DeleteDatabase"
},
{
"target": "com.amazonaws.timestreamwrite#DeleteTable"
},
{
"target": "com.amazonaws.timestreamwrite#DescribeBatchLoadTask"
},
{
"target": "com.amazonaws.timestreamwrite#DescribeDatabase"
},
{
"target": "com.amazonaws.timestreamwrite#DescribeEndpoints"
},
{
"target": "com.amazonaws.timestreamwrite#DescribeTable"
},
{
"target": "com.amazonaws.timestreamwrite#ListBatchLoadTasks"
},
{
"target": "com.amazonaws.timestreamwrite#ListDatabases"
},
{
"target": "com.amazonaws.timestreamwrite#ListTables"
},
{
"target": "com.amazonaws.timestreamwrite#ListTagsForResource"
},
{
"target": "com.amazonaws.timestreamwrite#ResumeBatchLoadTask"
},
{
"target": "com.amazonaws.timestreamwrite#TagResource"
},
{
"target": "com.amazonaws.timestreamwrite#UntagResource"
},
{
"target": "com.amazonaws.timestreamwrite#UpdateDatabase"
},
{
"target": "com.amazonaws.timestreamwrite#UpdateTable"
},
{
"target": "com.amazonaws.timestreamwrite#WriteRecords"
},
{
"target": "com.amazonaws.timestreamquery#CancelQuery"
},
{
"target": "com.amazonaws.timestreamquery#CreateScheduledQuery"
},
{
"target": "com.amazonaws.timestreamquery#DeleteScheduledQuery"
},
{
"target": "com.amazonaws.timestreamquery#DescribeAccountSettings"
},
{
"target": "com.amazonaws.timestreamquery#DescribeScheduledQuery"
},
{
"target": "com.amazonaws.timestreamquery#ExecuteScheduledQuery"
},
{
"target": "com.amazonaws.timestreamquery#ListScheduledQueries"
},
{
"target": "com.amazonaws.timestreamquery#PrepareQuery"
},
{
"target": "com.amazonaws.timestreamquery#Query"
},
{
"target": "com.amazonaws.timestreamquery#UpdateAccountSettings"
},
{
"target": "com.amazonaws.timestreamquery#UpdateScheduledQuery"
}
],
"traits": {
"aws.api#clientEndpointDiscovery": {
"operation": "com.amazonaws.timestreamwrite#DescribeEndpoints",
"error": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
"aws.api#service": {
"sdkId": "Timestream Write",
"arnNamespace": "timestream",
"cloudFormationName": "TimestreamWrite",
"cloudTrailEventSource": "timestreamwrite.amazonaws.com",
"endpointPrefix": "ingest.timestream"
},
"aws.auth#sigv4": {
"name": "timestream"
},
"aws.protocols#awsJson1_0": {},
"smithy.api#documentation": "<fullname>Amazon Timestream Write</fullname>\n <p>Amazon Timestream is a fast, scalable, fully managed time-series database service\n that makes it easy to store and analyze trillions of time-series data points per day. With\n Timestream, you can easily store and analyze IoT sensor data to derive insights\n from your IoT applications. You can analyze industrial telemetry to streamline equipment\n management and maintenance. You can also store and analyze log data and metrics to improve\n the performance and availability of your applications. </p>\n <p>Timestream is built from the ground up to effectively ingest, process, and\n store time-series data. It organizes data to optimize query processing. It automatically\n scales based on the volume of data ingested and on the query volume to ensure you receive\n optimal performance while inserting and querying data. As your data grows over time,\n Timestream\u2019s adaptive query processing engine spans across storage tiers to\n provide fast analysis while reducing costs.</p>",
"smithy.api#title": "Amazon Timestream Write",
"smithy.rules#endpointBdd": {
"version": "1.1",
"parameters": {
"Region": {
"builtIn": "AWS::Region",
"required": false,
"documentation": "The AWS region used to dispatch the request.",
"type": "string"
},
"UseDualStack": {
"builtIn": "AWS::UseDualStack",
"required": true,
"default": false,
"documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.",
"type": "boolean"
},
"UseFIPS": {
"builtIn": "AWS::UseFIPS",
"required": true,
"default": false,
"documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.",
"type": "boolean"
},
"Endpoint": {
"builtIn": "SDK::Endpoint",
"required": false,
"documentation": "Override the endpoint used to send this request",
"type": "string"
}
},
"conditions": [
{
"fn": "isSet",
"argv": [
{
"ref": "Endpoint"
}
]
},
{
"fn": "isSet",
"argv": [
{
"ref": "Region"
}
]
},
{
"fn": "aws.partition",
"argv": [
{
"ref": "Region"
}
],
"assign": "PartitionResult"
},
{
"fn": "booleanEquals",
"argv": [
{
"ref": "UseFIPS"
},
true
]
},
{
"fn": "booleanEquals",
"argv": [
{
"ref": "UseDualStack"
},
true
]
},
{
"fn": "booleanEquals",
"argv": [
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"supportsFIPS"
]
},
true
]
},
{
"fn": "booleanEquals",
"argv": [
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"supportsDualStack"
]
},
true
]
},
{
"fn": "stringEquals",
"argv": [
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"name"
]
},
"aws"
]
},
{
"fn": "stringEquals",
"argv": [
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"name"
]
},
"aws-us-gov"
]
}
],
"results": [
{
"conditions": [],
"error": "Invalid Configuration: FIPS and custom endpoint are not supported",
"type": "error"
},
{
"conditions": [],
"error": "Invalid Configuration: Dualstack and custom endpoint are not supported",
"type": "error"
},
{
"conditions": [],
"endpoint": {
"url": {
"ref": "Endpoint"
},
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"endpoint": {
"url": "https://timestream-ingest-fips.{Region}.api.aws",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"endpoint": {
"url": "https://timestream-ingest.{Region}.api.aws",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"endpoint": {
"url": "https://ingest.timestream-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"error": "FIPS and DualStack are enabled, but this partition does not support one or both",
"type": "error"
},
{
"conditions": [],
"endpoint": {
"url": "https://ingest.timestream.{Region}.amazonaws.com",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"endpoint": {
"url": "https://ingest.timestream-fips.{Region}.{PartitionResult#dnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"error": "FIPS is enabled but this partition does not support FIPS",
"type": "error"
},
{
"conditions": [],
"endpoint": {
"url": "https://ingest.timestream.{Region}.{PartitionResult#dualStackDnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"error": "DualStack is enabled but this partition does not support DualStack",
"type": "error"
},
{
"conditions": [],
"endpoint": {
"url": "https://ingest.timestream.{Region}.{PartitionResult#dnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"error": "Invalid Configuration: Missing Region",
"type": "error"
}
],
"root": 2,
"nodeCount": 18,
"nodes": "/////wAAAAH/////AAAAAAAAABEAAAADAAAAAQAAAAQF9eEOAAAAAgAAAAUF9eEOAAAAAwAAAAoAAAAGAAAABAAAAAcF9eENAAAABgAAAAgF9eEMAAAABwX14QUAAAAJAAAACAX14QUF9eELAAAABAAAAA0AAAALAAAABQAAAAwF9eEKAAAACAX14QgF9eEJAAAABQAAAA4F9eEHAAAABgAAAA8F9eEHAAAABwX14QQAAAAQAAAACAX14QUF9eEGAAAAAwX14QEAAAASAAAABAX14QIF9eED"
},
"smithy.rules#endpointRuleSet": {
"version": "1.0",
"parameters": {
"Region": {
"builtIn": "AWS::Region",
"required": false,
"documentation": "The AWS region used to dispatch the request.",
"type": "string"
},
"UseDualStack": {
"builtIn": "AWS::UseDualStack",
"required": true,
"default": false,
"documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.",
"type": "boolean"
},
"UseFIPS": {
"builtIn": "AWS::UseFIPS",
"required": true,
"default": false,
"documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.",
"type": "boolean"
},
"Endpoint": {
"builtIn": "SDK::Endpoint",
"required": false,
"documentation": "Override the endpoint used to send this request",
"type": "string"
}
},
"rules": [
{
"conditions": [
{
"fn": "isSet",
"argv": [
{
"ref": "Endpoint"
}
]
}
],
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
{
"ref": "UseFIPS"
},
true
]
}
],
"error": "Invalid Configuration: FIPS and custom endpoint are not supported",
"type": "error"
},
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
{
"ref": "UseDualStack"
},
true
]
}
],
"error": "Invalid Configuration: Dualstack and custom endpoint are not supported",
"type": "error"
},
{
"conditions": [],
"endpoint": {
"url": {
"ref": "Endpoint"
},
"properties": {},
"headers": {}
},
"type": "endpoint"
}
],
"type": "tree"
},
{
"conditions": [
{
"fn": "isSet",
"argv": [
{
"ref": "Region"
}
]
}
],
"rules": [
{
"conditions": [
{
"fn": "aws.partition",
"argv": [
{
"ref": "Region"
}
],
"assign": "PartitionResult"
}
],
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
{
"ref": "UseFIPS"
},
true
]
},
{
"fn": "booleanEquals",
"argv": [
{
"ref": "UseDualStack"
},
true
]
}
],
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
true,
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"supportsFIPS"
]
}
]
},
{
"fn": "booleanEquals",
"argv": [
true,
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"supportsDualStack"
]
}
]
}
],
"rules": [
{
"conditions": [
{
"fn": "stringEquals",
"argv": [
"aws",
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"name"
]
}
]
}
],
"endpoint": {
"url": "https://timestream-ingest-fips.{Region}.api.aws",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [
{
"fn": "stringEquals",
"argv": [
"aws-us-gov",
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"name"
]
}
]
}
],
"endpoint": {
"url": "https://timestream-ingest.{Region}.api.aws",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"endpoint": {
"url": "https://ingest.timestream-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
}
],
"type": "tree"
},
{
"conditions": [],
"error": "FIPS and DualStack are enabled, but this partition does not support one or both",
"type": "error"
}
],
"type": "tree"
},
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
{
"ref": "UseFIPS"
},
true
]
}
],
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"supportsFIPS"
]
},
true
]
}
],
"rules": [
{
"conditions": [
{
"fn": "stringEquals",
"argv": [
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"name"
]
},
"aws-us-gov"
]
}
],
"endpoint": {
"url": "https://ingest.timestream.{Region}.amazonaws.com",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"endpoint": {
"url": "https://ingest.timestream-fips.{Region}.{PartitionResult#dnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
}
],
"type": "tree"
},
{
"conditions": [],
"error": "FIPS is enabled but this partition does not support FIPS",
"type": "error"
}
],
"type": "tree"
},
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
{
"ref": "UseDualStack"
},
true
]
}
],
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
true,
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"supportsDualStack"
]
}
]
}
],
"rules": [
{
"conditions": [
{
"fn": "stringEquals",
"argv": [
"aws",
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"name"
]
}
]
}
],
"endpoint": {
"url": "https://timestream-ingest.{Region}.api.aws",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [
{
"fn": "stringEquals",
"argv": [
"aws-us-gov",
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"name"
]
}
]
}
],
"endpoint": {
"url": "https://timestream-ingest.{Region}.api.aws",
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [],
"endpoint": {
"url": "https://ingest.timestream.{Region}.{PartitionResult#dualStackDnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
}
],
"type": "tree"
},
{
"conditions": [],
"error": "DualStack is enabled but this partition does not support DualStack",
"type": "error"
}
],
"type": "tree"
},
{
"conditions": [],
"endpoint": {
"url": "https://ingest.timestream.{Region}.{PartitionResult#dnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
}
],
"type": "tree"
}
],
"type": "tree"
},
{
"conditions": [],
"error": "Invalid Configuration: Missing Region",
"type": "error"
}
]
},
"smithy.rules#endpointTests": {
"testCases": [
{
"documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.ap-northeast-1.amazonaws.com"
}
},
"params": {
"Region": "ap-northeast-1",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.ap-northeast-1.api.aws"
}
},
"params": {
"Region": "ap-northeast-1",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.ap-south-1.amazonaws.com"
}
},
"params": {
"Region": "ap-south-1",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.ap-south-1.api.aws"
}
},
"params": {
"Region": "ap-south-1",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.ap-southeast-2.amazonaws.com"
}
},
"params": {
"Region": "ap-southeast-2",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.ap-southeast-2.api.aws"
}
},
"params": {
"Region": "ap-southeast-2",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.eu-central-1.amazonaws.com"
}
},
"params": {
"Region": "eu-central-1",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.eu-central-1.api.aws"
}
},
"params": {
"Region": "eu-central-1",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.eu-west-1.amazonaws.com"
}
},
"params": {
"Region": "eu-west-1",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.eu-west-1.api.aws"
}
},
"params": {
"Region": "eu-west-1",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region us-east-1 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.us-east-1.amazonaws.com"
}
},
"params": {
"Region": "us-east-1",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region us-east-1 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.us-east-1.api.aws"
}
},
"params": {
"Region": "us-east-1",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region us-east-1 with FIPS enabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest-fips.us-east-1.api.aws"
}
},
"params": {
"Region": "us-east-1",
"UseFIPS": true,
"UseDualStack": true
}
},
{
"documentation": "For region us-east-2 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.us-east-2.amazonaws.com"
}
},
"params": {
"Region": "us-east-2",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region us-east-2 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.us-east-2.api.aws"
}
},
"params": {
"Region": "us-east-2",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region us-east-2 with FIPS enabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest-fips.us-east-2.api.aws"
}
},
"params": {
"Region": "us-east-2",
"UseFIPS": true,
"UseDualStack": true
}
},
{
"documentation": "For region us-west-2 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.us-west-2.amazonaws.com"
}
},
"params": {
"Region": "us-west-2",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region us-west-2 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.us-west-2.api.aws"
}
},
"params": {
"Region": "us-west-2",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region us-west-2 with FIPS enabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest-fips.us-west-2.api.aws"
}
},
"params": {
"Region": "us-west-2",
"UseFIPS": true,
"UseDualStack": true
}
},
{
"documentation": "For region us-east-1 with FIPS enabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream-fips.us-east-1.amazonaws.com"
}
},
"params": {
"Region": "us-east-1",
"UseFIPS": true,
"UseDualStack": false
}
},
{
"documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream-fips.cn-north-1.api.amazonwebservices.com.cn"
}
},
"params": {
"Region": "cn-north-1",
"UseFIPS": true,
"UseDualStack": true
}
},
{
"documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream-fips.cn-north-1.amazonaws.com.cn"
}
},
"params": {
"Region": "cn-north-1",
"UseFIPS": true,
"UseDualStack": false
}
},
{
"documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.cn-north-1.api.amazonwebservices.com.cn"
}
},
"params": {
"Region": "cn-north-1",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.cn-north-1.amazonaws.com.cn"
}
},
"params": {
"Region": "cn-north-1",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.us-gov-west-1.amazonaws.com"
}
},
"params": {
"Region": "us-gov-west-1",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.us-gov-west-1.amazonaws.com"
}
},
"params": {
"Region": "us-gov-west-1",
"UseFIPS": true,
"UseDualStack": false
}
},
{
"documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.us-gov-west-1.api.aws"
}
},
"params": {
"Region": "us-gov-west-1",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.us-gov-west-1.api.aws"
}
},
"params": {
"Region": "us-gov-west-1",
"UseFIPS": true,
"UseDualStack": true
}
},
{
"documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.us-gov-east-1.api.aws"
}
},
"params": {
"Region": "us-gov-east-1",
"UseFIPS": true,
"UseDualStack": true
}
},
{
"documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.us-gov-east-1.amazonaws.com"
}
},
"params": {
"Region": "us-gov-east-1",
"UseFIPS": true,
"UseDualStack": false
}
},
{
"documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled",
"expect": {
"endpoint": {
"url": "https://timestream-ingest.us-gov-east-1.api.aws"
}
},
"params": {
"Region": "us-gov-east-1",
"UseFIPS": false,
"UseDualStack": true
}
},
{
"documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.us-gov-east-1.amazonaws.com"
}
},
"params": {
"Region": "us-gov-east-1",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream-fips.us-iso-east-1.c2s.ic.gov"
}
},
"params": {
"Region": "us-iso-east-1",
"UseFIPS": true,
"UseDualStack": false
}
},
{
"documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.us-iso-east-1.c2s.ic.gov"
}
},
"params": {
"Region": "us-iso-east-1",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream-fips.us-isob-east-1.sc2s.sgov.gov"
}
},
"params": {
"Region": "us-isob-east-1",
"UseFIPS": true,
"UseDualStack": false
}
},
{
"documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled",
"expect": {
"endpoint": {
"url": "https://ingest.timestream.us-isob-east-1.sc2s.sgov.gov"
}
},
"params": {
"Region": "us-isob-east-1",
"UseFIPS": false,
"UseDualStack": false
}
},
{
"documentation": "For custom endpoint with region set and fips disabled and dualstack disabled",
"expect": {
"endpoint": {
"url": "https://example.com"
}
},
"params": {
"Region": "us-east-1",
"UseFIPS": false,
"UseDualStack": false,
"Endpoint": "https://example.com"
}
},
{
"documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled",
"expect": {
"endpoint": {
"url": "https://example.com"
}
},
"params": {
"UseFIPS": false,
"UseDualStack": false,
"Endpoint": "https://example.com"
}
},
{
"documentation": "For custom endpoint with fips enabled and dualstack disabled",
"expect": {
"error": "Invalid Configuration: FIPS and custom endpoint are not supported"
},
"params": {
"Region": "us-east-1",
"UseFIPS": true,
"UseDualStack": false,
"Endpoint": "https://example.com"
}
},
{
"documentation": "For custom endpoint with fips disabled and dualstack enabled",
"expect": {
"error": "Invalid Configuration: Dualstack and custom endpoint are not supported"
},
"params": {
"Region": "us-east-1",
"UseFIPS": false,
"UseDualStack": true,
"Endpoint": "https://example.com"
}
},
{
"documentation": "Missing region",
"expect": {
"error": "Invalid Configuration: Missing Region"
}
}
],
"version": "1.0"
}
}
},
"com.amazonaws.timestreamwrite#UntagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#UntagResourceRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#UntagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p> Removes the association of tags from a Timestream resource. </p>"
}
},
"com.amazonaws.timestreamwrite#UntagResourceRequest": {
"type": "structure",
"members": {
"ResourceARN": {
"target": "com.amazonaws.timestreamwrite#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p> The Timestream resource that the tags will be removed from. This value is an\n Amazon Resource Name (ARN). </p>",
"smithy.api#required": {}
}
},
"TagKeys": {
"target": "com.amazonaws.timestreamwrite#TagKeyList",
"traits": {
"smithy.api#documentation": "<p> A list of tags keys. Existing tags of the resource whose keys are members of this list\n will be removed from the Timestream resource. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#UntagResourceResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#UpdateDatabase": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#UpdateDatabaseRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#UpdateDatabaseResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p> Modifies the KMS key for an existing database. While updating the\n database, you must specify the database name and the identifier of the new KMS key to be used (<code>KmsKeyId</code>). If there are any concurrent\n <code>UpdateDatabase</code> requests, first writer wins. </p>\n <p>See <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html\">code sample</a>\n for details.</p>"
}
},
"com.amazonaws.timestreamwrite#UpdateDatabaseRequest": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p> The name of the database. </p>",
"smithy.api#required": {}
}
},
"KmsKeyId": {
"target": "com.amazonaws.timestreamwrite#StringValue2048",
"traits": {
"smithy.api#documentation": "<p> The identifier of the new KMS key (<code>KmsKeyId</code>) to be used to\n encrypt the data stored in the database. If the <code>KmsKeyId</code> currently registered\n with the database is the same as the <code>KmsKeyId</code> in the request, there will not\n be any update. </p>\n <p>You can specify the <code>KmsKeyId</code> using any of the following:</p>\n <ul>\n <li>\n <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>\n </p>\n </li>\n <li>\n <p>Key ARN:\n <code>arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>\n </p>\n </li>\n <li>\n <p>Alias name: <code>alias/ExampleAlias</code>\n </p>\n </li>\n <li>\n <p>Alias ARN:\n <code>arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias</code>\n </p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#UpdateDatabaseResponse": {
"type": "structure",
"members": {
"Database": {
"target": "com.amazonaws.timestreamwrite#Database"
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#UpdateTable": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#UpdateTableRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#UpdateTableResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>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.\n For example, if the retention period of the memory store was initially set to 2 hours and\n then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but\n 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. </p>\n <p>See <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html\">code\n sample</a> for details.</p>"
}
},
"com.amazonaws.timestreamwrite#UpdateTableRequest": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream database.</p>",
"smithy.api#required": {}
}
},
"TableName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream table.</p>",
"smithy.api#required": {}
}
},
"RetentionProperties": {
"target": "com.amazonaws.timestreamwrite#RetentionProperties",
"traits": {
"smithy.api#documentation": "<p>The retention duration of the memory store and the magnetic store.</p>"
}
},
"MagneticStoreWriteProperties": {
"target": "com.amazonaws.timestreamwrite#MagneticStoreWriteProperties",
"traits": {
"smithy.api#documentation": "<p>Contains properties to set on the table when enabling magnetic store writes.</p>"
}
},
"Schema": {
"target": "com.amazonaws.timestreamwrite#Schema",
"traits": {
"smithy.api#documentation": "<p> The schema of the table. </p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#UpdateTableResponse": {
"type": "structure",
"members": {
"Table": {
"target": "com.amazonaws.timestreamwrite#Table",
"traits": {
"smithy.api#documentation": "<p>The updated Timestream table.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamwrite#ValidationException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamwrite#ErrorMessage",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p> An invalid or malformed request.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.timestreamwrite#WriteRecords": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamwrite#WriteRecordsRequest"
},
"output": {
"target": "com.amazonaws.timestreamwrite#WriteRecordsResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamwrite#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamwrite#InternalServerException"
},
{
"target": "com.amazonaws.timestreamwrite#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamwrite#RejectedRecordsException"
},
{
"target": "com.amazonaws.timestreamwrite#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamwrite#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamwrite#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Enables you to write your time-series data into Timestream. You can specify a\n 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\n types for your Timestream tables based on the dimension names and data types of\n the data points you specify when invoking writes into the database. </p>\n <p>Timestream supports eventual consistency read semantics. This means that when\n you query data immediately after writing a batch of data into Timestream, the\n query results might not reflect the results of a recently completed write operation. The\n results may also include some stale data. If you repeat the query request after a short\n time, the results should return the latest data. <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Service quotas apply</a>. </p>\n <p>See <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html\">code sample</a> for\n details.</p>\n <p>\n <b>Upserts</b>\n </p>\n <p>You can use the <code>Version</code> parameter in a <code>WriteRecords</code> request to\n update data points. Timestream tracks a version number with each record.\n <code>Version</code> defaults to <code>1</code> when it's not specified for the record\n in the request. Timestream updates an existing record\u2019s measure value along with\n its <code>Version</code> when it receives a write request with a higher\n <code>Version</code> number for that record. When it receives an update request where\n the measure value is the same as that of the existing record, Timestream still\n updates <code>Version</code>, if it is greater than the existing value of\n <code>Version</code>. You can update a data point as many times as desired, as long as\n the value of <code>Version</code> continuously increases. </p>\n <p> For example, suppose you write a new record without indicating <code>Version</code> in\n the request. Timestream stores this record, and set <code>Version</code> to\n <code>1</code>. Now, suppose you try to update this record with a\n <code>WriteRecords</code> request of the same record with a different measure value but,\n like before, do not provide <code>Version</code>. In this case, Timestream will\n reject this update with a <code>RejectedRecordsException</code> since the updated record\u2019s\n version is not greater than the existing value of Version. </p>\n <p>However, if you were to resend the update request with <code>Version</code> set to\n <code>2</code>, Timestream would then succeed in updating the record\u2019s value,\n and the <code>Version</code> would be set to <code>2</code>. Next, suppose you sent a\n <code>WriteRecords</code> request with this same record and an identical measure value,\n but with <code>Version</code> set to <code>3</code>. In this case, Timestream\n would only update <code>Version</code> to <code>3</code>. Any further updates would need to\n send a version number greater than <code>3</code>, or the update requests would receive a\n <code>RejectedRecordsException</code>. </p>"
}
},
"com.amazonaws.timestreamwrite#WriteRecordsRequest": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream database.</p>",
"smithy.api#required": {}
}
},
"TableName": {
"target": "com.amazonaws.timestreamwrite#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Timestream table.</p>",
"smithy.api#required": {}
}
},
"CommonAttributes": {
"target": "com.amazonaws.timestreamwrite#Record",
"traits": {
"smithy.api#documentation": "<p>A record that contains the common measure, dimension, time, and version attributes\n shared across all the records in the request. The measure and dimension attributes\n specified will be merged with the measure and dimension attributes in the records object\n when the data is written into Timestream. Dimensions may not overlap, or a\n <code>ValidationException</code> will be thrown. In other words, a record must contain\n dimensions with unique names. </p>"
}
},
"Records": {
"target": "com.amazonaws.timestreamwrite#Records",
"traits": {
"smithy.api#documentation": "<p>An array of records that contain the unique measure, dimension, time, and version\n attributes for each time-series data point. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamwrite#WriteRecordsResponse": {
"type": "structure",
"members": {
"RecordsIngested": {
"target": "com.amazonaws.timestreamwrite#RecordsIngested",
"traits": {
"smithy.api#documentation": "<p>Information on the records ingested by this request.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#AccessDeniedException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamquery#ServiceErrorMessage"
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "AccessDenied",
"httpResponseCode": 403
},
"smithy.api#documentation": "<p>You do not have the necessary permissions to access the account settings.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 403
}
},
"com.amazonaws.timestreamquery#AccountSettingsNotificationConfiguration": {
"type": "structure",
"members": {
"SnsConfiguration": {
"target": "com.amazonaws.timestreamquery#SnsConfiguration"
},
"RoleArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>An Amazon Resource Name (ARN) that grants Timestream permission to publish notifications. This field is only visible if SNS Topic is provided when updating the account settings.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration settings for notifications related to account settings.</p>"
}
},
"com.amazonaws.timestreamquery#AmazonResourceName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 2048
}
}
},
"com.amazonaws.timestreamquery#CancelQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#CancelQueryRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#CancelQueryResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p> Cancels a query that has been issued. Cancellation is provided only if the query has\n not completed running before the cancellation request was issued. Because cancellation\n is an idempotent operation, subsequent cancellation requests will return a\n <code>CancellationMessage</code>, indicating that the query has already been\n canceled. See <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html\">code\n sample</a> for details. </p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.timestreamquery#CancelQueryRequest": {
"type": "structure",
"members": {
"QueryId": {
"target": "com.amazonaws.timestreamquery#QueryId",
"traits": {
"smithy.api#documentation": "<p> The ID of the query that needs to be cancelled. <code>QueryID</code> is returned as\n part of the query result. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#CancelQueryResponse": {
"type": "structure",
"members": {
"CancellationMessage": {
"target": "com.amazonaws.timestreamquery#String",
"traits": {
"smithy.api#documentation": "<p> A <code>CancellationMessage</code> is returned when a <code>CancelQuery</code>\n request for the query specified by <code>QueryId</code> has already been issued. </p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#ClientRequestToken": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 32,
"max": 128
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.timestreamquery#ClientToken": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 32,
"max": 128
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.timestreamquery#ColumnInfo": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.timestreamquery#String",
"traits": {
"smithy.api#documentation": "<p> The name of the result set column. The name of the result set is available for\n columns of all data types except for arrays. </p>"
}
},
"Type": {
"target": "com.amazonaws.timestreamquery#Type",
"traits": {
"smithy.api#documentation": "<p>The data type of the result set column. The data type can be a scalar or complex.\n Scalar data types are integers, strings, doubles, Booleans, and others. Complex data\n types are types such as arrays, rows, and others. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p> Contains the metadata for query results such as the column names, data types, and\n other attributes. </p>"
}
},
"com.amazonaws.timestreamquery#ColumnInfoList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#ColumnInfo"
}
},
"com.amazonaws.timestreamquery#ComputeMode": {
"type": "enum",
"members": {
"ON_DEMAND": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ON_DEMAND"
}
},
"PROVISIONED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PROVISIONED"
}
}
}
},
"com.amazonaws.timestreamquery#ConflictException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamquery#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p> Unable to poll results for a cancelled query. </p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.timestreamquery#CreateScheduledQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#CreateScheduledQueryRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#CreateScheduledQueryResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#ConflictException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p> Create a scheduled query that will be run on your behalf at the configured schedule.\n Timestream assumes the execution role provided as part of the\n <code>ScheduledQueryExecutionRoleArn</code> parameter to run the query. You can use\n the <code>NotificationConfiguration</code> parameter to configure notification for your\n scheduled query operations.</p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.timestreamquery#CreateScheduledQueryRequest": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryName",
"traits": {
"smithy.api#documentation": "<p>Name of the scheduled query.</p>",
"smithy.api#required": {}
}
},
"QueryString": {
"target": "com.amazonaws.timestreamquery#QueryString",
"traits": {
"smithy.api#documentation": "<p>The query string to run. Parameter names can be specified in the query string\n <code>@</code> character followed by an identifier. The named Parameter\n <code>@scheduled_runtime</code> is reserved and can be used in the query to get the\n time at which the query is scheduled to run.</p>\n <p>The timestamp calculated according to the ScheduleConfiguration parameter, will be the\n value of <code>@scheduled_runtime</code> paramater for each query run. For example,\n consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this\n instance, the <code>@scheduled_runtime</code> parameter is initialized to the timestamp\n 2021-12-01 00:00:00 when invoking the query.</p>",
"smithy.api#required": {}
}
},
"ScheduleConfiguration": {
"target": "com.amazonaws.timestreamquery#ScheduleConfiguration",
"traits": {
"smithy.api#documentation": "<p>The schedule configuration for the query.</p>",
"smithy.api#required": {}
}
},
"NotificationConfiguration": {
"target": "com.amazonaws.timestreamquery#NotificationConfiguration",
"traits": {
"smithy.api#documentation": "<p>Notification configuration for the scheduled query. A notification is sent by\n Timestream when a query run finishes, when the state is updated or when you delete it.\n </p>",
"smithy.api#required": {}
}
},
"TargetConfiguration": {
"target": "com.amazonaws.timestreamquery#TargetConfiguration",
"traits": {
"smithy.api#documentation": "<p>Configuration used for writing the result of a query.</p>"
}
},
"ClientToken": {
"target": "com.amazonaws.timestreamquery#ClientToken",
"traits": {
"smithy.api#documentation": "<p>Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words,\n making the same request repeatedly will produce the same result. Making multiple\n identical CreateScheduledQuery requests has the same effect as making a single request. </p>\n <ul>\n <li>\n <p> If CreateScheduledQuery is called without a <code>ClientToken</code>, the\n Query SDK generates a <code>ClientToken</code> on your behalf.</p>\n </li>\n <li>\n <p> After 8 hours, any request with the same <code>ClientToken</code> is treated\n as a new request. </p>\n </li>\n </ul>",
"smithy.api#idempotencyToken": {}
}
},
"ScheduledQueryExecutionRoleArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN for the IAM role that Timestream will assume when running the scheduled query.\n </p>",
"smithy.api#required": {}
}
},
"Tags": {
"target": "com.amazonaws.timestreamquery#TagList",
"traits": {
"smithy.api#documentation": "<p>A list of key-value pairs to label the scheduled query.</p>"
}
},
"KmsKeyId": {
"target": "com.amazonaws.timestreamquery#StringValue2048",
"traits": {
"smithy.api#documentation": "<p>The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the\n Amazon KMS key is not specified, the scheduled query resource will be encrypted with a\n Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias\n name, or alias ARN. When using an alias name, prefix the name with\n <i>alias/</i>\n </p>\n <p>If ErrorReportConfiguration uses <code>SSE_KMS</code> as encryption type, the same\n KmsKeyId is used to encrypt the error report at rest.</p>"
}
},
"ErrorReportConfiguration": {
"target": "com.amazonaws.timestreamquery#ErrorReportConfiguration",
"traits": {
"smithy.api#documentation": "<p>Configuration for error reporting. Error reports will be generated when a problem is\n encountered when writing the query results. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#CreateScheduledQueryResponse": {
"type": "structure",
"members": {
"Arn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>ARN for the created scheduled query.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#Datum": {
"type": "structure",
"members": {
"ScalarValue": {
"target": "com.amazonaws.timestreamquery#ScalarValue",
"traits": {
"smithy.api#documentation": "<p> Indicates if the data point is a scalar value such as integer, string, double, or\n Boolean. </p>"
}
},
"TimeSeriesValue": {
"target": "com.amazonaws.timestreamquery#TimeSeriesDataPointList",
"traits": {
"smithy.api#documentation": "<p> Indicates if the data point is a timeseries data type. </p>"
}
},
"ArrayValue": {
"target": "com.amazonaws.timestreamquery#DatumList",
"traits": {
"smithy.api#documentation": "<p> Indicates if the data point is an array. </p>"
}
},
"RowValue": {
"target": "com.amazonaws.timestreamquery#Row",
"traits": {
"smithy.api#documentation": "<p> Indicates if the data point is a row. </p>"
}
},
"NullValue": {
"target": "com.amazonaws.timestreamquery#NullableBoolean",
"traits": {
"smithy.api#documentation": "<p> Indicates if the data point is null. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p> Datum represents a single data point in a query result. </p>"
}
},
"com.amazonaws.timestreamquery#DatumList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#Datum"
}
},
"com.amazonaws.timestreamquery#DeleteScheduledQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#DeleteScheduledQueryRequest"
},
"output": {
"target": "smithy.api#Unit"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Deletes a given scheduled query. This is an irreversible operation. </p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.timestreamquery#DeleteScheduledQueryRequest": {
"type": "structure",
"members": {
"ScheduledQueryArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the scheduled query. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#DescribeAccountSettings": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#DescribeAccountSettingsRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#DescribeAccountSettingsResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.</p>\n <p>You're charged only for the duration of compute units used for your workloads.</p>"
}
},
"com.amazonaws.timestreamquery#DescribeAccountSettingsRequest": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#DescribeAccountSettingsResponse": {
"type": "structure",
"members": {
"MaxQueryTCU": {
"target": "com.amazonaws.timestreamquery#MaxQueryCapacity",
"traits": {
"smithy.api#documentation": "<p>The maximum number of <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/tcu.html\">Timestream compute units</a> (TCUs) the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. This configuration is applicable only for on-demand usage of (TCUs). \n \n \n </p>"
}
},
"QueryPricingModel": {
"target": "com.amazonaws.timestreamquery#QueryPricingModel",
"traits": {
"smithy.api#documentation": "<p>The pricing model for queries in your account.</p>\n <note>\n <p>The <code>QueryPricingModel</code> parameter is used by several Timestream operations; however, the <code>UpdateAccountSettings</code> API operation doesn't recognize any values other than <code>COMPUTE_UNITS</code>.</p>\n </note>"
}
},
"QueryCompute": {
"target": "com.amazonaws.timestreamquery#QueryComputeResponse",
"traits": {
"smithy.api#documentation": "<p>An object that contains the usage settings for Timestream Compute Units (TCUs) in your account for the query workload. </p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#DescribeEndpoints": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#DescribeEndpointsRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#DescribeEndpointsResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>DescribeEndpoints returns a list of available endpoints to make Timestream\n API calls against. This API is available through both Write and Query.</p>\n <p>Because the Timestream SDKs are designed to transparently work with the\n service\u2019s architecture, including the management and mapping of the service endpoints,\n <i>it is not recommended that you use this API unless</i>:</p>\n <ul>\n <li>\n <p>You are using <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints\">VPC endpoints (Amazon Web Services PrivateLink) with Timestream\n </a>\n </p>\n </li>\n <li>\n <p>Your application uses a programming language that does not yet have SDK\n support</p>\n </li>\n <li>\n <p>You require better control over the client-side implementation</p>\n </li>\n </ul>\n <p>For detailed information on how and when to use and implement DescribeEndpoints, see\n <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery\">The Endpoint Discovery Pattern</a>.</p>"
}
},
"com.amazonaws.timestreamquery#DescribeEndpointsRequest": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#DescribeEndpointsResponse": {
"type": "structure",
"members": {
"Endpoints": {
"target": "com.amazonaws.timestreamquery#Endpoints",
"traits": {
"smithy.api#documentation": "<p>An <code>Endpoints</code> object is returned when a <code>DescribeEndpoints</code>\n request is made.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#DescribeScheduledQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#DescribeScheduledQueryRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#DescribeScheduledQueryResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Provides detailed information about a scheduled query.</p>"
}
},
"com.amazonaws.timestreamquery#DescribeScheduledQueryRequest": {
"type": "structure",
"members": {
"ScheduledQueryArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the scheduled query.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#DescribeScheduledQueryResponse": {
"type": "structure",
"members": {
"ScheduledQuery": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryDescription",
"traits": {
"smithy.api#documentation": "<p>The scheduled query.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#DimensionMapping": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.timestreamquery#SchemaName",
"traits": {
"smithy.api#documentation": "<p>Column name from query result.</p>",
"smithy.api#required": {}
}
},
"DimensionValueType": {
"target": "com.amazonaws.timestreamquery#DimensionValueType",
"traits": {
"smithy.api#documentation": "<p>Type for the dimension. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>This type is used to map column(s) from the query result to a dimension in the\n destination table.</p>"
}
},
"com.amazonaws.timestreamquery#DimensionMappingList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#DimensionMapping"
}
},
"com.amazonaws.timestreamquery#DimensionValueType": {
"type": "enum",
"members": {
"VARCHAR": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "VARCHAR"
}
}
}
},
"com.amazonaws.timestreamquery#Double": {
"type": "double",
"traits": {
"smithy.api#default": 0
}
},
"com.amazonaws.timestreamquery#Endpoint": {
"type": "structure",
"members": {
"Address": {
"target": "com.amazonaws.timestreamquery#String",
"traits": {
"smithy.api#documentation": "<p>An endpoint address.</p>",
"smithy.api#required": {}
}
},
"CachePeriodInMinutes": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The TTL for the endpoint, in minutes.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents an available endpoint against which to make API calls against, as well as\n the TTL for that endpoint.</p>"
}
},
"com.amazonaws.timestreamquery#Endpoints": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#Endpoint"
}
},
"com.amazonaws.timestreamquery#ErrorMessage": {
"type": "string"
},
"com.amazonaws.timestreamquery#ErrorReportConfiguration": {
"type": "structure",
"members": {
"S3Configuration": {
"target": "com.amazonaws.timestreamquery#S3Configuration",
"traits": {
"smithy.api#documentation": "<p>The S3 configuration for the error reports.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration required for error reporting.</p>"
}
},
"com.amazonaws.timestreamquery#ErrorReportLocation": {
"type": "structure",
"members": {
"S3ReportLocation": {
"target": "com.amazonaws.timestreamquery#S3ReportLocation",
"traits": {
"smithy.api#documentation": "<p>The S3 location where error reports are written.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>This contains the location of the error report for a single scheduled query call.\n </p>"
}
},
"com.amazonaws.timestreamquery#ExecuteScheduledQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#ExecuteScheduledQueryRequest"
},
"output": {
"target": "smithy.api#Unit"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p> You can use this API to run a scheduled query manually. </p>\n <p>If you enabled <code>QueryInsights</code>, this API also returns insights and metrics related to the query that you executed as part of an Amazon SNS notification. <code>QueryInsights</code> helps with performance tuning of your query. For more information about <code>QueryInsights</code>, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html\">Using query insights to optimize queries in Amazon Timestream</a>.</p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.timestreamquery#ExecuteScheduledQueryRequest": {
"type": "structure",
"members": {
"ScheduledQueryArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>ARN of the scheduled query.</p>",
"smithy.api#required": {}
}
},
"InvocationTime": {
"target": "com.amazonaws.timestreamquery#Time",
"traits": {
"smithy.api#documentation": "<p>The timestamp in UTC. Query will be run as if it was invoked at this timestamp.\n </p>",
"smithy.api#required": {}
}
},
"ClientToken": {
"target": "com.amazonaws.timestreamquery#ClientToken",
"traits": {
"smithy.api#documentation": "<p>Not used. </p>",
"smithy.api#idempotencyToken": {}
}
},
"QueryInsights": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryInsights",
"traits": {
"smithy.api#documentation": "<p>Encapsulates settings for enabling <code>QueryInsights</code>.</p>\n <p>Enabling <code>QueryInsights</code> returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use <code>QueryInsights</code> to tune your query performance and cost.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#ExecutionStats": {
"type": "structure",
"members": {
"ExecutionTimeInMillis": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Total time, measured in milliseconds, that was needed for the scheduled query run to\n complete.</p>"
}
},
"DataWrites": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Data writes metered for records ingested in a single scheduled query run.</p>"
}
},
"BytesMetered": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Bytes metered for a single scheduled query run.</p>"
}
},
"CumulativeBytesScanned": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Bytes scanned for a single scheduled query run.</p>"
}
},
"RecordsIngested": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The number of records ingested for a single scheduled query run. </p>"
}
},
"QueryResultRows": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Number of rows present in the output from running a query before ingestion to\n destination data source.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Statistics for a single scheduled query run.</p>"
}
},
"com.amazonaws.timestreamquery#InternalServerException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamquery#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>An internal server error occurred while processing the request.</p>",
"smithy.api#error": "server",
"smithy.api#httpError": 500
}
},
"com.amazonaws.timestreamquery#InvalidEndpointException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamquery#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The requested endpoint is invalid.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 421
}
},
"com.amazonaws.timestreamquery#LastUpdate": {
"type": "structure",
"members": {
"TargetQueryTCU": {
"target": "com.amazonaws.timestreamquery#QueryTCU",
"traits": {
"smithy.api#documentation": "<p>The number of TimeStream Compute Units (TCUs) requested in the last account settings update.</p>"
}
},
"Status": {
"target": "com.amazonaws.timestreamquery#LastUpdateStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the last update. Can be either <code>PENDING</code>, <code>FAILED</code>, or <code>SUCCEEDED</code>.</p>"
}
},
"StatusMessage": {
"target": "com.amazonaws.timestreamquery#String",
"traits": {
"smithy.api#documentation": "<p>Error message describing the last account settings update status, visible only if an error occurred.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration object that contains the most recent account settings update, visible only if settings have been updated previously.</p>"
}
},
"com.amazonaws.timestreamquery#LastUpdateStatus": {
"type": "enum",
"members": {
"PENDING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PENDING"
}
},
"FAILED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "FAILED"
}
},
"SUCCEEDED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SUCCEEDED"
}
}
}
},
"com.amazonaws.timestreamquery#ListScheduledQueries": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#ListScheduledQueriesRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#ListScheduledQueriesResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Gets a list of all scheduled queries in the caller's Amazon account and Region.\n <code>ListScheduledQueries</code> is eventually consistent. </p>",
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"items": "ScheduledQueries",
"pageSize": "MaxResults"
}
}
},
"com.amazonaws.timestreamquery#ListScheduledQueriesRequest": {
"type": "structure",
"members": {
"MaxResults": {
"target": "com.amazonaws.timestreamquery#MaxScheduledQueriesResults",
"traits": {
"smithy.api#documentation": "<p>The maximum number of items to return in the output. If the total number of items\n available is more than the value specified, a <code>NextToken</code> is provided in the\n output. To resume pagination, provide the <code>NextToken</code> value as the argument\n to the subsequent call to <code>ListScheduledQueriesRequest</code>.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.timestreamquery#NextScheduledQueriesResultsToken",
"traits": {
"smithy.api#documentation": "<p> A pagination token to resume pagination.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#ListScheduledQueriesResponse": {
"type": "structure",
"members": {
"ScheduledQueries": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryList",
"traits": {
"smithy.api#documentation": "<p>A list of scheduled queries.</p>",
"smithy.api#required": {}
}
},
"NextToken": {
"target": "com.amazonaws.timestreamquery#NextScheduledQueriesResultsToken",
"traits": {
"smithy.api#documentation": "<p>A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#ListTagsForResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#ListTagsForResourceRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#ListTagsForResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>List all tags on a Timestream query resource.</p>",
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"items": "Tags",
"pageSize": "MaxResults"
}
}
},
"com.amazonaws.timestreamquery#ListTagsForResourceRequest": {
"type": "structure",
"members": {
"ResourceARN": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Timestream resource with tags to be listed. This value is an Amazon Resource Name\n (ARN).</p>",
"smithy.api#required": {}
}
},
"MaxResults": {
"target": "com.amazonaws.timestreamquery#MaxTagsForResourceResult",
"traits": {
"smithy.api#documentation": "<p>The maximum number of tags to return.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.timestreamquery#NextTagsForResourceResultsToken",
"traits": {
"smithy.api#documentation": "<p>A pagination token to resume pagination.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#ListTagsForResourceResponse": {
"type": "structure",
"members": {
"Tags": {
"target": "com.amazonaws.timestreamquery#TagList",
"traits": {
"smithy.api#documentation": "<p>The tags currently associated with the Timestream resource. </p>",
"smithy.api#required": {}
}
},
"NextToken": {
"target": "com.amazonaws.timestreamquery#NextTagsForResourceResultsToken",
"traits": {
"smithy.api#documentation": "<p>A pagination token to resume pagination with a subsequent call to\n <code>ListTagsForResourceResponse</code>.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#Long": {
"type": "long",
"traits": {
"smithy.api#default": 0
}
},
"com.amazonaws.timestreamquery#MaxQueryCapacity": {
"type": "integer"
},
"com.amazonaws.timestreamquery#MaxQueryResults": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 1000
}
}
},
"com.amazonaws.timestreamquery#MaxScheduledQueriesResults": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 1000
}
}
},
"com.amazonaws.timestreamquery#MaxTagsForResourceResult": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 200
}
}
},
"com.amazonaws.timestreamquery#MeasureValueType": {
"type": "enum",
"members": {
"BIGINT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BIGINT"
}
},
"BOOLEAN": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BOOLEAN"
}
},
"DOUBLE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DOUBLE"
}
},
"VARCHAR": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "VARCHAR"
}
},
"MULTI": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MULTI"
}
}
}
},
"com.amazonaws.timestreamquery#MixedMeasureMapping": {
"type": "structure",
"members": {
"MeasureName": {
"target": "com.amazonaws.timestreamquery#SchemaName",
"traits": {
"smithy.api#documentation": "<p>Refers to the value of measure_name in a result row. This field is required if\n MeasureNameColumn is provided.</p>"
}
},
"SourceColumn": {
"target": "com.amazonaws.timestreamquery#SchemaName",
"traits": {
"smithy.api#documentation": "<p>This field refers to the source column from which measure-value is to be read for\n result materialization.</p>"
}
},
"TargetMeasureName": {
"target": "com.amazonaws.timestreamquery#SchemaName",
"traits": {
"smithy.api#documentation": "<p>Target measure name to be used. If not provided, the target measure name by default\n would be measure-name if provided, or sourceColumn otherwise. </p>"
}
},
"MeasureValueType": {
"target": "com.amazonaws.timestreamquery#MeasureValueType",
"traits": {
"smithy.api#documentation": "<p>Type of the value that is to be read from sourceColumn. If the mapping is for MULTI,\n use MeasureValueType.MULTI.</p>",
"smithy.api#required": {}
}
},
"MultiMeasureAttributeMappings": {
"target": "com.amazonaws.timestreamquery#MultiMeasureAttributeMappingList",
"traits": {
"smithy.api#documentation": "<p>Required when measureValueType is MULTI. Attribute mappings for MULTI value\n measures.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>MixedMeasureMappings are mappings that can be used to ingest data into a mixture of\n narrow and multi measures in the derived table.</p>"
}
},
"com.amazonaws.timestreamquery#MixedMeasureMappingList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#MixedMeasureMapping"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.timestreamquery#MultiMeasureAttributeMapping": {
"type": "structure",
"members": {
"SourceColumn": {
"target": "com.amazonaws.timestreamquery#SchemaName",
"traits": {
"smithy.api#documentation": "<p>Source column from where the attribute value is to be read.</p>",
"smithy.api#required": {}
}
},
"TargetMultiMeasureAttributeName": {
"target": "com.amazonaws.timestreamquery#SchemaName",
"traits": {
"smithy.api#documentation": "<p>Custom name to be used for attribute name in derived table. If not provided, source\n column name would be used.</p>"
}
},
"MeasureValueType": {
"target": "com.amazonaws.timestreamquery#ScalarMeasureValueType",
"traits": {
"smithy.api#documentation": "<p>Type of the attribute to be read from the source column.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Attribute mapping for MULTI value measures.</p>"
}
},
"com.amazonaws.timestreamquery#MultiMeasureAttributeMappingList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#MultiMeasureAttributeMapping"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.timestreamquery#MultiMeasureMappings": {
"type": "structure",
"members": {
"TargetMultiMeasureName": {
"target": "com.amazonaws.timestreamquery#SchemaName",
"traits": {
"smithy.api#documentation": "<p>The name of the target multi-measure name in the derived table. This input is required\n when measureNameColumn is not provided. If MeasureNameColumn is provided, then value\n from that column will be used as multi-measure name.</p>"
}
},
"MultiMeasureAttributeMappings": {
"target": "com.amazonaws.timestreamquery#MultiMeasureAttributeMappingList",
"traits": {
"smithy.api#documentation": "<p>Required. Attribute mappings to be used for mapping query results to ingest data for\n multi-measure attributes.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided.\n MultiMeasureMappings can be used to ingest data as multi measures in the derived\n table.</p>"
}
},
"com.amazonaws.timestreamquery#NextScheduledQueriesResultsToken": {
"type": "string"
},
"com.amazonaws.timestreamquery#NextTagsForResourceResultsToken": {
"type": "string"
},
"com.amazonaws.timestreamquery#NotificationConfiguration": {
"type": "structure",
"members": {
"SnsConfiguration": {
"target": "com.amazonaws.timestreamquery#SnsConfiguration",
"traits": {
"smithy.api#documentation": "<p>Details about the Amazon Simple Notification Service (SNS) configuration. This field is visible only when SNS Topic is provided when updating the account settings. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Notification configuration for a scheduled query. A notification is sent by Timestream\n when a scheduled query is created, its state is updated or when it is deleted. </p>"
}
},
"com.amazonaws.timestreamquery#NullableBoolean": {
"type": "boolean"
},
"com.amazonaws.timestreamquery#PaginationToken": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 2048
}
}
},
"com.amazonaws.timestreamquery#ParameterMapping": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.timestreamquery#String",
"traits": {
"smithy.api#documentation": "<p>Parameter name.</p>",
"smithy.api#required": {}
}
},
"Type": {
"target": "com.amazonaws.timestreamquery#Type",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Mapping for named parameters.</p>"
}
},
"com.amazonaws.timestreamquery#ParameterMappingList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#ParameterMapping"
}
},
"com.amazonaws.timestreamquery#PartitionKey": {
"type": "string"
},
"com.amazonaws.timestreamquery#PartitionKeyList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#PartitionKey"
}
},
"com.amazonaws.timestreamquery#PrepareQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#PrepareQueryRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#PrepareQueryResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>A synchronous operation that allows you to submit a query with parameters to be stored\n by Timestream for later running. Timestream only supports using this operation with\n <code>ValidateOnly</code> set to <code>true</code>. </p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.timestreamquery#PrepareQueryRequest": {
"type": "structure",
"members": {
"QueryString": {
"target": "com.amazonaws.timestreamquery#QueryString",
"traits": {
"smithy.api#documentation": "<p>The Timestream query string that you want to use as a prepared statement. Parameter\n names can be specified in the query string <code>@</code> character followed by an\n identifier. </p>",
"smithy.api#required": {}
}
},
"ValidateOnly": {
"target": "com.amazonaws.timestreamquery#NullableBoolean",
"traits": {
"smithy.api#documentation": "<p>By setting this value to <code>true</code>, Timestream will only validate that the\n query string is a valid Timestream query, and not store the prepared query for later\n use.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#PrepareQueryResponse": {
"type": "structure",
"members": {
"QueryString": {
"target": "com.amazonaws.timestreamquery#QueryString",
"traits": {
"smithy.api#documentation": "<p>The query string that you want prepare.</p>",
"smithy.api#required": {}
}
},
"Columns": {
"target": "com.amazonaws.timestreamquery#SelectColumnList",
"traits": {
"smithy.api#documentation": "<p>A list of SELECT clause columns of the submitted query string. </p>",
"smithy.api#required": {}
}
},
"Parameters": {
"target": "com.amazonaws.timestreamquery#ParameterMappingList",
"traits": {
"smithy.api#documentation": "<p>A list of parameters used in the submitted query string. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#ProvisionedCapacityRequest": {
"type": "structure",
"members": {
"TargetQueryTCU": {
"target": "com.amazonaws.timestreamquery#QueryTCU",
"traits": {
"smithy.api#documentation": "<p>The target compute capacity for querying data, specified in Timestream Compute Units (TCUs).</p>",
"smithy.api#required": {}
}
},
"NotificationConfiguration": {
"target": "com.amazonaws.timestreamquery#AccountSettingsNotificationConfiguration",
"traits": {
"smithy.api#documentation": "<p>Configuration settings for notifications related to the provisioned capacity update.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to update the provisioned capacity settings for querying data.</p>"
}
},
"com.amazonaws.timestreamquery#ProvisionedCapacityResponse": {
"type": "structure",
"members": {
"ActiveQueryTCU": {
"target": "com.amazonaws.timestreamquery#QueryTCU",
"traits": {
"smithy.api#documentation": "<p>The number of Timestream Compute Units (TCUs) provisioned in the account. This field is only visible when the compute mode is <code>PROVISIONED</code>.</p>"
}
},
"NotificationConfiguration": {
"target": "com.amazonaws.timestreamquery#AccountSettingsNotificationConfiguration",
"traits": {
"smithy.api#documentation": "<p>An object that contains settings for notifications that are sent whenever the provisioned capacity settings are modified. This field is only visible when the compute mode is <code>PROVISIONED</code>.</p>"
}
},
"LastUpdate": {
"target": "com.amazonaws.timestreamquery#LastUpdate",
"traits": {
"smithy.api#documentation": "<p>Information about the last update to the provisioned capacity settings.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to a request to update the provisioned capacity settings for querying data.</p>"
}
},
"com.amazonaws.timestreamquery#Query": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#QueryRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#QueryResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#ConflictException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#QueryExecutionException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>\n <code>Query</code> is a synchronous operation that enables you to run a query against\n your Amazon Timestream data.</p>\n <p>If you enabled <code>QueryInsights</code>, this API also returns insights and metrics related to the query that you executed. <code>QueryInsights</code> helps with performance tuning of your query. For more information about <code>QueryInsights</code>, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html\">Using query insights to optimize queries in Amazon Timestream</a>.</p>\n <note>\n <p>The maximum number of <code>Query</code> API requests you're allowed to make with <code>QueryInsights</code> enabled is 1 query per second (QPS). If you exceed this query rate, it might result in throttling.</p>\n </note>\n <p>\n <code>Query</code> will time out after 60 seconds.\n You must update the default timeout in the SDK to support a timeout of 60 seconds. See\n the <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html\">code\n sample</a> for details. </p>\n <p>Your query request will fail in the following cases:</p>\n <ul>\n <li>\n <p> If you submit a <code>Query</code> request with the same client token outside\n of the 5-minute idempotency window. </p>\n </li>\n <li>\n <p> If you submit a <code>Query</code> request with the same client token, but\n change other parameters, within the 5-minute idempotency window. </p>\n </li>\n <li>\n <p> If the size of the row (including the query metadata) exceeds 1 MB, then the\n query will fail with the following error message: </p>\n <p>\n <code>Query aborted as max page response size has been exceeded by the output\n result row</code>\n </p>\n </li>\n <li>\n <p> If the IAM principal of the query initiator and the result reader are not the\n same and/or the query initiator and the result reader do not have the same query\n string in the query requests, the query will fail with an <code>Invalid\n pagination token</code> error. </p>\n </li>\n </ul>",
"smithy.api#idempotent": {},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"items": "Rows",
"pageSize": "MaxRows"
}
}
},
"com.amazonaws.timestreamquery#QueryComputeRequest": {
"type": "structure",
"members": {
"ComputeMode": {
"target": "com.amazonaws.timestreamquery#ComputeMode",
"traits": {
"smithy.api#documentation": "<p>The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value <code>PROVISIONED</code>.</p>"
}
},
"ProvisionedCapacity": {
"target": "com.amazonaws.timestreamquery#ProvisionedCapacityRequest",
"traits": {
"smithy.api#documentation": "<p>Configuration object that contains settings for provisioned Timestream Compute Units (TCUs) in your account.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to retrieve or update the compute capacity settings for querying data.</p>"
}
},
"com.amazonaws.timestreamquery#QueryComputeResponse": {
"type": "structure",
"members": {
"ComputeMode": {
"target": "com.amazonaws.timestreamquery#ComputeMode",
"traits": {
"smithy.api#documentation": "<p>The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value <code>PROVISIONED</code>.</p>"
}
},
"ProvisionedCapacity": {
"target": "com.amazonaws.timestreamquery#ProvisionedCapacityResponse",
"traits": {
"smithy.api#documentation": "<p>Configuration object that contains settings for provisioned Timestream Compute Units (TCUs) in your account.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to a request to retrieve or update the compute capacity settings for querying data.</p>"
}
},
"com.amazonaws.timestreamquery#QueryExecutionException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamquery#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>\n Timestream was unable to run the query successfully. </p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.timestreamquery#QueryId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 64
},
"smithy.api#pattern": "^[a-zA-Z0-9]+$"
}
},
"com.amazonaws.timestreamquery#QueryInsights": {
"type": "structure",
"members": {
"Mode": {
"target": "com.amazonaws.timestreamquery#QueryInsightsMode",
"traits": {
"smithy.api#documentation": "<p>Provides the following modes to enable <code>QueryInsights</code>:</p>\n <ul>\n <li>\n <p>\n <code>ENABLED_WITH_RATE_CONTROL</code> \u2013 Enables <code>QueryInsights</code> for the queries being processed. This mode also includes a rate control mechanism, which limits the <code>QueryInsights</code> feature to 1 query per second (QPS).</p>\n </li>\n <li>\n <p>\n <code>DISABLED</code> \u2013 Disables <code>QueryInsights</code>.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>\n <code>QueryInsights</code> is a performance tuning feature that helps you optimize your queries, reducing costs and improving performance. With <code>QueryInsights</code>, you can assess the pruning efficiency of your queries and identify areas for improvement to enhance query performance. With <code>QueryInsights</code>, you can also analyze the effectiveness of your queries in terms of temporal and spatial pruning, and identify opportunities to improve performance. Specifically, you can evaluate how well your queries use time-based and partition key-based indexing strategies to optimize data retrieval. To optimize query performance, it's essential that you fine-tune both the temporal and spatial parameters that govern query execution.</p>\n <p>The key metrics provided by <code>QueryInsights</code> are <code>QuerySpatialCoverage</code> and <code>QueryTemporalRange</code>. <code>QuerySpatialCoverage</code> indicates how much of the spatial axis the query scans, with lower values being more efficient. <code>QueryTemporalRange</code> shows the time range scanned, with narrower ranges being more performant.</p>\n <p>\n <b>Benefits of QueryInsights</b>\n </p>\n <p>The following are the key benefits of using <code>QueryInsights</code>:</p>\n <ul>\n <li>\n <p>\n <b>Identifying inefficient queries</b> \u2013 <code>QueryInsights</code> provides information on the time-based and attribute-based pruning of the tables accessed by the query. This information helps you identify the tables that are sub-optimally accessed.</p>\n </li>\n <li>\n <p>\n <b>Optimizing your data model and partitioning</b> \u2013 You can use the <code>QueryInsights</code> information to access and fine-tune your data model and partitioning strategy.</p>\n </li>\n <li>\n <p>\n <b>Tuning queries</b> \u2013 <code>QueryInsights</code> highlights opportunities to use indexes more effectively.</p>\n </li>\n </ul>\n <note>\n <p>The maximum number of <code>Query</code> API requests you're allowed to make with <code>QueryInsights</code> enabled is 1 query per second (QPS). If you exceed this query rate, it might result in throttling.</p>\n </note>"
}
},
"com.amazonaws.timestreamquery#QueryInsightsMode": {
"type": "enum",
"members": {
"ENABLED_WITH_RATE_CONTROL": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ENABLED_WITH_RATE_CONTROL"
}
},
"DISABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DISABLED"
}
}
}
},
"com.amazonaws.timestreamquery#QueryInsightsResponse": {
"type": "structure",
"members": {
"QuerySpatialCoverage": {
"target": "com.amazonaws.timestreamquery#QuerySpatialCoverage",
"traits": {
"smithy.api#documentation": "<p>Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning. </p>"
}
},
"QueryTemporalRange": {
"target": "com.amazonaws.timestreamquery#QueryTemporalRange",
"traits": {
"smithy.api#documentation": "<p>Provides insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning:</p>\n <ul>\n <li>\n <p>Add missing time-predicates.</p>\n </li>\n <li>\n <p>Remove functions around the time predicates.</p>\n </li>\n <li>\n <p>Add time predicates to all the sub-queries.</p>\n </li>\n </ul>"
}
},
"QueryTableCount": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>Indicates the number of tables in the query.</p>"
}
},
"OutputRows": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>Indicates the total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise.</p>"
}
},
"OutputBytes": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>Indicates the size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise.</p>"
}
},
"UnloadPartitionCount": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>Indicates the partitions created by the <code>Unload</code> operation.</p>"
}
},
"UnloadWrittenRows": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>Indicates the rows written by the <code>Unload</code> query.</p>"
}
},
"UnloadWrittenBytes": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>Indicates the size, in bytes, written by the <code>Unload</code> operation.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides various insights and metrics related to the query that you executed.</p>"
}
},
"com.amazonaws.timestreamquery#QueryPricingModel": {
"type": "enum",
"members": {
"BYTES_SCANNED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BYTES_SCANNED"
}
},
"COMPUTE_UNITS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "COMPUTE_UNITS"
}
}
}
},
"com.amazonaws.timestreamquery#QueryRequest": {
"type": "structure",
"members": {
"QueryString": {
"target": "com.amazonaws.timestreamquery#QueryString",
"traits": {
"smithy.api#documentation": "<p> The query to be run by Timestream. </p>",
"smithy.api#required": {}
}
},
"ClientToken": {
"target": "com.amazonaws.timestreamquery#ClientRequestToken",
"traits": {
"smithy.api#documentation": "<p> Unique, case-sensitive string of up to 64 ASCII characters specified when a\n <code>Query</code> request is made. Providing a <code>ClientToken</code> makes the\n call to <code>Query</code>\n <i>idempotent</i>. This means that running the same query repeatedly will\n produce the same result. In other words, making multiple identical <code>Query</code>\n requests has the same effect as making a single request. When using\n <code>ClientToken</code> in a query, note the following: </p>\n <ul>\n <li>\n <p> If the Query API is instantiated without a <code>ClientToken</code>, the\n Query SDK generates a <code>ClientToken</code> on your behalf.</p>\n </li>\n <li>\n <p>If the <code>Query</code> invocation only contains the\n <code>ClientToken</code> but does not include a <code>NextToken</code>, that\n invocation of <code>Query</code> is assumed to be a new query run.</p>\n </li>\n <li>\n <p>If the invocation contains <code>NextToken</code>, that particular invocation\n is assumed to be a subsequent invocation of a prior call to the Query API, and a\n result set is returned.</p>\n </li>\n <li>\n <p> After 4 hours, any request with the same <code>ClientToken</code> is treated\n as a new request. </p>\n </li>\n </ul>",
"smithy.api#idempotencyToken": {}
}
},
"NextToken": {
"target": "com.amazonaws.timestreamquery#PaginationToken",
"traits": {
"smithy.api#documentation": "<p> A pagination token used to return a set of results. When the <code>Query</code> API\n is invoked using <code>NextToken</code>, that particular invocation is assumed to be a\n subsequent invocation of a prior call to <code>Query</code>, and a result set is\n returned. However, if the <code>Query</code> invocation only contains the\n <code>ClientToken</code>, that invocation of <code>Query</code> is assumed to be a\n new query run. </p>\n <p>Note the following when using NextToken in a query:</p>\n <ul>\n <li>\n <p>A pagination token can be used for up to five <code>Query</code> invocations,\n OR for a duration of up to 1 hour \u2013 whichever comes first.</p>\n </li>\n <li>\n <p>Using the same <code>NextToken</code> will return the same set of records. To\n keep paginating through the result set, you must to use the most recent\n <code>nextToken</code>.</p>\n </li>\n <li>\n <p>Suppose a <code>Query</code> invocation returns two <code>NextToken</code>\n values, <code>TokenA</code> and <code>TokenB</code>. If <code>TokenB</code> is\n used in a subsequent <code>Query</code> invocation, then <code>TokenA</code> is\n invalidated and cannot be reused.</p>\n </li>\n <li>\n <p>To request a previous result set from a query after pagination has begun, you\n must re-invoke the Query API.</p>\n </li>\n <li>\n <p>The latest <code>NextToken</code> should be used to paginate until\n <code>null</code> is returned, at which point a new <code>NextToken</code>\n should be used.</p>\n </li>\n <li>\n <p> If the IAM principal of the query initiator and the result reader are not the\n same and/or the query initiator and the result reader do not have the same query\n string in the query requests, the query will fail with an <code>Invalid\n pagination token</code> error. </p>\n </li>\n </ul>"
}
},
"MaxRows": {
"target": "com.amazonaws.timestreamquery#MaxQueryResults",
"traits": {
"smithy.api#documentation": "<p> The total number of rows to be returned in the <code>Query</code> output. The initial\n run of <code>Query</code> with a <code>MaxRows</code> value specified will return the\n result set of the query in two cases: </p>\n <ul>\n <li>\n <p>The size of the result is less than <code>1MB</code>.</p>\n </li>\n <li>\n <p>The number of rows in the result set is less than the value of\n <code>maxRows</code>.</p>\n </li>\n </ul>\n <p>Otherwise, the initial invocation of <code>Query</code> only returns a\n <code>NextToken</code>, which can then be used in subsequent calls to fetch the\n result set. To resume pagination, provide the <code>NextToken</code> value in the\n subsequent command.</p>\n <p>If the row size is large (e.g. a row has many columns), Timestream may return\n fewer rows to keep the response size from exceeding the 1 MB limit. If\n <code>MaxRows</code> is not provided, Timestream will send the necessary\n number of rows to meet the 1 MB limit.</p>"
}
},
"QueryInsights": {
"target": "com.amazonaws.timestreamquery#QueryInsights",
"traits": {
"smithy.api#documentation": "<p>Encapsulates settings for enabling <code>QueryInsights</code>.</p>\n <p>Enabling <code>QueryInsights</code> returns insights and metrics in addition to query results for the query that you executed. You can use <code>QueryInsights</code> to tune your query performance.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#QueryResponse": {
"type": "structure",
"members": {
"QueryId": {
"target": "com.amazonaws.timestreamquery#QueryId",
"traits": {
"smithy.api#documentation": "<p> A unique ID for the given query. </p>",
"smithy.api#required": {}
}
},
"NextToken": {
"target": "com.amazonaws.timestreamquery#PaginationToken",
"traits": {
"smithy.api#documentation": "<p> A pagination token that can be used again on a <code>Query</code> call to get the\n next set of results. </p>"
}
},
"Rows": {
"target": "com.amazonaws.timestreamquery#RowList",
"traits": {
"smithy.api#documentation": "<p> The result set rows returned by the query. </p>",
"smithy.api#required": {}
}
},
"ColumnInfo": {
"target": "com.amazonaws.timestreamquery#ColumnInfoList",
"traits": {
"smithy.api#documentation": "<p> The column data types of the returned result set. </p>",
"smithy.api#required": {}
}
},
"QueryStatus": {
"target": "com.amazonaws.timestreamquery#QueryStatus",
"traits": {
"smithy.api#documentation": "<p>Information about the status of the query, including progress and bytes\n scanned.</p>"
}
},
"QueryInsightsResponse": {
"target": "com.amazonaws.timestreamquery#QueryInsightsResponse",
"traits": {
"smithy.api#documentation": "<p>Encapsulates <code>QueryInsights</code> containing insights and metrics related to the query that you executed.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#QuerySpatialCoverage": {
"type": "structure",
"members": {
"Max": {
"target": "com.amazonaws.timestreamquery#QuerySpatialCoverageMax",
"traits": {
"smithy.api#documentation": "<p>Provides insights into the spatial coverage of the executed query and the table with the most inefficient spatial pruning.</p>\n <ul>\n <li>\n <p>\n <code>Value</code> \u2013 The maximum ratio of spatial coverage.</p>\n </li>\n <li>\n <p>\n <code>TableArn</code> \u2013 The Amazon Resource Name (ARN) of the table with sub-optimal spatial pruning.</p>\n </li>\n <li>\n <p>\n <code>PartitionKey</code> \u2013 The partition key used for partitioning, which can be a default <code>measure_name</code> or a CDPK.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning</p>\n <p>For example, you can do the following with the <code>QuerySpatialCoverage</code> information:</p>\n <ul>\n <li>\n <p>Add measure_name or use <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/customer-defined-partition-keys.html\">customer-defined partition key</a> (CDPK) predicates.</p>\n </li>\n <li>\n <p>If you've already done the preceding action, remove functions around them or clauses, such as <code>LIKE</code>.</p>\n </li>\n </ul>"
}
},
"com.amazonaws.timestreamquery#QuerySpatialCoverageMax": {
"type": "structure",
"members": {
"Value": {
"target": "com.amazonaws.timestreamquery#Double",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The maximum ratio of spatial coverage.</p>"
}
},
"TableArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the table with the most sub-optimal spatial pruning.</p>"
}
},
"PartitionKey": {
"target": "com.amazonaws.timestreamquery#PartitionKeyList",
"traits": {
"smithy.api#documentation": "<p>The partition key used for partitioning, which can be a default <code>measure_name</code> or a <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/customer-defined-partition-keys.html\">customer defined partition key</a>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides insights into the table with the most sub-optimal spatial range scanned by your query.</p>"
}
},
"com.amazonaws.timestreamquery#QueryStatus": {
"type": "structure",
"members": {
"ProgressPercentage": {
"target": "com.amazonaws.timestreamquery#Double",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The progress of the query, expressed as a percentage.</p>"
}
},
"CumulativeBytesScanned": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The amount of data scanned by the query in bytes. This is a cumulative sum and\n represents the total amount of bytes scanned since the query was started. </p>"
}
},
"CumulativeBytesMetered": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The amount of data scanned by the query in bytes that you will be charged for. This is\n a cumulative sum and represents the total amount of data that you will be charged for\n since the query was started. The charge is applied only once and is either applied when\n the query completes running or when the query is cancelled. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about the status of the query, including progress and bytes\n scanned.</p>"
}
},
"com.amazonaws.timestreamquery#QueryString": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 262144
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.timestreamquery#QueryTCU": {
"type": "integer"
},
"com.amazonaws.timestreamquery#QueryTemporalRange": {
"type": "structure",
"members": {
"Max": {
"target": "com.amazonaws.timestreamquery#QueryTemporalRangeMax",
"traits": {
"smithy.api#documentation": "<p>Encapsulates the following properties that provide insights into the most sub-optimal performing table on the temporal axis:</p>\n <ul>\n <li>\n <p>\n <code>Value</code> \u2013 The maximum duration in nanoseconds between the start and end of the query.</p>\n </li>\n <li>\n <p>\n <code>TableArn</code> \u2013 The Amazon Resource Name (ARN) of the table which is queried with the largest time range.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides insights into the temporal range of the query, including the table with the largest (max) time range.</p>"
}
},
"com.amazonaws.timestreamquery#QueryTemporalRangeMax": {
"type": "structure",
"members": {
"Value": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The maximum duration in nanoseconds between the start and end of the query.</p>"
}
},
"TableArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the table which is queried with the largest time range.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides insights into the table with the most sub-optimal temporal pruning scanned by your query.</p>"
}
},
"com.amazonaws.timestreamquery#ResourceName": {
"type": "string"
},
"com.amazonaws.timestreamquery#ResourceNotFoundException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamquery#ErrorMessage"
},
"ScheduledQueryArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the scheduled query.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The requested resource could not be found.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 404
}
},
"com.amazonaws.timestreamquery#Row": {
"type": "structure",
"members": {
"Data": {
"target": "com.amazonaws.timestreamquery#DatumList",
"traits": {
"smithy.api#documentation": "<p>List of data points in a single row of the result set.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a single row in the query results.</p>"
}
},
"com.amazonaws.timestreamquery#RowList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#Row"
}
},
"com.amazonaws.timestreamquery#S3BucketName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 3,
"max": 63
},
"smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$"
}
},
"com.amazonaws.timestreamquery#S3Configuration": {
"type": "structure",
"members": {
"BucketName": {
"target": "com.amazonaws.timestreamquery#S3BucketName",
"traits": {
"smithy.api#documentation": "<p> Name of the S3 bucket under which error reports will be created.</p>",
"smithy.api#required": {}
}
},
"ObjectKeyPrefix": {
"target": "com.amazonaws.timestreamquery#S3ObjectKeyPrefix",
"traits": {
"smithy.api#documentation": "<p> Prefix for the error report key. Timestream by default adds the following prefix to\n the error report path. </p>"
}
},
"EncryptionOption": {
"target": "com.amazonaws.timestreamquery#S3EncryptionOption",
"traits": {
"smithy.api#documentation": "<p> Encryption at rest options for the error reports. If no encryption option is\n specified, Timestream will choose SSE_S3 as default. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details on S3 location for error reports that result from running a query. </p>"
}
},
"com.amazonaws.timestreamquery#S3EncryptionOption": {
"type": "enum",
"members": {
"SSE_S3": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SSE_S3"
}
},
"SSE_KMS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SSE_KMS"
}
}
}
},
"com.amazonaws.timestreamquery#S3ObjectKey": {
"type": "string"
},
"com.amazonaws.timestreamquery#S3ObjectKeyPrefix": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 896
},
"smithy.api#pattern": "^[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+$"
}
},
"com.amazonaws.timestreamquery#S3ReportLocation": {
"type": "structure",
"members": {
"BucketName": {
"target": "com.amazonaws.timestreamquery#S3BucketName",
"traits": {
"smithy.api#documentation": "<p> S3 bucket name. </p>"
}
},
"ObjectKey": {
"target": "com.amazonaws.timestreamquery#S3ObjectKey",
"traits": {
"smithy.api#documentation": "<p>S3 key. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p> S3 report location for the scheduled query run.</p>"
}
},
"com.amazonaws.timestreamquery#ScalarMeasureValueType": {
"type": "enum",
"members": {
"BIGINT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BIGINT"
}
},
"BOOLEAN": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BOOLEAN"
}
},
"DOUBLE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DOUBLE"
}
},
"VARCHAR": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "VARCHAR"
}
},
"TIMESTAMP": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "TIMESTAMP"
}
}
}
},
"com.amazonaws.timestreamquery#ScalarType": {
"type": "enum",
"members": {
"VARCHAR": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "VARCHAR"
}
},
"BOOLEAN": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BOOLEAN"
}
},
"BIGINT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BIGINT"
}
},
"DOUBLE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DOUBLE"
}
},
"TIMESTAMP": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "TIMESTAMP"
}
},
"DATE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DATE"
}
},
"TIME": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "TIME"
}
},
"INTERVAL_DAY_TO_SECOND": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "INTERVAL_DAY_TO_SECOND"
}
},
"INTERVAL_YEAR_TO_MONTH": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "INTERVAL_YEAR_TO_MONTH"
}
},
"UNKNOWN": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "UNKNOWN"
}
},
"INTEGER": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "INTEGER"
}
}
}
},
"com.amazonaws.timestreamquery#ScalarValue": {
"type": "string"
},
"com.amazonaws.timestreamquery#ScheduleConfiguration": {
"type": "structure",
"members": {
"ScheduleExpression": {
"target": "com.amazonaws.timestreamquery#ScheduleExpression",
"traits": {
"smithy.api#documentation": "<p>An expression that denotes when to trigger the scheduled query run. This can be a cron\n expression or a rate expression. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration of the schedule of the query.</p>"
}
},
"com.amazonaws.timestreamquery#ScheduleExpression": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 256
}
}
},
"com.amazonaws.timestreamquery#ScheduledQuery": {
"type": "structure",
"members": {
"Arn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name.</p>",
"smithy.api#required": {}
}
},
"Name": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryName",
"traits": {
"smithy.api#documentation": "<p>The name of the scheduled query.</p>",
"smithy.api#required": {}
}
},
"CreationTime": {
"target": "com.amazonaws.timestreamquery#Time",
"traits": {
"smithy.api#documentation": "<p>The creation time of the scheduled query.</p>"
}
},
"State": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryState",
"traits": {
"smithy.api#documentation": "<p>State of scheduled query. </p>",
"smithy.api#required": {}
}
},
"PreviousInvocationTime": {
"target": "com.amazonaws.timestreamquery#Time",
"traits": {
"smithy.api#documentation": "<p>The last time the scheduled query was run.</p>"
}
},
"NextInvocationTime": {
"target": "com.amazonaws.timestreamquery#Time",
"traits": {
"smithy.api#documentation": "<p>The next time the scheduled query is to be run.</p>"
}
},
"ErrorReportConfiguration": {
"target": "com.amazonaws.timestreamquery#ErrorReportConfiguration",
"traits": {
"smithy.api#documentation": "<p>Configuration for scheduled query error reporting.</p>"
}
},
"TargetDestination": {
"target": "com.amazonaws.timestreamquery#TargetDestination",
"traits": {
"smithy.api#documentation": "<p>Target data source where final scheduled query result will be written.</p>"
}
},
"LastRunStatus": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryRunStatus",
"traits": {
"smithy.api#documentation": "<p>Status of the last scheduled query run.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Scheduled Query</p>"
}
},
"com.amazonaws.timestreamquery#ScheduledQueryDescription": {
"type": "structure",
"members": {
"Arn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>Scheduled query ARN.</p>",
"smithy.api#required": {}
}
},
"Name": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryName",
"traits": {
"smithy.api#documentation": "<p>Name of the scheduled query.</p>",
"smithy.api#required": {}
}
},
"QueryString": {
"target": "com.amazonaws.timestreamquery#QueryString",
"traits": {
"smithy.api#documentation": "<p>The query to be run.</p>",
"smithy.api#required": {}
}
},
"CreationTime": {
"target": "com.amazonaws.timestreamquery#Time",
"traits": {
"smithy.api#documentation": "<p>Creation time of the scheduled query.</p>"
}
},
"State": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryState",
"traits": {
"smithy.api#documentation": "<p>State of the scheduled query. </p>",
"smithy.api#required": {}
}
},
"PreviousInvocationTime": {
"target": "com.amazonaws.timestreamquery#Time",
"traits": {
"smithy.api#documentation": "<p>Last time the query was run.</p>"
}
},
"NextInvocationTime": {
"target": "com.amazonaws.timestreamquery#Time",
"traits": {
"smithy.api#documentation": "<p>The next time the scheduled query is scheduled to run.</p>"
}
},
"ScheduleConfiguration": {
"target": "com.amazonaws.timestreamquery#ScheduleConfiguration",
"traits": {
"smithy.api#documentation": "<p>Schedule configuration.</p>",
"smithy.api#required": {}
}
},
"NotificationConfiguration": {
"target": "com.amazonaws.timestreamquery#NotificationConfiguration",
"traits": {
"smithy.api#documentation": "<p>Notification configuration.</p>",
"smithy.api#required": {}
}
},
"TargetConfiguration": {
"target": "com.amazonaws.timestreamquery#TargetConfiguration",
"traits": {
"smithy.api#documentation": "<p>Scheduled query target store configuration.</p>"
}
},
"ScheduledQueryExecutionRoleArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>IAM role that Timestream uses to run the schedule query.</p>"
}
},
"KmsKeyId": {
"target": "com.amazonaws.timestreamquery#StringValue2048",
"traits": {
"smithy.api#documentation": "<p>A customer provided KMS key used to encrypt the scheduled query resource.</p>"
}
},
"ErrorReportConfiguration": {
"target": "com.amazonaws.timestreamquery#ErrorReportConfiguration",
"traits": {
"smithy.api#documentation": "<p>Error-reporting configuration for the scheduled query.</p>"
}
},
"LastRunSummary": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryRunSummary",
"traits": {
"smithy.api#documentation": "<p>Runtime summary for the last scheduled query run. </p>"
}
},
"RecentlyFailedRuns": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryRunSummaryList",
"traits": {
"smithy.api#documentation": "<p>Runtime summary for the last five failed scheduled query runs.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Structure that describes scheduled query.</p>"
}
},
"com.amazonaws.timestreamquery#ScheduledQueryInsights": {
"type": "structure",
"members": {
"Mode": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryInsightsMode",
"traits": {
"smithy.api#documentation": "<p>Provides the following modes to enable <code>ScheduledQueryInsights</code>:</p>\n <ul>\n <li>\n <p>\n <code>ENABLED_WITH_RATE_CONTROL</code> \u2013 Enables <code>ScheduledQueryInsights</code> for the queries being processed. This mode also includes a rate control mechanism, which limits the <code>QueryInsights</code> feature to 1 query per second (QPS).</p>\n </li>\n <li>\n <p>\n <code>DISABLED</code> \u2013 Disables <code>ScheduledQueryInsights</code>.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Encapsulates settings for enabling <code>QueryInsights</code> on an <code>ExecuteScheduledQueryRequest</code>.</p>"
}
},
"com.amazonaws.timestreamquery#ScheduledQueryInsightsMode": {
"type": "enum",
"members": {
"ENABLED_WITH_RATE_CONTROL": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ENABLED_WITH_RATE_CONTROL"
}
},
"DISABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DISABLED"
}
}
}
},
"com.amazonaws.timestreamquery#ScheduledQueryInsightsResponse": {
"type": "structure",
"members": {
"QuerySpatialCoverage": {
"target": "com.amazonaws.timestreamquery#QuerySpatialCoverage",
"traits": {
"smithy.api#documentation": "<p>Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning.</p>"
}
},
"QueryTemporalRange": {
"target": "com.amazonaws.timestreamquery#QueryTemporalRange",
"traits": {
"smithy.api#documentation": "<p>Provides insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning:</p>\n <ul>\n <li>\n <p>Add missing time-predicates.</p>\n </li>\n <li>\n <p>Remove functions around the time predicates.</p>\n </li>\n <li>\n <p>Add time predicates to all the sub-queries.</p>\n </li>\n </ul>"
}
},
"QueryTableCount": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>Indicates the number of tables in the query.</p>"
}
},
"OutputRows": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>Indicates the total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise.</p>"
}
},
"OutputBytes": {
"target": "com.amazonaws.timestreamquery#Long",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>Indicates the size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides various insights and metrics related to the <code>ExecuteScheduledQueryRequest</code> that was executed.</p>"
}
},
"com.amazonaws.timestreamquery#ScheduledQueryList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#ScheduledQuery"
}
},
"com.amazonaws.timestreamquery#ScheduledQueryName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 64
},
"smithy.api#pattern": "^[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+$"
}
},
"com.amazonaws.timestreamquery#ScheduledQueryRunStatus": {
"type": "enum",
"members": {
"AUTO_TRIGGER_SUCCESS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AUTO_TRIGGER_SUCCESS"
}
},
"AUTO_TRIGGER_FAILURE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AUTO_TRIGGER_FAILURE"
}
},
"MANUAL_TRIGGER_SUCCESS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MANUAL_TRIGGER_SUCCESS"
}
},
"MANUAL_TRIGGER_FAILURE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MANUAL_TRIGGER_FAILURE"
}
}
}
},
"com.amazonaws.timestreamquery#ScheduledQueryRunSummary": {
"type": "structure",
"members": {
"InvocationTime": {
"target": "com.amazonaws.timestreamquery#Time",
"traits": {
"smithy.api#documentation": "<p>InvocationTime for this run. This is the time at which the query is scheduled to run.\n Parameter <code>@scheduled_runtime</code> can be used in the query to get the value.\n </p>"
}
},
"TriggerTime": {
"target": "com.amazonaws.timestreamquery#Time",
"traits": {
"smithy.api#documentation": "<p>The actual time when the query was run.</p>"
}
},
"RunStatus": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryRunStatus",
"traits": {
"smithy.api#documentation": "<p>The status of a scheduled query run.</p>"
}
},
"ExecutionStats": {
"target": "com.amazonaws.timestreamquery#ExecutionStats",
"traits": {
"smithy.api#documentation": "<p>Runtime statistics for a scheduled run.</p>"
}
},
"QueryInsightsResponse": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryInsightsResponse",
"traits": {
"smithy.api#documentation": "<p>Provides various insights and metrics related to the run summary of the scheduled query.</p>"
}
},
"ErrorReportLocation": {
"target": "com.amazonaws.timestreamquery#ErrorReportLocation",
"traits": {
"smithy.api#documentation": "<p>S3 location for error report.</p>"
}
},
"FailureReason": {
"target": "com.amazonaws.timestreamquery#ErrorMessage",
"traits": {
"smithy.api#documentation": "<p>Error message for the scheduled query in case of failure. You might have to look at\n the error report to get more detailed error reasons. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Run summary for the scheduled query</p>"
}
},
"com.amazonaws.timestreamquery#ScheduledQueryRunSummaryList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryRunSummary"
}
},
"com.amazonaws.timestreamquery#ScheduledQueryState": {
"type": "enum",
"members": {
"ENABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ENABLED"
}
},
"DISABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DISABLED"
}
}
}
},
"com.amazonaws.timestreamquery#SchemaName": {
"type": "string"
},
"com.amazonaws.timestreamquery#SelectColumn": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.timestreamquery#String",
"traits": {
"smithy.api#documentation": "<p>Name of the column.</p>"
}
},
"Type": {
"target": "com.amazonaws.timestreamquery#Type"
},
"DatabaseName": {
"target": "com.amazonaws.timestreamquery#ResourceName",
"traits": {
"smithy.api#documentation": "<p> Database that has this column.</p>"
}
},
"TableName": {
"target": "com.amazonaws.timestreamquery#ResourceName",
"traits": {
"smithy.api#documentation": "<p>Table within the database that has this column. </p>"
}
},
"Aliased": {
"target": "com.amazonaws.timestreamquery#NullableBoolean",
"traits": {
"smithy.api#documentation": "<p>True, if the column name was aliased by the query. False otherwise.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details of the column that is returned by the query. </p>"
}
},
"com.amazonaws.timestreamquery#SelectColumnList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#SelectColumn"
}
},
"com.amazonaws.timestreamquery#ServiceErrorMessage": {
"type": "string"
},
"com.amazonaws.timestreamquery#ServiceQuotaExceededException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamquery#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>You have exceeded the service quota.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 402
}
},
"com.amazonaws.timestreamquery#SnsConfiguration": {
"type": "structure",
"members": {
"TopicArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>SNS topic ARN that the scheduled query status notifications will be sent to.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details on SNS that are required to send the notification.</p>"
}
},
"com.amazonaws.timestreamquery#String": {
"type": "string"
},
"com.amazonaws.timestreamquery#StringValue2048": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 2048
}
}
},
"com.amazonaws.timestreamquery#Tag": {
"type": "structure",
"members": {
"Key": {
"target": "com.amazonaws.timestreamquery#TagKey",
"traits": {
"smithy.api#documentation": "<p>The key of the tag. Tag keys are case sensitive. </p>",
"smithy.api#required": {}
}
},
"Value": {
"target": "com.amazonaws.timestreamquery#TagValue",
"traits": {
"smithy.api#documentation": "<p>The value of the tag. Tag values are case sensitive and can be null. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A tag is a label that you assign to a Timestream database and/or table. Each tag\n consists of a key and an optional value, both of which you define. Tags enable you to\n categorize databases and/or tables, for example, by purpose, owner, or environment.\n </p>"
}
},
"com.amazonaws.timestreamquery#TagKey": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 128
}
}
},
"com.amazonaws.timestreamquery#TagKeyList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#TagKey"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 200
}
}
},
"com.amazonaws.timestreamquery#TagList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#Tag"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 200
}
}
},
"com.amazonaws.timestreamquery#TagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#TagResourceRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#TagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamquery#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Associate a set of tags with a Timestream resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. </p>"
}
},
"com.amazonaws.timestreamquery#TagResourceRequest": {
"type": "structure",
"members": {
"ResourceARN": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>Identifies the Timestream resource to which tags should be added. This value is an\n Amazon Resource Name (ARN).</p>",
"smithy.api#required": {}
}
},
"Tags": {
"target": "com.amazonaws.timestreamquery#TagList",
"traits": {
"smithy.api#documentation": "<p>The tags to be assigned to the Timestream resource.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#TagResourceResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#TagValue": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 256
}
}
},
"com.amazonaws.timestreamquery#TargetConfiguration": {
"type": "structure",
"members": {
"TimestreamConfiguration": {
"target": "com.amazonaws.timestreamquery#TimestreamConfiguration",
"traits": {
"smithy.api#documentation": "<p>Configuration needed to write data into the Timestream database and table.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration used for writing the output of a query.</p>"
}
},
"com.amazonaws.timestreamquery#TargetDestination": {
"type": "structure",
"members": {
"TimestreamDestination": {
"target": "com.amazonaws.timestreamquery#TimestreamDestination",
"traits": {
"smithy.api#documentation": "<p>Query result destination details for Timestream data source.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Destination details to write data for a target data source. Current supported data\n source is Timestream.</p>"
}
},
"com.amazonaws.timestreamquery#ThrottlingException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamquery#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The request was throttled due to excessive requests.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 429
}
},
"com.amazonaws.timestreamquery#Time": {
"type": "timestamp"
},
"com.amazonaws.timestreamquery#TimeSeriesDataPoint": {
"type": "structure",
"members": {
"Time": {
"target": "com.amazonaws.timestreamquery#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The timestamp when the measure value was collected.</p>",
"smithy.api#required": {}
}
},
"Value": {
"target": "com.amazonaws.timestreamquery#Datum",
"traits": {
"smithy.api#documentation": "<p>The measure value for the data point.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The timeseries data type represents the values of a measure over time. A time series\n is an array of rows of timestamps and measure values, with rows sorted in ascending\n order of time. A TimeSeriesDataPoint is a single data point in the time series. It\n represents a tuple of (time, measure value) in a time series. </p>"
}
},
"com.amazonaws.timestreamquery#TimeSeriesDataPointList": {
"type": "list",
"member": {
"target": "com.amazonaws.timestreamquery#TimeSeriesDataPoint"
}
},
"com.amazonaws.timestreamquery#Timestamp": {
"type": "string"
},
"com.amazonaws.timestreamquery#TimestreamConfiguration": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamquery#ResourceName",
"traits": {
"smithy.api#documentation": "<p>Name of Timestream database to which the query result will be written.</p>",
"smithy.api#required": {}
}
},
"TableName": {
"target": "com.amazonaws.timestreamquery#ResourceName",
"traits": {
"smithy.api#documentation": "<p>Name of Timestream table that the query result will be written to. The table should be\n within the same database that is provided in Timestream configuration.</p>",
"smithy.api#required": {}
}
},
"TimeColumn": {
"target": "com.amazonaws.timestreamquery#SchemaName",
"traits": {
"smithy.api#documentation": "<p>Column from query result that should be used as the time column in destination table.\n Column type for this should be TIMESTAMP.</p>",
"smithy.api#required": {}
}
},
"DimensionMappings": {
"target": "com.amazonaws.timestreamquery#DimensionMappingList",
"traits": {
"smithy.api#documentation": "<p> This is to allow mapping column(s) from the query result to the dimension in the\n destination table. </p>",
"smithy.api#required": {}
}
},
"MultiMeasureMappings": {
"target": "com.amazonaws.timestreamquery#MultiMeasureMappings",
"traits": {
"smithy.api#documentation": "<p>Multi-measure mappings.</p>"
}
},
"MixedMeasureMappings": {
"target": "com.amazonaws.timestreamquery#MixedMeasureMappingList",
"traits": {
"smithy.api#documentation": "<p>Specifies how to map measures to multi-measure records.</p>"
}
},
"MeasureNameColumn": {
"target": "com.amazonaws.timestreamquery#SchemaName",
"traits": {
"smithy.api#documentation": "<p>Name of the measure column.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p> Configuration to write data into Timestream database and table. This configuration\n allows the user to map the query result select columns into the destination table\n columns. </p>"
}
},
"com.amazonaws.timestreamquery#TimestreamDestination": {
"type": "structure",
"members": {
"DatabaseName": {
"target": "com.amazonaws.timestreamquery#ResourceName",
"traits": {
"smithy.api#documentation": "<p>Timestream database name. </p>"
}
},
"TableName": {
"target": "com.amazonaws.timestreamquery#ResourceName",
"traits": {
"smithy.api#documentation": "<p>Timestream table name. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Destination for scheduled query.</p>"
}
},
"com.amazonaws.timestreamquery#Type": {
"type": "structure",
"members": {
"ScalarType": {
"target": "com.amazonaws.timestreamquery#ScalarType",
"traits": {
"smithy.api#documentation": "<p>Indicates if the column is of type string, integer, Boolean, double, timestamp, date,\n time. For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/supported-data-types.html\">Supported data\n types</a>.</p>"
}
},
"ArrayColumnInfo": {
"target": "com.amazonaws.timestreamquery#ColumnInfo",
"traits": {
"smithy.api#documentation": "<p>Indicates if the column is an array.</p>"
}
},
"TimeSeriesMeasureValueColumnInfo": {
"target": "com.amazonaws.timestreamquery#ColumnInfo",
"traits": {
"smithy.api#documentation": "<p>Indicates if the column is a timeseries data type.</p>"
}
},
"RowColumnInfo": {
"target": "com.amazonaws.timestreamquery#ColumnInfoList",
"traits": {
"smithy.api#documentation": "<p>Indicates if the column is a row.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the data type of a column in a query result set. The data type can be scalar\n or complex. The supported scalar data types are integers, Boolean, string, double,\n timestamp, date, time, and intervals. The supported complex data types are arrays, rows,\n and timeseries.</p>"
}
},
"com.amazonaws.timestreamquery#UntagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#UntagResourceRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#UntagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Removes the association of tags from a Timestream query resource.</p>"
}
},
"com.amazonaws.timestreamquery#UntagResourceRequest": {
"type": "structure",
"members": {
"ResourceARN": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Timestream resource that the tags will be removed from. This value is an Amazon\n Resource Name (ARN). </p>",
"smithy.api#required": {}
}
},
"TagKeys": {
"target": "com.amazonaws.timestreamquery#TagKeyList",
"traits": {
"smithy.api#documentation": "<p>A list of tags keys. Existing tags of the resource whose keys are members of this list\n will be removed from the Timestream resource. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#UntagResourceResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#UpdateAccountSettings": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#UpdateAccountSettingsRequest"
},
"output": {
"target": "com.amazonaws.timestreamquery#UpdateAccountSettingsResponse"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of <code>MaxQueryTCU</code> to a desired configuration, the new value can take up to 24 hours to be effective.</p>\n <note>\n <p>After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.</p>\n </note>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.timestreamquery#UpdateAccountSettingsRequest": {
"type": "structure",
"members": {
"MaxQueryTCU": {
"target": "com.amazonaws.timestreamquery#MaxQueryCapacity",
"traits": {
"smithy.api#documentation": "<p>The maximum number of compute units the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. The maximum value supported for <code>MaxQueryTCU</code> is 1000. To request an increase to this soft limit, contact Amazon Web Services Support. For information about the default quota for maxQueryTCU, see Default quotas. This configuration is applicable only for on-demand usage of Timestream Compute Units (TCUs).</p>\n <p>The maximum value supported for <code>MaxQueryTCU</code> is 1000. To request an increase to this soft limit, contact Amazon Web Services Support. For information about the default quota for <code>maxQueryTCU</code>, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.default\">Default quotas</a>.</p>"
}
},
"QueryPricingModel": {
"target": "com.amazonaws.timestreamquery#QueryPricingModel",
"traits": {
"smithy.api#documentation": "<p>The pricing model for queries in an account.</p>\n <note>\n <p>The <code>QueryPricingModel</code> parameter is used by several Timestream operations; however, the <code>UpdateAccountSettings</code> API operation doesn't recognize any values other than <code>COMPUTE_UNITS</code>.</p>\n </note>"
}
},
"QueryCompute": {
"target": "com.amazonaws.timestreamquery#QueryComputeRequest",
"traits": {
"smithy.api#documentation": "<p>Modifies the query compute settings configured in your account, including the query pricing model and provisioned Timestream Compute Units (TCUs) in your account.</p>\n <note>\n <p>This API is idempotent, meaning that making the same request multiple times will have the same effect as making the request once.</p>\n </note>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#UpdateAccountSettingsResponse": {
"type": "structure",
"members": {
"MaxQueryTCU": {
"target": "com.amazonaws.timestreamquery#MaxQueryCapacity",
"traits": {
"smithy.api#documentation": "<p>The configured maximum number of compute units the service will use at any point in time to serve your queries.</p>"
}
},
"QueryPricingModel": {
"target": "com.amazonaws.timestreamquery#QueryPricingModel",
"traits": {
"smithy.api#documentation": "<p>The pricing model for an account.</p>"
}
},
"QueryCompute": {
"target": "com.amazonaws.timestreamquery#QueryComputeResponse",
"traits": {
"smithy.api#documentation": "<p>Confirms the updated account settings for querying data in your account.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.timestreamquery#UpdateScheduledQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.timestreamquery#UpdateScheduledQueryRequest"
},
"output": {
"target": "smithy.api#Unit"
},
"errors": [
{
"target": "com.amazonaws.timestreamquery#AccessDeniedException"
},
{
"target": "com.amazonaws.timestreamquery#InternalServerException"
},
{
"target": "com.amazonaws.timestreamquery#InvalidEndpointException"
},
{
"target": "com.amazonaws.timestreamquery#ResourceNotFoundException"
},
{
"target": "com.amazonaws.timestreamquery#ThrottlingException"
},
{
"target": "com.amazonaws.timestreamquery#ValidationException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": true
},
"smithy.api#documentation": "<p>Update a scheduled query.</p>"
}
},
"com.amazonaws.timestreamquery#UpdateScheduledQueryRequest": {
"type": "structure",
"members": {
"ScheduledQueryArn": {
"target": "com.amazonaws.timestreamquery#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>ARN of the scheuled query.</p>",
"smithy.api#required": {}
}
},
"State": {
"target": "com.amazonaws.timestreamquery#ScheduledQueryState",
"traits": {
"smithy.api#documentation": "<p>State of the scheduled query. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.timestreamquery#ValidationException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.timestreamquery#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p> Invalid or malformed request. </p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
}
}
}