Class: Aws::TimestreamWrite::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-timestreamwrite/client.rb

Overview

An API client for TimestreamWrite. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::TimestreamWrite::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: true —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::TimestreamWrite::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::TimestreamWrite::EndpointParameters`

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



441
442
443
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 441

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1661
1662
1663
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1661

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1664
1665
1666
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1664

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1634

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::TimestreamWrite')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-timestreamwrite'
  context[:gem_version] = '1.35.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_batch_load_task(params = {}) ⇒ Types::CreateBatchLoadTaskResponse

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk [2]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [3]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html

Examples:

Request syntax with placeholder values


resp = client.create_batch_load_task({
  client_token: "ClientRequestToken",
  data_model_configuration: {
    data_model: {
      time_column: "StringValue256",
      time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
      dimension_mappings: [ # required
        {
          source_column: "SchemaName",
          destination_column: "SchemaName",
        },
      ],
      multi_measure_mappings: {
        target_multi_measure_name: "SchemaName",
        multi_measure_attribute_mappings: [ # required
          {
            source_column: "SchemaName", # required
            target_multi_measure_attribute_name: "SchemaName",
            measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, BOOLEAN, VARCHAR, TIMESTAMP
          },
        ],
      },
      mixed_measure_mappings: [
        {
          measure_name: "SchemaName",
          source_column: "SchemaName",
          target_measure_name: "SchemaName",
          measure_value_type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
          multi_measure_attribute_mappings: [
            {
              source_column: "SchemaName", # required
              target_multi_measure_attribute_name: "SchemaName",
              measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, BOOLEAN, VARCHAR, TIMESTAMP
            },
          ],
        },
      ],
      measure_name_column: "StringValue256",
    },
    data_model_s3_configuration: {
      bucket_name: "S3BucketName",
      object_key: "S3ObjectKey",
    },
  },
  data_source_configuration: { # required
    data_source_s3_configuration: { # required
      bucket_name: "S3BucketName", # required
      object_key_prefix: "S3ObjectKey",
    },
    csv_configuration: {
      column_separator: "StringValue1",
      escape_char: "StringValue1",
      quote_char: "StringValue1",
      null_value: "StringValue256",
      trim_white_space: false,
    },
    data_format: "CSV", # required, accepts CSV
  },
  report_configuration: { # required
    report_s3_configuration: {
      bucket_name: "S3BucketName", # required
      object_key_prefix: "S3ObjectKeyPrefix",
      encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
      kms_key_id: "StringValue2048",
    },
  },
  target_database_name: "ResourceCreateAPIName", # required
  target_table_name: "ResourceCreateAPIName", # required
  record_version: 1,
})

Response structure


resp.task_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :data_model_configuration (Types::DataModelConfiguration)
  • :data_source_configuration (required, Types::DataSourceConfiguration) —

    Defines configuration details about the data source for a batch load task.

  • :report_configuration (required, Types::ReportConfiguration) —

    Report configuration for a batch load task. This contains details about where error reports are stored.

  • :target_database_name (required, String) —

    Target Timestream database for a batch load task.

  • :target_table_name (required, String) —

    Target Timestream table for a batch load task.

  • :record_version (Integer)

Returns:

See Also:



570
571
572
573
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 570

def create_batch_load_task(params = {}, options = {})
  req = build_request(:create_batch_load_task, params)
  req.send_request(options)
end

#create_database(params = {}) ⇒ Types::CreateDatabaseResponse

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk [2]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [3]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html

Examples:

Request syntax with placeholder values


resp = client.create_database({
  database_name: "ResourceCreateAPIName", # required
  kms_key_id: "StringValue2048",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.database.arn #=> String
resp.database.database_name #=> String
resp.database.table_count #=> Integer
resp.database.kms_key_id #=> String
resp.database.creation_time #=> Time
resp.database.last_updated_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :database_name (required, String) —

    The name of the Timestream database.

  • :kms_key_id (String) —

    The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see [Amazon Web Services managed keys].

    [1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

  • :tags (Array<Types::Tag>) —

    A list of key-value pairs to label the table.

Returns:

See Also:



633
634
635
636
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 633

def create_database(params = {}, options = {})
  req = build_request(:create_database, params)
  req.send_request(options)
end

#create_table(params = {}) ⇒ Types::CreateTableResponse

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

[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html

Examples:

Request syntax with placeholder values


resp = client.create_table({
  database_name: "ResourceCreateAPIName", # required
  table_name: "ResourceCreateAPIName", # required
  retention_properties: {
    memory_store_retention_period_in_hours: 1, # required
    magnetic_store_retention_period_in_days: 1, # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  magnetic_store_write_properties: {
    enable_magnetic_store_writes: false, # required
    magnetic_store_rejected_data_location: {
      s3_configuration: {
        bucket_name: "S3BucketName",
        object_key_prefix: "S3ObjectKeyPrefix",
        encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
        kms_key_id: "StringValue2048",
      },
    },
  },
  schema: {
    composite_partition_key: [
      {
        type: "DIMENSION", # required, accepts DIMENSION, MEASURE
        name: "SchemaName",
        enforcement_in_record: "REQUIRED", # accepts REQUIRED, OPTIONAL
      },
    ],
  },
})

Response structure


resp.table.arn #=> String
resp.table.table_name #=> String
resp.table.database_name #=> String
resp.table.table_status #=> String, one of "ACTIVE", "DELETING", "RESTORING"
resp.table.retention_properties.memory_store_retention_period_in_hours #=> Integer
resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
resp.table.creation_time #=> Time
resp.table.last_updated_time #=> Time
resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
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"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :database_name (required, String) —

    The name of the Timestream database.

  • :table_name (required, String) —

    The name of the Timestream table.

  • :retention_properties (Types::RetentionProperties) —

    The duration for which your time-series data must be stored in the memory store and the magnetic store.

  • :tags (Array<Types::Tag>) —

    A list of key-value pairs to label the table.

  • :magnetic_store_write_properties (Types::MagneticStoreWriteProperties) —

    Contains properties to set on the table when enabling magnetic store writes.

  • :schema (Types::Schema) —

    The schema of the table.

Returns:

See Also:



736
737
738
739
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 736

def create_table(params = {}, options = {})
  req = build_request(:create_table, params)
  req.send_request(options)
end

#delete_database(params = {}) ⇒ Struct

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

<note markdown=“1”> All tables in the database must be deleted first, or a ValidationException error will be thrown.

Due to the nature of distributed retries, the operation can return

either success or a ResourceNotFoundException. Clients should consider them equivalent.

</note>

See [code sample] for details.

[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html

Examples:

Request syntax with placeholder values


resp = client.delete_database({
  database_name: "ResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :database_name (required, String) —

    The name of the Timestream database to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



775
776
777
778
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 775

def delete_database(params = {}, options = {})
  req = build_request(:delete_database, params)
  req.send_request(options)
end

#delete_table(params = {}) ⇒ Struct

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

<note markdown=“1”> Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.

</note>

See [code sample] for details.

[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html

Examples:

Request syntax with placeholder values


resp = client.delete_table({
  database_name: "ResourceName", # required
  table_name: "ResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :database_name (required, String) —

    The name of the database where the Timestream database is to be deleted.

  • :table_name (required, String) —

    The name of the Timestream table to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



816
817
818
819
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 816

def delete_table(params = {}, options = {})
  req = build_request(:delete_table, params)
  req.send_request(options)
end

#describe_batch_load_task(params = {}) ⇒ Types::DescribeBatchLoadTaskResponse

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

[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html

Examples:

Request syntax with placeholder values


resp = client.describe_batch_load_task({
  task_id: "BatchLoadTaskId", # required
})

Response structure


resp.batch_load_task_description.task_id #=> String
resp.batch_load_task_description.error_message #=> String
resp.batch_load_task_description.data_source_configuration.data_source_s3_configuration.bucket_name #=> String
resp.batch_load_task_description.data_source_configuration.data_source_s3_configuration.object_key_prefix #=> String
resp.batch_load_task_description.data_source_configuration.csv_configuration.column_separator #=> String
resp.batch_load_task_description.data_source_configuration.csv_configuration.escape_char #=> String
resp.batch_load_task_description.data_source_configuration.csv_configuration.quote_char #=> String
resp.batch_load_task_description.data_source_configuration.csv_configuration.null_value #=> String
resp.batch_load_task_description.data_source_configuration.csv_configuration.trim_white_space #=> Boolean
resp.batch_load_task_description.data_source_configuration.data_format #=> String, one of "CSV"
resp.batch_load_task_description.progress_report.records_processed #=> Integer
resp.batch_load_task_description.progress_report.records_ingested #=> Integer
resp.batch_load_task_description.progress_report.parse_failures #=> Integer
resp.batch_load_task_description.progress_report.record_ingestion_failures #=> Integer
resp.batch_load_task_description.progress_report.file_failures #=> Integer
resp.batch_load_task_description.progress_report.bytes_metered #=> Integer
resp.batch_load_task_description.report_configuration.report_s3_configuration.bucket_name #=> String
resp.batch_load_task_description.report_configuration.report_s3_configuration.object_key_prefix #=> String
resp.batch_load_task_description.report_configuration.report_s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
resp.batch_load_task_description.report_configuration.report_s3_configuration.kms_key_id #=> String
resp.batch_load_task_description.data_model_configuration.data_model.time_column #=> String
resp.batch_load_task_description.data_model_configuration.data_model.time_unit #=> String, one of "MILLISECONDS", "SECONDS", "MICROSECONDS", "NANOSECONDS"
resp.batch_load_task_description.data_model_configuration.data_model.dimension_mappings #=> Array
resp.batch_load_task_description.data_model_configuration.data_model.dimension_mappings[0].source_column #=> String
resp.batch_load_task_description.data_model_configuration.data_model.dimension_mappings[0].destination_column #=> String
resp.batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings.target_multi_measure_name #=> String
resp.batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings.multi_measure_attribute_mappings #=> Array
resp.batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings.multi_measure_attribute_mappings[0].source_column #=> String
resp.batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings.multi_measure_attribute_mappings[0].target_multi_measure_attribute_name #=> String
resp.batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings.multi_measure_attribute_mappings[0].measure_value_type #=> String, one of "DOUBLE", "BIGINT", "BOOLEAN", "VARCHAR", "TIMESTAMP"
resp.batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings #=> Array
resp.batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[0].measure_name #=> String
resp.batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[0].source_column #=> String
resp.batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[0].target_measure_name #=> String
resp.batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[0].measure_value_type #=> String, one of "DOUBLE", "BIGINT", "VARCHAR", "BOOLEAN", "TIMESTAMP", "MULTI"
resp.batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[0].multi_measure_attribute_mappings #=> Array
resp.batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[0].multi_measure_attribute_mappings[0].source_column #=> String
resp.batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[0].multi_measure_attribute_mappings[0].target_multi_measure_attribute_name #=> String
resp.batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[0].multi_measure_attribute_mappings[0].measure_value_type #=> String, one of "DOUBLE", "BIGINT", "BOOLEAN", "VARCHAR", "TIMESTAMP"
resp.batch_load_task_description.data_model_configuration.data_model.measure_name_column #=> String
resp.batch_load_task_description.data_model_configuration.data_model_s3_configuration.bucket_name #=> String
resp.batch_load_task_description.data_model_configuration.data_model_s3_configuration.object_key #=> String
resp.batch_load_task_description.target_database_name #=> String
resp.batch_load_task_description.target_table_name #=> String
resp.batch_load_task_description.task_status #=> String, one of "CREATED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "PROGRESS_STOPPED", "PENDING_RESUME"
resp.batch_load_task_description.record_version #=> Integer
resp.batch_load_task_description.creation_time #=> Time
resp.batch_load_task_description.last_updated_time #=> Time
resp.batch_load_task_description.resumable_until #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_id (required, String) —

    The ID of the batch load task.

Returns:

See Also:



899
900
901
902
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 899

def describe_batch_load_task(params = {}, options = {})
  req = build_request(:describe_batch_load_task, params)
  req.send_request(options)
end

#describe_database(params = {}) ⇒ Types::DescribeDatabaseResponse

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

[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html

Examples:

Request syntax with placeholder values


resp = client.describe_database({
  database_name: "ResourceName", # required
})

Response structure


resp.database.arn #=> String
resp.database.database_name #=> String
resp.database.table_count #=> Integer
resp.database.kms_key_id #=> String
resp.database.creation_time #=> Time
resp.database.last_updated_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :database_name (required, String) —

    The name of the Timestream database.

Returns:

See Also:



940
941
942
943
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 940

def describe_database(params = {}, options = {})
  req = build_request(:describe_database, params)
  req.send_request(options)
end

#describe_endpoints(params = {}) ⇒ Types::DescribeEndpointsResponse

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

Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, *we don’t recommend that you use this API operation unless*:

  • You are using [VPC endpoints (Amazon Web Services PrivateLink) with Timestream]

  • Your application uses a programming language that does not yet have SDK support

  • You require better control over the client-side implementation

For detailed information on how and when to use and implement DescribeEndpoints, see [The Endpoint Discovery Pattern].

[1]: docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints [2]: docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery

Examples:

Response structure


resp.endpoints #=> Array
resp.endpoints[0].address #=> String
resp.endpoints[0].cache_period_in_minutes #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



984
985
986
987
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 984

def describe_endpoints(params = {}, options = {})
  req = build_request(:describe_endpoints, params)
  req.send_request(options)
end

#describe_table(params = {}) ⇒ Types::DescribeTableResponse

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

[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html

Examples:

Request syntax with placeholder values


resp = client.describe_table({
  database_name: "ResourceName", # required
  table_name: "ResourceName", # required
})

Response structure


resp.table.arn #=> String
resp.table.table_name #=> String
resp.table.database_name #=> String
resp.table.table_status #=> String, one of "ACTIVE", "DELETING", "RESTORING"
resp.table.retention_properties.memory_store_retention_period_in_hours #=> Integer
resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
resp.table.creation_time #=> Time
resp.table.last_updated_time #=> Time
resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
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"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :database_name (required, String) —

    The name of the Timestream database.

  • :table_name (required, String) —

    The name of the Timestream table.

Returns:

See Also:



1039
1040
1041
1042
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1039

def describe_table(params = {}, options = {})
  req = build_request(:describe_table, params)
  req.send_request(options)
end

#list_batch_load_tasks(params = {}) ⇒ Types::ListBatchLoadTasksResponse

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

[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_batch_load_tasks({
  next_token: "String",
  max_results: 1,
  task_status: "CREATED", # accepts CREATED, IN_PROGRESS, FAILED, SUCCEEDED, PROGRESS_STOPPED, PENDING_RESUME
})

Response structure


resp.next_token #=> String
resp.batch_load_tasks #=> Array
resp.batch_load_tasks[0].task_id #=> String
resp.batch_load_tasks[0].task_status #=> String, one of "CREATED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "PROGRESS_STOPPED", "PENDING_RESUME"
resp.batch_load_tasks[0].database_name #=> String
resp.batch_load_tasks[0].table_name #=> String
resp.batch_load_tasks[0].creation_time #=> Time
resp.batch_load_tasks[0].last_updated_time #=> Time
resp.batch_load_tasks[0].resumable_until #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

  • :max_results (Integer) —

    The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

  • :task_status (String) —

    Status of the batch load task.

Returns:

See Also:



1096
1097
1098
1099
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1096

def list_batch_load_tasks(params = {}, options = {})
  req = build_request(:list_batch_load_tasks, params)
  req.send_request(options)
end

#list_databases(params = {}) ⇒ Types::ListDatabasesResponse

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

[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_databases({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.databases #=> Array
resp.databases[0].arn #=> String
resp.databases[0].database_name #=> String
resp.databases[0].table_count #=> Integer
resp.databases[0].kms_key_id #=> String
resp.databases[0].creation_time #=> Time
resp.databases[0].last_updated_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

  • :max_results (Integer) —

    The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Returns:

See Also:



1148
1149
1150
1151
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1148

def list_databases(params = {}, options = {})
  req = build_request(:list_databases, params)
  req.send_request(options)
end

#list_tables(params = {}) ⇒ Types::ListTablesResponse

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

[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tables({
  database_name: "ResourceName",
  next_token: "String",
  max_results: 1,
})

Response structure


resp.tables #=> Array
resp.tables[0].arn #=> String
resp.tables[0].table_name #=> String
resp.tables[0].database_name #=> String
resp.tables[0].table_status #=> String, one of "ACTIVE", "DELETING", "RESTORING"
resp.tables[0].retention_properties.memory_store_retention_period_in_hours #=> Integer
resp.tables[0].retention_properties.magnetic_store_retention_period_in_days #=> Integer
resp.tables[0].creation_time #=> Time
resp.tables[0].last_updated_time #=> Time
resp.tables[0].magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :database_name (String) —

    The name of the Timestream database.

  • :next_token (String) —

    The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

  • :max_results (Integer) —

    The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Returns:

See Also:



1214
1215
1216
1217
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1214

def list_tables(params = {}, options = {})
  req = build_request(:list_tables, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags on a Timestream resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).

Returns:

See Also:



1245
1246
1247
1248
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1245

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#resume_batch_load_task(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.resume_batch_load_task({
  task_id: "BatchLoadTaskId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_id (required, String) —

    The ID of the batch load task to resume.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1265
1266
1267
1268
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1265

def resume_batch_load_task(params = {}, options = {})
  req = build_request(:resume_batch_load_task, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Associates a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN).

  • :tags (required, Array<Types::Tag>) —

    The tags to be assigned to the Timestream resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1299
1300
1301
1302
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1299

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the association of tags from a Timestream resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).

  • :tag_keys (required, Array<String>) —

    A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1327
1328
1329
1330
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1327

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_database(params = {}) ⇒ Types::UpdateDatabaseResponse

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

See [code sample] for details.

[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html

Examples:

Request syntax with placeholder values


resp = client.update_database({
  database_name: "ResourceName", # required
  kms_key_id: "StringValue2048", # required
})

Response structure


resp.database.arn #=> String
resp.database.database_name #=> String
resp.database.table_count #=> Integer
resp.database.kms_key_id #=> String
resp.database.creation_time #=> Time
resp.database.last_updated_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :database_name (required, String) —

    The name of the database.

  • :kms_key_id (required, String) —

    The identifier of the new KMS key (‘KmsKeyId`) to be used to encrypt the data stored in the database. If the `KmsKeyId` currently registered with the database is the same as the `KmsKeyId` in the request, there will not be any update.

    You can specify the ‘KmsKeyId` using any of the following:

    • Key ID: ‘1234abcd-12ab-34cd-56ef-1234567890ab`

    • Key ARN: ‘arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`

    • Alias name: ‘alias/ExampleAlias`

    • Alias ARN: ‘arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias`

Returns:

See Also:



1387
1388
1389
1390
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1387

def update_database(params = {}, options = {})
  req = build_request(:update_database, params)
  req.send_request(options)
end

#update_table(params = {}) ⇒ Types::UpdateTableResponse

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

See [code sample] for details.

[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html

Examples:

Request syntax with placeholder values


resp = client.update_table({
  database_name: "ResourceName", # required
  table_name: "ResourceName", # required
  retention_properties: {
    memory_store_retention_period_in_hours: 1, # required
    magnetic_store_retention_period_in_days: 1, # required
  },
  magnetic_store_write_properties: {
    enable_magnetic_store_writes: false, # required
    magnetic_store_rejected_data_location: {
      s3_configuration: {
        bucket_name: "S3BucketName",
        object_key_prefix: "S3ObjectKeyPrefix",
        encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
        kms_key_id: "StringValue2048",
      },
    },
  },
  schema: {
    composite_partition_key: [
      {
        type: "DIMENSION", # required, accepts DIMENSION, MEASURE
        name: "SchemaName",
        enforcement_in_record: "REQUIRED", # accepts REQUIRED, OPTIONAL
      },
    ],
  },
})

Response structure


resp.table.arn #=> String
resp.table.table_name #=> String
resp.table.database_name #=> String
resp.table.table_status #=> String, one of "ACTIVE", "DELETING", "RESTORING"
resp.table.retention_properties.memory_store_retention_period_in_hours #=> Integer
resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
resp.table.creation_time #=> Time
resp.table.last_updated_time #=> Time
resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
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"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :database_name (required, String) —

    The name of the Timestream database.

  • :table_name (required, String) —

    The name of the Timestream table.

  • :retention_properties (Types::RetentionProperties) —

    The retention duration of the memory store and the magnetic store.

  • :magnetic_store_write_properties (Types::MagneticStoreWriteProperties) —

    Contains properties to set on the table when enabling magnetic store writes.

  • :schema (Types::Schema) —

    The schema of the table.

Returns:

See Also:



1482
1483
1484
1485
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1482

def update_table(params = {}, options = {})
  req = build_request(:update_table, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1654
1655
1656
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1654

def waiter_names
  []
end

#write_records(params = {}) ⇒ Types::WriteRecordsResponse

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

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

See [code sample] for details.

Upserts

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

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

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

[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html

Examples:

Request syntax with placeholder values


resp = client.write_records({
  database_name: "ResourceName", # required
  table_name: "ResourceName", # required
  common_attributes: {
    dimensions: [
      {
        name: "SchemaName", # required
        value: "SchemaValue", # required
        dimension_value_type: "VARCHAR", # accepts VARCHAR
      },
    ],
    measure_name: "SchemaName",
    measure_value: "StringValue2048",
    measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
    time: "StringValue256",
    time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
    version: 1,
    measure_values: [
      {
        name: "SchemaName", # required
        value: "StringValue2048", # required
        type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
      },
    ],
  },
  records: [ # required
    {
      dimensions: [
        {
          name: "SchemaName", # required
          value: "SchemaValue", # required
          dimension_value_type: "VARCHAR", # accepts VARCHAR
        },
      ],
      measure_name: "SchemaName",
      measure_value: "StringValue2048",
      measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
      time: "StringValue256",
      time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
      version: 1,
      measure_values: [
        {
          name: "SchemaName", # required
          value: "StringValue2048", # required
          type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
        },
      ],
    },
  ],
})

Response structure


resp.records_ingested.total #=> Integer
resp.records_ingested.memory_store #=> Integer
resp.records_ingested.magnetic_store #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :database_name (required, String) —

    The name of the Timestream database.

  • :table_name (required, String) —

    The name of the Timestream table.

  • :common_attributes (Types::Record) —

    A record that contains the common measure, dimension, time, and version attributes shared across all the records in the request. The measure and dimension attributes specified will be merged with the measure and dimension attributes in the records object when the data is written into Timestream. Dimensions may not overlap, or a ‘ValidationException` will be thrown. In other words, a record must contain dimensions with unique names.

  • :records (required, Array<Types::Record>) —

    An array of records that contain the unique measure, dimension, time, and version attributes for each time-series data point.

Returns:

See Also:



1625
1626
1627
1628
 
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1625

def write_records(params = {}, options = {})
  req = build_request(:write_records, params)
  req.send_request(options)
end