aws-sdk-timestreamwrite 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d57348275f669a453e5d38ebbb00d35a193ac6eeb16eef0e1b6a5767b48f6d3
-  data.tar.gz: 109d4eccd752b54904034877b103ac43d033a145711ecb9e34a56d1130bfc0ed
+  metadata.gz: 741f5e7e935d9276252b151a32169b7630d2f2731437cb6225a244a408a5ffb2
+  data.tar.gz: fd5f85f5355343c3f5883a08d89f373e3a55adb237dd280392d7b3c0da8b74ad
 SHA512:
-  metadata.gz: cfff79262cafdd35bdf2dcbbab23ddc82f06ce73f83689b1e4705879af39301ff841cc0c91b504dfedc858db44bc71ed125343812c03ceb51656782544d308e3
-  data.tar.gz: b04283f2e444ca0b9f3b86e5919365de31c01c1f2c86e5034030895e55beeb8caf6b67cd84cbcb742c0e851fdfba88dd09a1c9f69bafedb5a299cea8d0b87f67
+  metadata.gz: 3f81206edba36906b7222992c0d9757d28f43ebebfacbb347584f5fe47230021b32260ea630ac43b86b4912b10eb2a00ef8b98183d78ac75635a406e60cfb837
+  data.tar.gz: 939d8a6701214a1d344d3ae97205dd91e33a3fdae8792895124e434875ca508f5ce1ed532a91929684ceaac51ca2dad6b8837ae0a0f91f9e7b4a9b5f91b2d560

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.19.0 (2023-06-08)
+------------------
+
+* Feature - This release adds the capability for customers to define how their data should be partitioned, optimizing for certain access patterns. This definition will take place as a part of the table creation.
+
 1.18.0 (2023-05-31)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.18.0
+1.19.0

data/lib/aws-sdk-timestreamwrite/client.rb

@@ -387,11 +387,11 @@ module Aws::TimestreamWrite
     # data from a CSV source in an S3 location and writes to a Timestream
     # table. A mapping from source to target is defined in a batch load
     # task. Errors and events are written to a report at an S3 location. For
-    # the report, if the KMS key is not specified, the batch load task will
-    # be encrypted with a Timestream managed KMS key located in your
-    # account. For more information, see [Amazon Web Services managed
-    # keys][1]. [Service quotas apply][2]. For details, see [code
-    # sample][3].
+    # the report, if the KMS key is not specified, the report will be
+    # encrypted with an S3 managed key when `SSE_S3` is the option.
+    # Otherwise an error is thrown. For more information, see [Amazon Web
+    # Services managed keys][1]. [Service quotas apply][2]. For details, see
+    # [code sample][3].
     #
     #
     #
@@ -604,6 +604,9 @@ module Aws::TimestreamWrite
     #   Contains properties to set on the table when enabling magnetic store
     #   writes.
     #
+    # @option params [Types::Schema] :schema
+    #   The schema of the table.
+    #
     # @return [Types::CreateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateTableResponse#table #table} => Types::Table
@@ -634,6 +637,15 @@ module Aws::TimestreamWrite
     #         },
     #       },
     #     },
+    #     schema: {
+    #       composite_partition_key: [
+    #         {
+    #           type: "DIMENSION", # required, accepts DIMENSION, MEASURE
+    #           name: "SchemaName",
+    #           enforcement_in_record: "REQUIRED", # accepts REQUIRED, OPTIONAL
+    #         },
+    #       ],
+    #     },
     #   })
     #
     # @example Response structure
@@ -651,6 +663,10 @@ module Aws::TimestreamWrite
     #   resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
     #   resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
     #   resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
+    #   resp.table.schema.composite_partition_key #=> Array
+    #   resp.table.schema.composite_partition_key[0].type #=> String, one of "DIMENSION", "MEASURE"
+    #   resp.table.schema.composite_partition_key[0].name #=> String
+    #   resp.table.schema.composite_partition_key[0].enforcement_in_record #=> String, one of "REQUIRED", "OPTIONAL"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTable AWS API Documentation
     #
@@ -950,6 +966,10 @@ module Aws::TimestreamWrite
     #   resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
     #   resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
     #   resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
+    #   resp.table.schema.composite_partition_key #=> Array
+    #   resp.table.schema.composite_partition_key[0].type #=> String, one of "DIMENSION", "MEASURE"
+    #   resp.table.schema.composite_partition_key[0].name #=> String
+    #   resp.table.schema.composite_partition_key[0].enforcement_in_record #=> String, one of "REQUIRED", "OPTIONAL"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeTable AWS API Documentation
     #
@@ -1120,6 +1140,10 @@ module Aws::TimestreamWrite
     #   resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
     #   resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
     #   resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
+    #   resp.tables[0].schema.composite_partition_key #=> Array
+    #   resp.tables[0].schema.composite_partition_key[0].type #=> String, one of "DIMENSION", "MEASURE"
+    #   resp.tables[0].schema.composite_partition_key[0].name #=> String
+    #   resp.tables[0].schema.composite_partition_key[0].enforcement_in_record #=> String, one of "REQUIRED", "OPTIONAL"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTables AWS API Documentation
@@ -1332,6 +1356,9 @@ module Aws::TimestreamWrite
     #   Contains properties to set on the table when enabling magnetic store
     #   writes.
     #
+    # @option params [Types::Schema] :schema
+    #   The schema of the table.
+    #
     # @return [Types::UpdateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateTableResponse#table #table} => Types::Table
@@ -1356,6 +1383,15 @@ module Aws::TimestreamWrite
     #         },
     #       },
     #     },
+    #     schema: {
+    #       composite_partition_key: [
+    #         {
+    #           type: "DIMENSION", # required, accepts DIMENSION, MEASURE
+    #           name: "SchemaName",
+    #           enforcement_in_record: "REQUIRED", # accepts REQUIRED, OPTIONAL
+    #         },
+    #       ],
+    #     },
     #   })
     #
     # @example Response structure
@@ -1373,6 +1409,10 @@ module Aws::TimestreamWrite
     #   resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
     #   resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
     #   resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
+    #   resp.table.schema.composite_partition_key #=> Array
+    #   resp.table.schema.composite_partition_key[0].type #=> String, one of "DIMENSION", "MEASURE"
+    #   resp.table.schema.composite_partition_key[0].name #=> String
+    #   resp.table.schema.composite_partition_key[0].enforcement_in_record #=> String, one of "REQUIRED", "OPTIONAL"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTable AWS API Documentation
     #
@@ -1539,7 +1579,7 @@ module Aws::TimestreamWrite
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-timestreamwrite'
-      context[:gem_version] = '1.18.0'
+      context[:gem_version] = '1.19.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-timestreamwrite/client_api.rb

@@ -84,6 +84,10 @@ module Aws::TimestreamWrite
     MultiMeasureMappings = Shapes::StructureShape.new(name: 'MultiMeasureMappings')
     PageLimit = Shapes::IntegerShape.new(name: 'PageLimit')
     PaginationLimit = Shapes::IntegerShape.new(name: 'PaginationLimit')
+    PartitionKey = Shapes::StructureShape.new(name: 'PartitionKey')
+    PartitionKeyEnforcementLevel = Shapes::StringShape.new(name: 'PartitionKeyEnforcementLevel')
+    PartitionKeyList = Shapes::ListShape.new(name: 'PartitionKeyList')
+    PartitionKeyType = Shapes::StringShape.new(name: 'PartitionKeyType')
     Record = Shapes::StructureShape.new(name: 'Record')
     RecordIndex = Shapes::IntegerShape.new(name: 'RecordIndex')
     RecordVersion = Shapes::IntegerShape.new(name: 'RecordVersion')
@@ -106,6 +110,7 @@ module Aws::TimestreamWrite
     S3ObjectKey = Shapes::StringShape.new(name: 'S3ObjectKey')
     S3ObjectKeyPrefix = Shapes::StringShape.new(name: 'S3ObjectKeyPrefix')
     ScalarMeasureValueType = Shapes::StringShape.new(name: 'ScalarMeasureValueType')
+    Schema = Shapes::StructureShape.new(name: 'Schema')
     SchemaName = Shapes::StringShape.new(name: 'SchemaName')
     SchemaValue = Shapes::StringShape.new(name: 'SchemaValue')
     ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
@@ -200,6 +205,7 @@ module Aws::TimestreamWrite
     CreateTableRequest.add_member(:retention_properties, Shapes::ShapeRef.new(shape: RetentionProperties, location_name: "RetentionProperties"))
     CreateTableRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
     CreateTableRequest.add_member(:magnetic_store_write_properties, Shapes::ShapeRef.new(shape: MagneticStoreWriteProperties, location_name: "MagneticStoreWriteProperties"))
+    CreateTableRequest.add_member(:schema, Shapes::ShapeRef.new(shape: Schema, location_name: "Schema"))
     CreateTableRequest.struct_class = Types::CreateTableRequest
 
     CreateTableResponse.add_member(:table, Shapes::ShapeRef.new(shape: Table, location_name: "Table"))
@@ -369,6 +375,13 @@ module Aws::TimestreamWrite
     MultiMeasureMappings.add_member(:multi_measure_attribute_mappings, Shapes::ShapeRef.new(shape: MultiMeasureAttributeMappingList, required: true, location_name: "MultiMeasureAttributeMappings"))
     MultiMeasureMappings.struct_class = Types::MultiMeasureMappings
 
+    PartitionKey.add_member(:type, Shapes::ShapeRef.new(shape: PartitionKeyType, required: true, location_name: "Type"))
+    PartitionKey.add_member(:name, Shapes::ShapeRef.new(shape: SchemaName, location_name: "Name"))
+    PartitionKey.add_member(:enforcement_in_record, Shapes::ShapeRef.new(shape: PartitionKeyEnforcementLevel, location_name: "EnforcementInRecord"))
+    PartitionKey.struct_class = Types::PartitionKey
+
+    PartitionKeyList.member = Shapes::ShapeRef.new(shape: PartitionKey)
+
     Record.add_member(:dimensions, Shapes::ShapeRef.new(shape: Dimensions, location_name: "Dimensions"))
     Record.add_member(:measure_name, Shapes::ShapeRef.new(shape: SchemaName, location_name: "MeasureName"))
     Record.add_member(:measure_value, Shapes::ShapeRef.new(shape: StringValue2048, location_name: "MeasureValue"))
@@ -424,6 +437,9 @@ module Aws::TimestreamWrite
     S3Configuration.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: StringValue2048, location_name: "KmsKeyId"))
     S3Configuration.struct_class = Types::S3Configuration
 
+    Schema.add_member(:composite_partition_key, Shapes::ShapeRef.new(shape: PartitionKeyList, location_name: "CompositePartitionKey"))
+    Schema.struct_class = Types::Schema
+
     ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
 
@@ -435,6 +451,7 @@ module Aws::TimestreamWrite
     Table.add_member(:creation_time, Shapes::ShapeRef.new(shape: Date, location_name: "CreationTime"))
     Table.add_member(:last_updated_time, Shapes::ShapeRef.new(shape: Date, location_name: "LastUpdatedTime"))
     Table.add_member(:magnetic_store_write_properties, Shapes::ShapeRef.new(shape: MagneticStoreWriteProperties, location_name: "MagneticStoreWriteProperties"))
+    Table.add_member(:schema, Shapes::ShapeRef.new(shape: Schema, location_name: "Schema"))
     Table.struct_class = Types::Table
 
     TableList.member = Shapes::ShapeRef.new(shape: Table)
@@ -473,6 +490,7 @@ module Aws::TimestreamWrite
     UpdateTableRequest.add_member(:table_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "TableName"))
     UpdateTableRequest.add_member(:retention_properties, Shapes::ShapeRef.new(shape: RetentionProperties, location_name: "RetentionProperties"))
     UpdateTableRequest.add_member(:magnetic_store_write_properties, Shapes::ShapeRef.new(shape: MagneticStoreWriteProperties, location_name: "MagneticStoreWriteProperties"))
+    UpdateTableRequest.add_member(:schema, Shapes::ShapeRef.new(shape: Schema, location_name: "Schema"))
     UpdateTableRequest.struct_class = Types::UpdateTableRequest
 
     UpdateTableResponse.add_member(:table, Shapes::ShapeRef.new(shape: Table, location_name: "Table"))

data/lib/aws-sdk-timestreamwrite/types.rb

@@ -302,6 +302,10 @@ module Aws::TimestreamWrite
     #   writes.
     #   @return [Types::MagneticStoreWriteProperties]
     #
+    # @!attribute [rw] schema
+    #   The schema of the table.
+    #   @return [Types::Schema]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTableRequest AWS API Documentation
     #
     class CreateTableRequest < Struct.new(
@@ -309,7 +313,8 @@ module Aws::TimestreamWrite
       :table_name,
       :retention_properties,
       :tags,
-      :magnetic_store_write_properties)
+      :magnetic_store_write_properties,
+      :schema)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -948,7 +953,12 @@ module Aws::TimestreamWrite
     #   @return [String]
     #
     # @!attribute [rw] value
-    #   The value for the MeasureValue.
+    #   The value for the MeasureValue. For information, see [Data
+    #   types][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types
     #   @return [String]
     #
     # @!attribute [rw] type
@@ -1027,6 +1037,37 @@ module Aws::TimestreamWrite
       include Aws::Structure
     end
 
+    # An attribute used in partitioning data in a table. A dimension key
+    # partitions data using the values of the dimension specified by the
+    # dimension-name as partition key, while a measure key partitions data
+    # using measure names (values of the 'measure\_name' column).
+    #
+    # @!attribute [rw] type
+    #   The type of the partition key. Options are DIMENSION (dimension key)
+    #   and MEASURE (measure key).
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   The name of the attribute used for a dimension key.
+    #   @return [String]
+    #
+    # @!attribute [rw] enforcement_in_record
+    #   The level of enforcement for the specification of a dimension key in
+    #   ingested records. Options are REQUIRED (dimension key must be
+    #   specified) and OPTIONAL (dimension key does not have to be
+    #   specified).
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/PartitionKey AWS API Documentation
+    #
+    class PartitionKey < Struct.new(
+      :type,
+      :name,
+      :enforcement_in_record)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Represents a time-series data point being written into Timestream.
     # Each record contains an array of dimensions. Dimensions represent the
     # metadata attributes of a time-series data point, such as the instance
@@ -1062,7 +1103,12 @@ module Aws::TimestreamWrite
     #
     # @!attribute [rw] measure_value_type
     #   Contains the data type of the measure value for the time-series data
-    #   point. Default type is `DOUBLE`.
+    #   point. Default type is `DOUBLE`. For more information, see [Data
+    #   types][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types
     #   @return [String]
     #
     # @!attribute [rw] time
@@ -1370,6 +1416,25 @@ module Aws::TimestreamWrite
       include Aws::Structure
     end
 
+    # A Schema specifies the expected data model of the table.
+    #
+    # @!attribute [rw] composite_partition_key
+    #   A non-empty list of partition keys defining the attributes used to
+    #   partition the table data. The order of the list determines the
+    #   partition hierarchy. The name and type of each partition key as well
+    #   as the partition key order cannot be changed after the table is
+    #   created. However, the enforcement level of each partition key can be
+    #   changed.
+    #   @return [Array<Types::PartitionKey>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/Schema AWS API Documentation
+    #
+    class Schema < Struct.new(
+      :composite_partition_key)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The instance quota of resource exceeded for this account.
     #
     # @!attribute [rw] message
@@ -1424,6 +1489,10 @@ module Aws::TimestreamWrite
     #   writes.
     #   @return [Types::MagneticStoreWriteProperties]
     #
+    # @!attribute [rw] schema
+    #   The schema of the table.
+    #   @return [Types::Schema]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/Table AWS API Documentation
     #
     class Table < Struct.new(
@@ -1434,7 +1503,8 @@ module Aws::TimestreamWrite
       :retention_properties,
       :creation_time,
       :last_updated_time,
-      :magnetic_store_write_properties)
+      :magnetic_store_write_properties,
+      :schema)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1582,13 +1652,18 @@ module Aws::TimestreamWrite
     #   writes.
     #   @return [Types::MagneticStoreWriteProperties]
     #
+    # @!attribute [rw] schema
+    #   The schema of the table.
+    #   @return [Types::Schema]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTableRequest AWS API Documentation
     #
     class UpdateTableRequest < Struct.new(
       :database_name,
       :table_name,
       :retention_properties,
-      :magnetic_store_write_properties)
+      :magnetic_store_write_properties,
+      :schema)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-timestreamwrite.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-timestreamwrite/customizations'
 # @!group service
 module Aws::TimestreamWrite
 
-  GEM_VERSION = '1.18.0'
+  GEM_VERSION = '1.19.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-timestreamwrite
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core