types

package
v1.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 14, 2022 License: Apache-2.0 Imports: 4 Imported by: 16

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string
	// contains filtered or unexported fields
}

You are not authorized to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type ConflictException 

type ConflictException struct {
	Message *string
	// contains filtered or unexported fields
}

Timestream was unable to process this request because it contains resource that already exists.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type Database 

type Database struct {

	// The Amazon Resource Name that uniquely identifies this database.
	Arn *string

	// The time when the database was created, calculated from the Unix epoch time.
	CreationTime *time.Time

	// The name of the Timestream database.
	DatabaseName *string

	// The identifier of the KMS key used to encrypt the data stored in the database.
	KmsKeyId *string

	// The last time that this database was updated.
	LastUpdatedTime *time.Time

	// The total number of tables found within a Timestream database.
	TableCount int64
	// contains filtered or unexported fields
}

A top level container for a table. Databases and tables are the fundamental management concepts in Amazon Timestream. All tables in a database are encrypted with the same KMS key.

type Dimension 

type Dimension struct {

	// Dimension represents the meta data attributes of the time series. For example,
	// the name and availability zone of an EC2 instance or the name of the
	// manufacturer of a wind turbine are dimensions. For constraints on Dimension
	// names, see Naming Constraints
	// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming).
	//
	// This member is required.
	Name *string

	// The value of the dimension.
	//
	// This member is required.
	Value *string

	// The data type of the dimension for the time series data point.
	DimensionValueType DimensionValueType
	// contains filtered or unexported fields
}

Dimension represents the meta data attributes of the time series. For example, the name and availability zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.

type DimensionValueType 

type DimensionValueType string
const (
	DimensionValueTypeVarchar DimensionValueType = "VARCHAR"
)

Enum values for DimensionValueType

func (DimensionValueType) Values 

func (DimensionValueType) Values() []DimensionValueType

Values returns all known values for DimensionValueType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Endpoint 

type Endpoint struct {

	// An endpoint address.
	//
	// This member is required.
	Address *string

	// The TTL for the endpoint, in minutes.
	//
	// This member is required.
	CachePeriodInMinutes int64
	// contains filtered or unexported fields
}

Represents an available endpoint against which to make API calls agaisnt, as well as the TTL for that endpoint.

type InternalServerException 

type InternalServerException struct {
	Message *string
	// contains filtered or unexported fields
}

Timestream was unable to fully process this request because of an internal server error.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type InvalidEndpointException 

type InvalidEndpointException struct {
	Message *string
	// contains filtered or unexported fields
}

The requested endpoint was invalid.

func (*InvalidEndpointException) Error 

func (e *InvalidEndpointException) Error() string

func (*InvalidEndpointException) ErrorCode 

func (e *InvalidEndpointException) ErrorCode() string

func (*InvalidEndpointException) ErrorFault 

func (e *InvalidEndpointException) ErrorFault() smithy.ErrorFault

func (*InvalidEndpointException) ErrorMessage 

func (e *InvalidEndpointException) ErrorMessage() string

type MagneticStoreRejectedDataLocation added in v1.8.0 

type MagneticStoreRejectedDataLocation struct {

	// Configuration of an S3 location to write error reports for records rejected,
	// asynchronously, during magnetic store writes.
	S3Configuration *S3Configuration
	// contains filtered or unexported fields
}

The location to write error reports for records rejected, asynchronously, during magnetic store writes.

type MagneticStoreWriteProperties added in v1.8.0 

type MagneticStoreWriteProperties struct {

	// A flag to enable magnetic store writes.
	//
	// This member is required.
	EnableMagneticStoreWrites *bool

	// The location to write error reports for records rejected asynchronously during
	// magnetic store writes.
	MagneticStoreRejectedDataLocation *MagneticStoreRejectedDataLocation
	// contains filtered or unexported fields
}

The set of properties on a table for configuring magnetic store writes.

type MeasureValue added in v1.8.0 

type MeasureValue struct {

	// Name of the MeasureValue. For constraints on MeasureValue names, refer to
	// Naming Constraints
	// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming)
	// in the Timestream developer guide.
	//
	// This member is required.
	Name *string

	// Contains the data type of the MeasureValue for the time series data point.
	//
	// This member is required.
	Type MeasureValueType

	// Value for the MeasureValue.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

MeasureValue represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures. MeasureValue has both name and value. MeasureValue is only allowed for type MULTI. Using MULTI type, you can pass multiple data attributes associated with the same time series in a single record

type MeasureValueType 

type MeasureValueType string
const (
	MeasureValueTypeDouble    MeasureValueType = "DOUBLE"
	MeasureValueTypeBigint    MeasureValueType = "BIGINT"
	MeasureValueTypeVarchar   MeasureValueType = "VARCHAR"
	MeasureValueTypeBoolean   MeasureValueType = "BOOLEAN"
	MeasureValueTypeTimestamp MeasureValueType = "TIMESTAMP"
	MeasureValueTypeMulti     MeasureValueType = "MULTI"
)

Enum values for MeasureValueType

func (MeasureValueType) Values 

func (MeasureValueType) Values() []MeasureValueType

Values returns all known values for MeasureValueType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Record 

type Record struct {

	// Contains the list of dimensions for time series data points.
	Dimensions []Dimension

	// Measure represents the data attribute of the time series. For example, the CPU
	// utilization of an EC2 instance or the RPM of a wind turbine are measures.
	MeasureName *string

	// Contains the measure value for the time series data point.
	MeasureValue *string

	// Contains the data type of the measure value for the time series data point.
	// Default type is DOUBLE.
	MeasureValueType MeasureValueType

	// Contains the list of MeasureValue for time series data points. This is only
	// allowed for type MULTI. For scalar values, use MeasureValue attribute of the
	// Record directly.
	MeasureValues []MeasureValue

	// Contains the time at which the measure value for the data point was collected.
	// The time value plus the unit provides the time elapsed since the epoch. For
	// example, if the time value is 12345 and the unit is ms, then 12345 ms have
	// elapsed since the epoch.
	Time *string

	// The granularity of the timestamp unit. It indicates if the time value is in
	// seconds, milliseconds, nanoseconds or other supported values. Default is
	// MILLISECONDS.
	TimeUnit TimeUnit

	// 64-bit attribute used for record updates. Write requests for duplicate data with
	// a higher version number will update the existing measure value and version. In
	// cases where the measure value is the same, Version will still be updated .
	// Default value is 1. Version must be 1 or greater, or you will receive a
	// ValidationException error.
	Version *int64
	// contains filtered or unexported fields
}

Record represents a time series data point being written into Timestream. Each record contains an array of dimensions. Dimensions represent the meta data attributes of a time series data point such as the instance name or availability zone of an EC2 instance. A record also contains the measure name which is the name of the measure being collected for example the CPU utilization of an EC2 instance. A record also contains the measure value and the value type which is the data type of the measure value. In addition, the record contains the timestamp when the measure was collected that the timestamp unit which represents the granularity of the timestamp. Records have a Version field, which is a 64-bit long that you can use for updating data points. Writes of a duplicate record with the same dimension, timestamp, and measure name but different measure value will only succeed if the Version attribute of the record in the write request is higher than that of the existing record. Timestream defaults to a Version of 1 for records without the Version field.

type RecordsIngested added in v1.8.0 

type RecordsIngested struct {

	// Count of records ingested into the magnetic store.
	MagneticStore int32

	// Count of records ingested into the memory store.
	MemoryStore int32

	// Total count of successfully ingested records.
	Total int32
	// contains filtered or unexported fields
}

Information on the records ingested by this request.

type RejectedRecord 

type RejectedRecord struct {

	// The existing version of the record. This value is populated in scenarios where
	// an identical record exists with a higher version than the version in the write
	// request.
	ExistingVersion *int64

	// The reason why a record was not successfully inserted into Timestream. Possible
	// causes of failure include:
	//
	// * Records with duplicate data where there are
	// multiple records with the same dimensions, timestamps, and measure names but:
	//
	// *
	// Measure values are different
	//
	// * Version is not present in the request or the
	// value of version in the new record is equal to or lower than the existing
	// value
	//
	// If Timestream rejects data for this case, the ExistingVersion field in
	// the RejectedRecords response will indicate the current record’s version. To
	// force an update, you can resend the request with a version for the record set to
	// a value greater than the ExistingVersion.
	//
	// * Records with timestamps that lie
	// outside the retention duration of the memory store When the retention window is
	// updated, you will receive a RejectedRecords exception if you immediately try to
	// ingest data within the new window. To avoid a RejectedRecords exception, wait
	// until the duration of the new window to ingest new data. For further
	// information, see  Best Practices for Configuring Timestream
	// (https://docs.aws.amazon.com/timestream/latest/developerguide/best-practices.html#configuration)
	// and the explanation of how storage works in Timestream
	// (https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html).
	//
	// *
	// Records with dimensions or measures that exceed the Timestream defined
	// limits.
	//
	// For more information, see Access Management
	// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) in
	// the Timestream Developer Guide.
	Reason *string

	// The index of the record in the input request for WriteRecords. Indexes begin
	// with 0.
	RecordIndex int32
	// contains filtered or unexported fields
}

Records that were not successfully inserted into Timestream due to data validation issues that must be resolved prior to reinserting time series data into the system.

type RejectedRecordsException 

type RejectedRecordsException struct {
	Message *string

	RejectedRecords []RejectedRecord
	// contains filtered or unexported fields
}

WriteRecords would throw this exception in the following cases:

* Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but:

* Measure values are different

* Version is not present in the request or the value of version in the new record is equal to or lower than the existing value

In this case, if Timestream rejects data, the ExistingVersion field in the RejectedRecords response will indicate the current record’s version. To force an update, you can resend the request with a version for the record set to a value greater than the ExistingVersion.

* Records with timestamps that lie outside the retention duration of the memory store

* Records with dimensions or measures that exceed the Timestream defined limits.

For more information, see Quotas (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) in the Timestream Developer Guide.

func (*RejectedRecordsException) Error 

func (e *RejectedRecordsException) Error() string

func (*RejectedRecordsException) ErrorCode 

func (e *RejectedRecordsException) ErrorCode() string

func (*RejectedRecordsException) ErrorFault 

func (e *RejectedRecordsException) ErrorFault() smithy.ErrorFault

func (*RejectedRecordsException) ErrorMessage 

func (e *RejectedRecordsException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string
	// contains filtered or unexported fields
}

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type RetentionProperties 

type RetentionProperties struct {

	// The duration for which data must be stored in the magnetic store.
	//
	// This member is required.
	MagneticStoreRetentionPeriodInDays int64

	// The duration for which data must be stored in the memory store.
	//
	// This member is required.
	MemoryStoreRetentionPeriodInHours int64
	// contains filtered or unexported fields
}

Retention properties contain the duration for which your time series data must be stored in the magnetic store and the memory store.

type S3Configuration added in v1.8.0 

type S3Configuration struct {

	// >Bucket name of the customer S3 bucket.
	BucketName *string

	// Encryption option for the customer s3 location. Options are S3 server side
	// encryption with an S3-managed key or KMS managed key.
	EncryptionOption S3EncryptionOption

	// KMS key id for the customer s3 location when encrypting with a KMS managed key.
	KmsKeyId *string

	// Object key preview for the customer S3 location.
	ObjectKeyPrefix *string
	// contains filtered or unexported fields
}

Configuration specifing an S3 location.

type S3EncryptionOption added in v1.8.0 

type S3EncryptionOption string
const (
	S3EncryptionOptionSseS3  S3EncryptionOption = "SSE_S3"
	S3EncryptionOptionSseKms S3EncryptionOption = "SSE_KMS"
)

Enum values for S3EncryptionOption

func (S3EncryptionOption) Values added in v1.8.0 

func (S3EncryptionOption) Values() []S3EncryptionOption

Values returns all known values for S3EncryptionOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string
	// contains filtered or unexported fields
}

Instance quota of resource exceeded for this account.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type Table 

type Table struct {

	// The Amazon Resource Name that uniquely identifies this table.
	Arn *string

	// The time when the Timestream table was created.
	CreationTime *time.Time

	// The name of the Timestream database that contains this table.
	DatabaseName *string

	// The time when the Timestream table was last updated.
	LastUpdatedTime *time.Time

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

	// The retention duration for the memory store and magnetic store.
	RetentionProperties *RetentionProperties

	// The name of the Timestream table.
	TableName *string

	// The current state of the table:
	//
	// * DELETING - The table is being deleted.
	//
	// *
	// ACTIVE - The table is ready for use.
	TableStatus TableStatus
	// contains filtered or unexported fields
}

Table represents a database table in Timestream. Tables contain one or more related time series. You can modify the retention duration of the memory store and the magnetic store for a table.

type TableStatus 

type TableStatus string
const (
	TableStatusActive   TableStatus = "ACTIVE"
	TableStatusDeleting TableStatus = "DELETING"
)

Enum values for TableStatus

func (TableStatus) Values 

func (TableStatus) Values() []TableStatus

Values returns all known values for TableStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Tag 

type Tag struct {

	// The key of the tag. Tag keys are case sensitive.
	//
	// This member is required.
	Key *string

	// The value of the tag. Tag values are case-sensitive and can be null.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A tag is a label that you assign to a Timestream database and/or table. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize databases and/or tables, for example, by purpose, owner, or environment.

type ThrottlingException 

type ThrottlingException struct {
	Message *string
	// contains filtered or unexported fields
}

Too many requests were made by a user exceeding service quotas. The request was throttled.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TimeUnit 

type TimeUnit string
const (
	TimeUnitMilliseconds TimeUnit = "MILLISECONDS"
	TimeUnitSeconds      TimeUnit = "SECONDS"
	TimeUnitMicroseconds TimeUnit = "MICROSECONDS"
	TimeUnitNanoseconds  TimeUnit = "NANOSECONDS"
)

Enum values for TimeUnit

func (TimeUnit) Values 

func (TimeUnit) Values() []TimeUnit

Values returns all known values for TimeUnit. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ValidationException 

type ValidationException struct {
	Message *string
	// contains filtered or unexported fields
}

Invalid or malformed request.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.