timestreamwrite

package
v1.44.213 Latest Latest
Warning

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

Go to latest
Published: Mar 2, 2023 License: Apache-2.0 Imports: 13 Imported by: 49

Documentation

Overview

Package timestreamwrite provides the client and types for making API requests to Amazon Timestream Write.

Amazon Timestream is a fast, scalable, fully managed time-series database service that makes it easy to store and analyze trillions of time-series data points per day. With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications. You can analyze industrial telemetry to streamline equipment management and maintenance. You can also store and analyze log data and metrics to improve the performance and availability of your applications.

Timestream is built from the ground up to effectively ingest, process, and store time-series data. It organizes data to optimize query processing. It automatically scales based on the volume of data ingested and on the query volume to ensure you receive optimal performance while inserting and querying data. As your data grows over time, Timestream’s adaptive query processing engine spans across storage tiers to provide fast analysis while reducing costs.

See https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01 for more information on this service.

See timestreamwrite package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/timestreamwrite/

Using the Client

To contact Amazon Timestream Write with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Timestream Write client TimestreamWrite for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/timestreamwrite/#New

Index

Constants

View Source
const (
	// BatchLoadStatusCreated is a BatchLoadStatus enum value
	BatchLoadStatusCreated = "CREATED"

	// BatchLoadStatusInProgress is a BatchLoadStatus enum value
	BatchLoadStatusInProgress = "IN_PROGRESS"

	// BatchLoadStatusFailed is a BatchLoadStatus enum value
	BatchLoadStatusFailed = "FAILED"

	// BatchLoadStatusSucceeded is a BatchLoadStatus enum value
	BatchLoadStatusSucceeded = "SUCCEEDED"

	// BatchLoadStatusProgressStopped is a BatchLoadStatus enum value
	BatchLoadStatusProgressStopped = "PROGRESS_STOPPED"

	// BatchLoadStatusPendingResume is a BatchLoadStatus enum value
	BatchLoadStatusPendingResume = "PENDING_RESUME"
)
View Source
const (
	// MeasureValueTypeDouble is a MeasureValueType enum value
	MeasureValueTypeDouble = "DOUBLE"

	// MeasureValueTypeBigint is a MeasureValueType enum value
	MeasureValueTypeBigint = "BIGINT"

	// MeasureValueTypeVarchar is a MeasureValueType enum value
	MeasureValueTypeVarchar = "VARCHAR"

	// MeasureValueTypeBoolean is a MeasureValueType enum value
	MeasureValueTypeBoolean = "BOOLEAN"

	// MeasureValueTypeTimestamp is a MeasureValueType enum value
	MeasureValueTypeTimestamp = "TIMESTAMP"

	// MeasureValueTypeMulti is a MeasureValueType enum value
	MeasureValueTypeMulti = "MULTI"
)
View Source
const (
	// S3EncryptionOptionSseS3 is a S3EncryptionOption enum value
	S3EncryptionOptionSseS3 = "SSE_S3"

	// S3EncryptionOptionSseKms is a S3EncryptionOption enum value
	S3EncryptionOptionSseKms = "SSE_KMS"
)
View Source
const (
	// ScalarMeasureValueTypeDouble is a ScalarMeasureValueType enum value
	ScalarMeasureValueTypeDouble = "DOUBLE"

	// ScalarMeasureValueTypeBigint is a ScalarMeasureValueType enum value
	ScalarMeasureValueTypeBigint = "BIGINT"

	// ScalarMeasureValueTypeBoolean is a ScalarMeasureValueType enum value
	ScalarMeasureValueTypeBoolean = "BOOLEAN"

	// ScalarMeasureValueTypeVarchar is a ScalarMeasureValueType enum value
	ScalarMeasureValueTypeVarchar = "VARCHAR"

	// ScalarMeasureValueTypeTimestamp is a ScalarMeasureValueType enum value
	ScalarMeasureValueTypeTimestamp = "TIMESTAMP"
)
View Source
const (
	// TableStatusActive is a TableStatus enum value
	TableStatusActive = "ACTIVE"

	// TableStatusDeleting is a TableStatus enum value
	TableStatusDeleting = "DELETING"

	// TableStatusRestoring is a TableStatus enum value
	TableStatusRestoring = "RESTORING"
)
View Source
const (
	// TimeUnitMilliseconds is a TimeUnit enum value
	TimeUnitMilliseconds = "MILLISECONDS"

	// TimeUnitSeconds is a TimeUnit enum value
	TimeUnitSeconds = "SECONDS"

	// TimeUnitMicroseconds is a TimeUnit enum value
	TimeUnitMicroseconds = "MICROSECONDS"

	// TimeUnitNanoseconds is a TimeUnit enum value
	TimeUnitNanoseconds = "NANOSECONDS"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You are not authorized to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Timestream was unable to process this request because it contains resource
	// that already exists.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Timestream was unable to fully process this request because of an internal
	// server error.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidEndpointException for service response error code
	// "InvalidEndpointException".
	//
	// The requested endpoint was not valid.
	ErrCodeInvalidEndpointException = "InvalidEndpointException"

	// ErrCodeRejectedRecordsException for service response error code
	// "RejectedRecordsException".
	//
	// 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 Amazon Timestream Developer Guide.
	ErrCodeRejectedRecordsException = "RejectedRecordsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The operation tried to access a nonexistent resource. The resource might
	// not be specified correctly, or its status might not be ACTIVE.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The instance quota of resource exceeded for this account.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Too many requests were made by a user and they exceeded the service quotas.
	// The request was throttled.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// An invalid or malformed request.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "Timestream Write"  // Name of service.
	EndpointsID = "ingest.timestream" // ID to lookup a service endpoint with.
	ServiceID   = "Timestream Write"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// BatchLoadDataFormatCsv is a BatchLoadDataFormat enum value
	BatchLoadDataFormatCsv = "CSV"
)
View Source
const (
	// DimensionValueTypeVarchar is a DimensionValueType enum value
	DimensionValueTypeVarchar = "VARCHAR"
)

Variables

This section is empty.

Functions

func BatchLoadDataFormat_Values added in v1.44.210

func BatchLoadDataFormat_Values() []string

BatchLoadDataFormat_Values returns all elements of the BatchLoadDataFormat enum

func BatchLoadStatus_Values added in v1.44.210

func BatchLoadStatus_Values() []string

BatchLoadStatus_Values returns all elements of the BatchLoadStatus enum

func DimensionValueType_Values

func DimensionValueType_Values() []string

DimensionValueType_Values returns all elements of the DimensionValueType enum

func MeasureValueType_Values

func MeasureValueType_Values() []string

MeasureValueType_Values returns all elements of the MeasureValueType enum

func S3EncryptionOption_Values added in v1.42.12

func S3EncryptionOption_Values() []string

S3EncryptionOption_Values returns all elements of the S3EncryptionOption enum

func ScalarMeasureValueType_Values added in v1.44.210

func ScalarMeasureValueType_Values() []string

ScalarMeasureValueType_Values returns all elements of the ScalarMeasureValueType enum

func TableStatus_Values

func TableStatus_Values() []string

TableStatus_Values returns all elements of the TableStatus enum

func TimeUnit_Values

func TimeUnit_Values() []string

TimeUnit_Values returns all elements of the TimeUnit enum

Types

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You are not authorized to perform this action.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchLoadProgressReport added in v1.44.210

type BatchLoadProgressReport struct {
	BytesMetered *int64 `type:"long"`

	FileFailures *int64 `type:"long"`

	ParseFailures *int64 `type:"long"`

	RecordIngestionFailures *int64 `type:"long"`

	RecordsIngested *int64 `type:"long"`

	RecordsProcessed *int64 `type:"long"`
	// contains filtered or unexported fields
}

Details about the progress of a batch load task.

func (BatchLoadProgressReport) GoString added in v1.44.210

func (s BatchLoadProgressReport) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchLoadProgressReport) SetBytesMetered added in v1.44.210

func (s *BatchLoadProgressReport) SetBytesMetered(v int64) *BatchLoadProgressReport

SetBytesMetered sets the BytesMetered field's value.

func (*BatchLoadProgressReport) SetFileFailures added in v1.44.210

func (s *BatchLoadProgressReport) SetFileFailures(v int64) *BatchLoadProgressReport

SetFileFailures sets the FileFailures field's value.

func (*BatchLoadProgressReport) SetParseFailures added in v1.44.210

func (s *BatchLoadProgressReport) SetParseFailures(v int64) *BatchLoadProgressReport

SetParseFailures sets the ParseFailures field's value.

func (*BatchLoadProgressReport) SetRecordIngestionFailures added in v1.44.210

func (s *BatchLoadProgressReport) SetRecordIngestionFailures(v int64) *BatchLoadProgressReport

SetRecordIngestionFailures sets the RecordIngestionFailures field's value.

func (*BatchLoadProgressReport) SetRecordsIngested added in v1.44.210

func (s *BatchLoadProgressReport) SetRecordsIngested(v int64) *BatchLoadProgressReport

SetRecordsIngested sets the RecordsIngested field's value.

func (*BatchLoadProgressReport) SetRecordsProcessed added in v1.44.210

func (s *BatchLoadProgressReport) SetRecordsProcessed(v int64) *BatchLoadProgressReport

SetRecordsProcessed sets the RecordsProcessed field's value.

func (BatchLoadProgressReport) String added in v1.44.210

func (s BatchLoadProgressReport) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchLoadTask added in v1.44.210

type BatchLoadTask struct {

	// The time when the Timestream batch load task was created.
	CreationTime *time.Time `type:"timestamp"`

	// Database name for the database into which a batch load task loads data.
	DatabaseName *string `type:"string"`

	// The time when the Timestream batch load task was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	ResumableUntil *time.Time `type:"timestamp"`

	// Table name for the table into which a batch load task loads data.
	TableName *string `type:"string"`

	// The ID of the batch load task.
	TaskId *string `min:"3" type:"string"`

	// Status of the batch load task.
	TaskStatus *string `type:"string" enum:"BatchLoadStatus"`
	// contains filtered or unexported fields
}

Details about a batch load task.

func (BatchLoadTask) GoString added in v1.44.210

func (s BatchLoadTask) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchLoadTask) SetCreationTime added in v1.44.210

func (s *BatchLoadTask) SetCreationTime(v time.Time) *BatchLoadTask

SetCreationTime sets the CreationTime field's value.

func (*BatchLoadTask) SetDatabaseName added in v1.44.210

func (s *BatchLoadTask) SetDatabaseName(v string) *BatchLoadTask

SetDatabaseName sets the DatabaseName field's value.

func (*BatchLoadTask) SetLastUpdatedTime added in v1.44.210

func (s *BatchLoadTask) SetLastUpdatedTime(v time.Time) *BatchLoadTask

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*BatchLoadTask) SetResumableUntil added in v1.44.210

func (s *BatchLoadTask) SetResumableUntil(v time.Time) *BatchLoadTask

SetResumableUntil sets the ResumableUntil field's value.

func (*BatchLoadTask) SetTableName added in v1.44.210

func (s *BatchLoadTask) SetTableName(v string) *BatchLoadTask

SetTableName sets the TableName field's value.

func (*BatchLoadTask) SetTaskId added in v1.44.210

func (s *BatchLoadTask) SetTaskId(v string) *BatchLoadTask

SetTaskId sets the TaskId field's value.

func (*BatchLoadTask) SetTaskStatus added in v1.44.210

func (s *BatchLoadTask) SetTaskStatus(v string) *BatchLoadTask

SetTaskStatus sets the TaskStatus field's value.

func (BatchLoadTask) String added in v1.44.210

func (s BatchLoadTask) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchLoadTaskDescription added in v1.44.210

type BatchLoadTaskDescription struct {

	// The time when the Timestream batch load task was created.
	CreationTime *time.Time `type:"timestamp"`

	// Data model configuration for a batch load task. This contains details about
	// where a data model for a batch load task is stored.
	DataModelConfiguration *DataModelConfiguration `type:"structure"`

	// Configuration details about the data source for a batch load task.
	DataSourceConfiguration *DataSourceConfiguration `type:"structure"`

	ErrorMessage *string `min:"1" type:"string"`

	// The time when the Timestream batch load task was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// Details about the progress of a batch load task.
	ProgressReport *BatchLoadProgressReport `type:"structure"`

	RecordVersion *int64 `type:"long"`

	// Report configuration for a batch load task. This contains details about where
	// error reports are stored.
	ReportConfiguration *ReportConfiguration `type:"structure"`

	ResumableUntil *time.Time `type:"timestamp"`

	TargetDatabaseName *string `type:"string"`

	TargetTableName *string `type:"string"`

	// The ID of the batch load task.
	TaskId *string `min:"3" type:"string"`

	// Status of the batch load task.
	TaskStatus *string `type:"string" enum:"BatchLoadStatus"`
	// contains filtered or unexported fields
}

Details about a batch load task.

func (BatchLoadTaskDescription) GoString added in v1.44.210

func (s BatchLoadTaskDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchLoadTaskDescription) SetCreationTime added in v1.44.210

SetCreationTime sets the CreationTime field's value.

func (*BatchLoadTaskDescription) SetDataModelConfiguration added in v1.44.210

SetDataModelConfiguration sets the DataModelConfiguration field's value.

func (*BatchLoadTaskDescription) SetDataSourceConfiguration added in v1.44.210

SetDataSourceConfiguration sets the DataSourceConfiguration field's value.

func (*BatchLoadTaskDescription) SetErrorMessage added in v1.44.210

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchLoadTaskDescription) SetLastUpdatedTime added in v1.44.210

func (s *BatchLoadTaskDescription) SetLastUpdatedTime(v time.Time) *BatchLoadTaskDescription

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*BatchLoadTaskDescription) SetProgressReport added in v1.44.210

SetProgressReport sets the ProgressReport field's value.

func (*BatchLoadTaskDescription) SetRecordVersion added in v1.44.210

SetRecordVersion sets the RecordVersion field's value.

func (*BatchLoadTaskDescription) SetReportConfiguration added in v1.44.210

SetReportConfiguration sets the ReportConfiguration field's value.

func (*BatchLoadTaskDescription) SetResumableUntil added in v1.44.210

SetResumableUntil sets the ResumableUntil field's value.

func (*BatchLoadTaskDescription) SetTargetDatabaseName added in v1.44.210

func (s *BatchLoadTaskDescription) SetTargetDatabaseName(v string) *BatchLoadTaskDescription

SetTargetDatabaseName sets the TargetDatabaseName field's value.

func (*BatchLoadTaskDescription) SetTargetTableName added in v1.44.210

func (s *BatchLoadTaskDescription) SetTargetTableName(v string) *BatchLoadTaskDescription

SetTargetTableName sets the TargetTableName field's value.

func (*BatchLoadTaskDescription) SetTaskId added in v1.44.210

SetTaskId sets the TaskId field's value.

func (*BatchLoadTaskDescription) SetTaskStatus added in v1.44.210

SetTaskStatus sets the TaskStatus field's value.

func (BatchLoadTaskDescription) String added in v1.44.210

func (s BatchLoadTaskDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateBatchLoadTaskInput added in v1.44.210

type CreateBatchLoadTaskInput struct {

	// ClientToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateBatchLoadTaskInput's
	// String and GoString methods.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true" sensitive:"true"`

	DataModelConfiguration *DataModelConfiguration `type:"structure"`

	// Defines configuration details about the data source for a batch load task.
	//
	// DataSourceConfiguration is a required field
	DataSourceConfiguration *DataSourceConfiguration `type:"structure" required:"true"`

	RecordVersion *int64 `type:"long"`

	// Report configuration for a batch load task. This contains details about where
	// error reports are stored.
	//
	// ReportConfiguration is a required field
	ReportConfiguration *ReportConfiguration `type:"structure" required:"true"`

	// Target Timestream database for a batch load task.
	//
	// TargetDatabaseName is a required field
	TargetDatabaseName *string `type:"string" required:"true"`

	// Target Timestream table for a batch load task.
	//
	// TargetTableName is a required field
	TargetTableName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateBatchLoadTaskInput) GoString added in v1.44.210

func (s CreateBatchLoadTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBatchLoadTaskInput) SetClientToken added in v1.44.210

SetClientToken sets the ClientToken field's value.

func (*CreateBatchLoadTaskInput) SetDataModelConfiguration added in v1.44.210

SetDataModelConfiguration sets the DataModelConfiguration field's value.

func (*CreateBatchLoadTaskInput) SetDataSourceConfiguration added in v1.44.210

SetDataSourceConfiguration sets the DataSourceConfiguration field's value.

func (*CreateBatchLoadTaskInput) SetRecordVersion added in v1.44.210

SetRecordVersion sets the RecordVersion field's value.

func (*CreateBatchLoadTaskInput) SetReportConfiguration added in v1.44.210

SetReportConfiguration sets the ReportConfiguration field's value.

func (*CreateBatchLoadTaskInput) SetTargetDatabaseName added in v1.44.210

func (s *CreateBatchLoadTaskInput) SetTargetDatabaseName(v string) *CreateBatchLoadTaskInput

SetTargetDatabaseName sets the TargetDatabaseName field's value.

func (*CreateBatchLoadTaskInput) SetTargetTableName added in v1.44.210

func (s *CreateBatchLoadTaskInput) SetTargetTableName(v string) *CreateBatchLoadTaskInput

SetTargetTableName sets the TargetTableName field's value.

func (CreateBatchLoadTaskInput) String added in v1.44.210

func (s CreateBatchLoadTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBatchLoadTaskInput) Validate added in v1.44.210

func (s *CreateBatchLoadTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBatchLoadTaskOutput added in v1.44.210

type CreateBatchLoadTaskOutput struct {

	// The ID of the batch load task.
	//
	// TaskId is a required field
	TaskId *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateBatchLoadTaskOutput) GoString added in v1.44.210

func (s CreateBatchLoadTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBatchLoadTaskOutput) SetTaskId added in v1.44.210

SetTaskId sets the TaskId field's value.

func (CreateBatchLoadTaskOutput) String added in v1.44.210

func (s CreateBatchLoadTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDatabaseInput

type CreateDatabaseInput struct {

	// The name of the Timestream database.
	//
	// DatabaseName is a required field
	DatabaseName *string `type:"string" required:"true"`

	// 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 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
	KmsKeyId *string `min:"1" type:"string"`

	// A list of key-value pairs to label the table.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateDatabaseInput) GoString

func (s CreateDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatabaseInput) SetDatabaseName

func (s *CreateDatabaseInput) SetDatabaseName(v string) *CreateDatabaseInput

SetDatabaseName sets the DatabaseName field's value.

func (*CreateDatabaseInput) SetKmsKeyId

func (s *CreateDatabaseInput) SetKmsKeyId(v string) *CreateDatabaseInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateDatabaseInput) SetTags

func (s *CreateDatabaseInput) SetTags(v []*Tag) *CreateDatabaseInput

SetTags sets the Tags field's value.

func (CreateDatabaseInput) String

func (s CreateDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatabaseInput) Validate

func (s *CreateDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatabaseOutput

type CreateDatabaseOutput struct {

	// The newly created Timestream database.
	Database *Database `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDatabaseOutput) GoString

func (s CreateDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatabaseOutput) SetDatabase

SetDatabase sets the Database field's value.

func (CreateDatabaseOutput) String

func (s CreateDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTableInput

type CreateTableInput struct {

	// The name of the Timestream database.
	//
	// DatabaseName is a required field
	DatabaseName *string `type:"string" required:"true"`

	// Contains properties to set on the table when enabling magnetic store writes.
	MagneticStoreWriteProperties *MagneticStoreWriteProperties `type:"structure"`

	// The duration for which your time-series data must be stored in the memory
	// store and the magnetic store.
	RetentionProperties *RetentionProperties `type:"structure"`

	// The name of the Timestream table.
	//
	// TableName is a required field
	TableName *string `type:"string" required:"true"`

	// A list of key-value pairs to label the table.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateTableInput) GoString

func (s CreateTableInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTableInput) SetDatabaseName

func (s *CreateTableInput) SetDatabaseName(v string) *CreateTableInput

SetDatabaseName sets the DatabaseName field's value.

func (*CreateTableInput) SetMagneticStoreWriteProperties added in v1.42.12

func (s *CreateTableInput) SetMagneticStoreWriteProperties(v *MagneticStoreWriteProperties) *CreateTableInput

SetMagneticStoreWriteProperties sets the MagneticStoreWriteProperties field's value.

func (*CreateTableInput) SetRetentionProperties

func (s *CreateTableInput) SetRetentionProperties(v *RetentionProperties) *CreateTableInput

SetRetentionProperties sets the RetentionProperties field's value.

func (*CreateTableInput) SetTableName

func (s *CreateTableInput) SetTableName(v string) *CreateTableInput

SetTableName sets the TableName field's value.

func (*CreateTableInput) SetTags

func (s *CreateTableInput) SetTags(v []*Tag) *CreateTableInput

SetTags sets the Tags field's value.

func (CreateTableInput) String

func (s CreateTableInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTableInput) Validate

func (s *CreateTableInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateTableOutput

type CreateTableOutput struct {

	// The newly created Timestream table.
	Table *Table `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateTableOutput) GoString

func (s CreateTableOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTableOutput) SetTable

func (s *CreateTableOutput) SetTable(v *Table) *CreateTableOutput

SetTable sets the Table field's value.

func (CreateTableOutput) String

func (s CreateTableOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CsvConfiguration added in v1.44.210

type CsvConfiguration struct {

	// Column separator can be one of comma (','), pipe ('|), semicolon (';'), tab('/t'),
	// or blank space (' ').
	ColumnSeparator *string `min:"1" type:"string"`

	// Escape character can be one of
	EscapeChar *string `min:"1" type:"string"`

	// Can be blank space (' ').
	NullValue *string `min:"1" type:"string"`

	// Can be single quote (') or double quote (").
	QuoteChar *string `min:"1" type:"string"`

	// Specifies to trim leading and trailing white space.
	TrimWhiteSpace *bool `type:"boolean"`
	// contains filtered or unexported fields
}

A delimited data format where the column separator can be a comma and the record separator is a newline character.

func (CsvConfiguration) GoString added in v1.44.210

func (s CsvConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CsvConfiguration) SetColumnSeparator added in v1.44.210

func (s *CsvConfiguration) SetColumnSeparator(v string) *CsvConfiguration

SetColumnSeparator sets the ColumnSeparator field's value.

func (*CsvConfiguration) SetEscapeChar added in v1.44.210

func (s *CsvConfiguration) SetEscapeChar(v string) *CsvConfiguration

SetEscapeChar sets the EscapeChar field's value.

func (*CsvConfiguration) SetNullValue added in v1.44.210

func (s *CsvConfiguration) SetNullValue(v string) *CsvConfiguration

SetNullValue sets the NullValue field's value.

func (*CsvConfiguration) SetQuoteChar added in v1.44.210

func (s *CsvConfiguration) SetQuoteChar(v string) *CsvConfiguration

SetQuoteChar sets the QuoteChar field's value.

func (*CsvConfiguration) SetTrimWhiteSpace added in v1.44.210

func (s *CsvConfiguration) SetTrimWhiteSpace(v bool) *CsvConfiguration

SetTrimWhiteSpace sets the TrimWhiteSpace field's value.

func (CsvConfiguration) String added in v1.44.210

func (s CsvConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CsvConfiguration) Validate added in v1.44.210

func (s *CsvConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataModel added in v1.44.210

type DataModel struct {

	// Source to target mappings for dimensions.
	//
	// DimensionMappings is a required field
	DimensionMappings []*DimensionMapping `min:"1" type:"list" required:"true"`

	MeasureNameColumn *string `min:"1" type:"string"`

	// Source to target mappings for measures.
	MixedMeasureMappings []*MixedMeasureMapping `min:"1" type:"list"`

	// Source to target mappings for multi-measure records.
	MultiMeasureMappings *MultiMeasureMappings `type:"structure"`

	// Source column to be mapped to time.
	TimeColumn *string `min:"1" type:"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 *string `type:"string" enum:"TimeUnit"`
	// contains filtered or unexported fields
}

Data model for a batch load task.

func (DataModel) GoString added in v1.44.210

func (s DataModel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataModel) SetDimensionMappings added in v1.44.210

func (s *DataModel) SetDimensionMappings(v []*DimensionMapping) *DataModel

SetDimensionMappings sets the DimensionMappings field's value.

func (*DataModel) SetMeasureNameColumn added in v1.44.210

func (s *DataModel) SetMeasureNameColumn(v string) *DataModel

SetMeasureNameColumn sets the MeasureNameColumn field's value.

func (*DataModel) SetMixedMeasureMappings added in v1.44.210

func (s *DataModel) SetMixedMeasureMappings(v []*MixedMeasureMapping) *DataModel

SetMixedMeasureMappings sets the MixedMeasureMappings field's value.

func (*DataModel) SetMultiMeasureMappings added in v1.44.210

func (s *DataModel) SetMultiMeasureMappings(v *MultiMeasureMappings) *DataModel

SetMultiMeasureMappings sets the MultiMeasureMappings field's value.

func (*DataModel) SetTimeColumn added in v1.44.210

func (s *DataModel) SetTimeColumn(v string) *DataModel

SetTimeColumn sets the TimeColumn field's value.

func (*DataModel) SetTimeUnit added in v1.44.210

func (s *DataModel) SetTimeUnit(v string) *DataModel

SetTimeUnit sets the TimeUnit field's value.

func (DataModel) String added in v1.44.210

func (s DataModel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataModel) Validate added in v1.44.210

func (s *DataModel) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataModelConfiguration added in v1.44.210

type DataModelConfiguration struct {

	// Data model for a batch load task.
	DataModel *DataModel `type:"structure"`

	DataModelS3Configuration *DataModelS3Configuration `type:"structure"`
	// contains filtered or unexported fields
}

func (DataModelConfiguration) GoString added in v1.44.210

func (s DataModelConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataModelConfiguration) SetDataModel added in v1.44.210

SetDataModel sets the DataModel field's value.

func (*DataModelConfiguration) SetDataModelS3Configuration added in v1.44.210

func (s *DataModelConfiguration) SetDataModelS3Configuration(v *DataModelS3Configuration) *DataModelConfiguration

SetDataModelS3Configuration sets the DataModelS3Configuration field's value.

func (DataModelConfiguration) String added in v1.44.210

func (s DataModelConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataModelConfiguration) Validate added in v1.44.210

func (s *DataModelConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataModelS3Configuration added in v1.44.210

type DataModelS3Configuration struct {
	BucketName *string `min:"3" type:"string"`

	ObjectKey *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DataModelS3Configuration) GoString added in v1.44.210

func (s DataModelS3Configuration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataModelS3Configuration) SetBucketName added in v1.44.210

SetBucketName sets the BucketName field's value.

func (*DataModelS3Configuration) SetObjectKey added in v1.44.210

SetObjectKey sets the ObjectKey field's value.

func (DataModelS3Configuration) String added in v1.44.210

func (s DataModelS3Configuration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataModelS3Configuration) Validate added in v1.44.210

func (s *DataModelS3Configuration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataSourceConfiguration added in v1.44.210

type DataSourceConfiguration struct {

	// A delimited data format where the column separator can be a comma and the
	// record separator is a newline character.
	CsvConfiguration *CsvConfiguration `type:"structure"`

	// This is currently CSV.
	//
	// DataFormat is a required field
	DataFormat *string `type:"string" required:"true" enum:"BatchLoadDataFormat"`

	// Configuration of an S3 location for a file which contains data to load.
	//
	// DataSourceS3Configuration is a required field
	DataSourceS3Configuration *DataSourceS3Configuration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Defines configuration details about the data source.

func (DataSourceConfiguration) GoString added in v1.44.210

func (s DataSourceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceConfiguration) SetCsvConfiguration added in v1.44.210

SetCsvConfiguration sets the CsvConfiguration field's value.

func (*DataSourceConfiguration) SetDataFormat added in v1.44.210

SetDataFormat sets the DataFormat field's value.

func (*DataSourceConfiguration) SetDataSourceS3Configuration added in v1.44.210

func (s *DataSourceConfiguration) SetDataSourceS3Configuration(v *DataSourceS3Configuration) *DataSourceConfiguration

SetDataSourceS3Configuration sets the DataSourceS3Configuration field's value.

func (DataSourceConfiguration) String added in v1.44.210

func (s DataSourceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceConfiguration) Validate added in v1.44.210

func (s *DataSourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataSourceS3Configuration added in v1.44.210

type DataSourceS3Configuration struct {

	// The bucket name of the customer S3 bucket.
	//
	// BucketName is a required field
	BucketName *string `min:"3" type:"string" required:"true"`

	ObjectKeyPrefix *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DataSourceS3Configuration) GoString added in v1.44.210

func (s DataSourceS3Configuration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceS3Configuration) SetBucketName added in v1.44.210

SetBucketName sets the BucketName field's value.

func (*DataSourceS3Configuration) SetObjectKeyPrefix added in v1.44.210

SetObjectKeyPrefix sets the ObjectKeyPrefix field's value.

func (DataSourceS3Configuration) String added in v1.44.210

func (s DataSourceS3Configuration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceS3Configuration) Validate added in v1.44.210

func (s *DataSourceS3Configuration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Database

type Database struct {

	// The Amazon Resource Name that uniquely identifies this database.
	Arn *string `type:"string"`

	// The time when the database was created, calculated from the Unix epoch time.
	CreationTime *time.Time `type:"timestamp"`

	// The name of the Timestream database.
	DatabaseName *string `type:"string"`

	// The identifier of the KMS key used to encrypt the data stored in the database.
	KmsKeyId *string `min:"1" type:"string"`

	// The last time that this database was updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// The total number of tables found within a Timestream database.
	TableCount *int64 `type:"long"`
	// 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.

func (Database) GoString

func (s Database) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Database) SetArn

func (s *Database) SetArn(v string) *Database

SetArn sets the Arn field's value.

func (*Database) SetCreationTime

func (s *Database) SetCreationTime(v time.Time) *Database

SetCreationTime sets the CreationTime field's value.

func (*Database) SetDatabaseName

func (s *Database) SetDatabaseName(v string) *Database

SetDatabaseName sets the DatabaseName field's value.

func (*Database) SetKmsKeyId

func (s *Database) SetKmsKeyId(v string) *Database

SetKmsKeyId sets the KmsKeyId field's value.

func (*Database) SetLastUpdatedTime

func (s *Database) SetLastUpdatedTime(v time.Time) *Database

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*Database) SetTableCount

func (s *Database) SetTableCount(v int64) *Database

SetTableCount sets the TableCount field's value.

func (Database) String

func (s Database) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDatabaseInput

type DeleteDatabaseInput struct {

	// The name of the Timestream database to be deleted.
	//
	// DatabaseName is a required field
	DatabaseName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDatabaseInput) GoString

func (s DeleteDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDatabaseInput) SetDatabaseName

func (s *DeleteDatabaseInput) SetDatabaseName(v string) *DeleteDatabaseInput

SetDatabaseName sets the DatabaseName field's value.

func (DeleteDatabaseInput) String

func (s DeleteDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDatabaseInput) Validate

func (s *DeleteDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDatabaseOutput

type DeleteDatabaseOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDatabaseOutput) GoString

func (s DeleteDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDatabaseOutput) String

func (s DeleteDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTableInput

type DeleteTableInput struct {

	// The name of the database where the Timestream database is to be deleted.
	//
	// DatabaseName is a required field
	DatabaseName *string `type:"string" required:"true"`

	// The name of the Timestream table to be deleted.
	//
	// TableName is a required field
	TableName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTableInput) GoString

func (s DeleteTableInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTableInput) SetDatabaseName

func (s *DeleteTableInput) SetDatabaseName(v string) *DeleteTableInput

SetDatabaseName sets the DatabaseName field's value.

func (*DeleteTableInput) SetTableName

func (s *DeleteTableInput) SetTableName(v string) *DeleteTableInput

SetTableName sets the TableName field's value.

func (DeleteTableInput) String

func (s DeleteTableInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTableInput) Validate

func (s *DeleteTableInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteTableOutput

type DeleteTableOutput struct {
	// contains filtered or unexported fields
}

func (DeleteTableOutput) GoString

func (s DeleteTableOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTableOutput) String

func (s DeleteTableOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBatchLoadTaskInput added in v1.44.210

type DescribeBatchLoadTaskInput struct {

	// The ID of the batch load task.
	//
	// TaskId is a required field
	TaskId *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBatchLoadTaskInput) GoString added in v1.44.210

func (s DescribeBatchLoadTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBatchLoadTaskInput) SetTaskId added in v1.44.210

SetTaskId sets the TaskId field's value.

func (DescribeBatchLoadTaskInput) String added in v1.44.210

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBatchLoadTaskInput) Validate added in v1.44.210

func (s *DescribeBatchLoadTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBatchLoadTaskOutput added in v1.44.210

type DescribeBatchLoadTaskOutput struct {

	// Description of the batch load task.
	//
	// BatchLoadTaskDescription is a required field
	BatchLoadTaskDescription *BatchLoadTaskDescription `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBatchLoadTaskOutput) GoString added in v1.44.210

func (s DescribeBatchLoadTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBatchLoadTaskOutput) SetBatchLoadTaskDescription added in v1.44.210

SetBatchLoadTaskDescription sets the BatchLoadTaskDescription field's value.

func (DescribeBatchLoadTaskOutput) String added in v1.44.210

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDatabaseInput

type DescribeDatabaseInput struct {

	// The name of the Timestream database.
	//
	// DatabaseName is a required field
	DatabaseName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDatabaseInput) GoString

func (s DescribeDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatabaseInput) SetDatabaseName

func (s *DescribeDatabaseInput) SetDatabaseName(v string) *DescribeDatabaseInput

SetDatabaseName sets the DatabaseName field's value.

func (DescribeDatabaseInput) String

func (s DescribeDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatabaseInput) Validate

func (s *DescribeDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDatabaseOutput

type DescribeDatabaseOutput struct {

	// The name of the Timestream table.
	Database *Database `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDatabaseOutput) GoString

func (s DescribeDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatabaseOutput) SetDatabase

SetDatabase sets the Database field's value.

func (DescribeDatabaseOutput) String

func (s DescribeDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEndpointsInput

type DescribeEndpointsInput struct {
	// contains filtered or unexported fields
}

func (DescribeEndpointsInput) GoString

func (s DescribeEndpointsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeEndpointsInput) String

func (s DescribeEndpointsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEndpointsOutput

type DescribeEndpointsOutput struct {

	// An Endpoints object is returned when a DescribeEndpoints request is made.
	//
	// Endpoints is a required field
	Endpoints []*Endpoint `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEndpointsOutput) GoString

func (s DescribeEndpointsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEndpointsOutput) SetEndpoints

SetEndpoints sets the Endpoints field's value.

func (DescribeEndpointsOutput) String

func (s DescribeEndpointsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTableInput

type DescribeTableInput struct {

	// The name of the Timestream database.
	//
	// DatabaseName is a required field
	DatabaseName *string `type:"string" required:"true"`

	// The name of the Timestream table.
	//
	// TableName is a required field
	TableName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTableInput) GoString

func (s DescribeTableInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTableInput) SetDatabaseName

func (s *DescribeTableInput) SetDatabaseName(v string) *DescribeTableInput

SetDatabaseName sets the DatabaseName field's value.

func (*DescribeTableInput) SetTableName

func (s *DescribeTableInput) SetTableName(v string) *DescribeTableInput

SetTableName sets the TableName field's value.

func (DescribeTableInput) String

func (s DescribeTableInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTableInput) Validate

func (s *DescribeTableInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTableOutput

type DescribeTableOutput struct {

	// The Timestream table.
	Table *Table `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeTableOutput) GoString

func (s DescribeTableOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTableOutput) SetTable

SetTable sets the Table field's value.

func (DescribeTableOutput) String

func (s DescribeTableOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Dimension

type Dimension struct {

	// The data type of the dimension for the time-series data point.
	DimensionValueType *string `type:"string" enum:"DimensionValueType"`

	// Dimension represents the metadata 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).
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The value of the dimension.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the metadata 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.

func (Dimension) GoString

func (s Dimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Dimension) SetDimensionValueType

func (s *Dimension) SetDimensionValueType(v string) *Dimension

SetDimensionValueType sets the DimensionValueType field's value.

func (*Dimension) SetName

func (s *Dimension) SetName(v string) *Dimension

SetName sets the Name field's value.

func (*Dimension) SetValue

func (s *Dimension) SetValue(v string) *Dimension

SetValue sets the Value field's value.

func (Dimension) String

func (s Dimension) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Dimension) Validate

func (s *Dimension) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DimensionMapping added in v1.44.210

type DimensionMapping struct {
	DestinationColumn *string `min:"1" type:"string"`

	SourceColumn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DimensionMapping) GoString added in v1.44.210

func (s DimensionMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DimensionMapping) SetDestinationColumn added in v1.44.210

func (s *DimensionMapping) SetDestinationColumn(v string) *DimensionMapping

SetDestinationColumn sets the DestinationColumn field's value.

func (*DimensionMapping) SetSourceColumn added in v1.44.210

func (s *DimensionMapping) SetSourceColumn(v string) *DimensionMapping

SetSourceColumn sets the SourceColumn field's value.

func (DimensionMapping) String added in v1.44.210

func (s DimensionMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DimensionMapping) Validate added in v1.44.210

func (s *DimensionMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Endpoint

type Endpoint struct {

	// An endpoint address.
	//
	// Address is a required field
	Address *string `type:"string" required:"true"`

	// The TTL for the endpoint, in minutes.
	//
	// CachePeriodInMinutes is a required field
	CachePeriodInMinutes *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

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

func (Endpoint) GoString

func (s Endpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Endpoint) SetAddress

func (s *Endpoint) SetAddress(v string) *Endpoint

SetAddress sets the Address field's value.

func (*Endpoint) SetCachePeriodInMinutes

func (s *Endpoint) SetCachePeriodInMinutes(v int64) *Endpoint

SetCachePeriodInMinutes sets the CachePeriodInMinutes field's value.

func (Endpoint) String

func (s Endpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidEndpointException

type InvalidEndpointException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The requested endpoint was not valid.

func (*InvalidEndpointException) Code

func (s *InvalidEndpointException) Code() string

Code returns the exception type name.

func (*InvalidEndpointException) Error

func (s *InvalidEndpointException) Error() string

func (InvalidEndpointException) GoString

func (s InvalidEndpointException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidEndpointException) Message

func (s *InvalidEndpointException) Message() string

Message returns the exception's message.

func (*InvalidEndpointException) OrigErr

func (s *InvalidEndpointException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidEndpointException) RequestID

func (s *InvalidEndpointException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidEndpointException) StatusCode

func (s *InvalidEndpointException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidEndpointException) String

func (s InvalidEndpointException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListBatchLoadTasksInput added in v1.44.210

type ListBatchLoadTasksInput struct {

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token to specify where to start paginating. This is the NextToken from
	// a previously truncated response.
	NextToken *string `type:"string"`

	// Status of the batch load task.
	TaskStatus *string `type:"string" enum:"BatchLoadStatus"`
	// contains filtered or unexported fields
}

func (ListBatchLoadTasksInput) GoString added in v1.44.210

func (s ListBatchLoadTasksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBatchLoadTasksInput) SetMaxResults added in v1.44.210

SetMaxResults sets the MaxResults field's value.

func (*ListBatchLoadTasksInput) SetNextToken added in v1.44.210

SetNextToken sets the NextToken field's value.

func (*ListBatchLoadTasksInput) SetTaskStatus added in v1.44.210

SetTaskStatus sets the TaskStatus field's value.

func (ListBatchLoadTasksInput) String added in v1.44.210

func (s ListBatchLoadTasksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBatchLoadTasksInput) Validate added in v1.44.210

func (s *ListBatchLoadTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBatchLoadTasksOutput added in v1.44.210

type ListBatchLoadTasksOutput struct {

	// A list of batch load task details.
	BatchLoadTasks []*BatchLoadTask `type:"list"`

	// A token to specify where to start paginating. Provide the next ListBatchLoadTasksRequest.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListBatchLoadTasksOutput) GoString added in v1.44.210

func (s ListBatchLoadTasksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBatchLoadTasksOutput) SetBatchLoadTasks added in v1.44.210

SetBatchLoadTasks sets the BatchLoadTasks field's value.

func (*ListBatchLoadTasksOutput) SetNextToken added in v1.44.210

SetNextToken sets the NextToken field's value.

func (ListBatchLoadTasksOutput) String added in v1.44.210

func (s ListBatchLoadTasksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDatabasesInput

type ListDatabasesInput struct {

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token. To resume pagination, provide the NextToken value as
	// argument of a subsequent API invocation.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDatabasesInput) GoString

func (s ListDatabasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatabasesInput) SetMaxResults

func (s *ListDatabasesInput) SetMaxResults(v int64) *ListDatabasesInput

SetMaxResults sets the MaxResults field's value.

func (*ListDatabasesInput) SetNextToken

func (s *ListDatabasesInput) SetNextToken(v string) *ListDatabasesInput

SetNextToken sets the NextToken field's value.

func (ListDatabasesInput) String

func (s ListDatabasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatabasesInput) Validate

func (s *ListDatabasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatabasesOutput

type ListDatabasesOutput struct {

	// A list of database names.
	Databases []*Database `type:"list"`

	// The pagination token. This parameter is returned when the response is truncated.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDatabasesOutput) GoString

func (s ListDatabasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatabasesOutput) SetDatabases

func (s *ListDatabasesOutput) SetDatabases(v []*Database) *ListDatabasesOutput

SetDatabases sets the Databases field's value.

func (*ListDatabasesOutput) SetNextToken

func (s *ListDatabasesOutput) SetNextToken(v string) *ListDatabasesOutput

SetNextToken sets the NextToken field's value.

func (ListDatabasesOutput) String

func (s ListDatabasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTablesInput

type ListTablesInput struct {

	// The name of the Timestream database.
	DatabaseName *string `type:"string"`

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token. To resume pagination, provide the NextToken value as
	// argument of a subsequent API invocation.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListTablesInput) GoString

func (s ListTablesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTablesInput) SetDatabaseName

func (s *ListTablesInput) SetDatabaseName(v string) *ListTablesInput

SetDatabaseName sets the DatabaseName field's value.

func (*ListTablesInput) SetMaxResults

func (s *ListTablesInput) SetMaxResults(v int64) *ListTablesInput

SetMaxResults sets the MaxResults field's value.

func (*ListTablesInput) SetNextToken

func (s *ListTablesInput) SetNextToken(v string) *ListTablesInput

SetNextToken sets the NextToken field's value.

func (ListTablesInput) String

func (s ListTablesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTablesInput) Validate

func (s *ListTablesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTablesOutput

type ListTablesOutput struct {

	// A token to specify where to start paginating. This is the NextToken from
	// a previously truncated response.
	NextToken *string `type:"string"`

	// A list of tables.
	Tables []*Table `type:"list"`
	// contains filtered or unexported fields
}

func (ListTablesOutput) GoString

func (s ListTablesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTablesOutput) SetNextToken

func (s *ListTablesOutput) SetNextToken(v string) *ListTablesOutput

SetNextToken sets the NextToken field's value.

func (*ListTablesOutput) SetTables

func (s *ListTablesOutput) SetTables(v []*Table) *ListTablesOutput

SetTables sets the Tables field's value.

func (ListTablesOutput) String

func (s ListTablesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Timestream resource with tags to be listed. This value is an Amazon Resource
	// Name (ARN).
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tags currently associated with the Timestream resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MagneticStoreRejectedDataLocation added in v1.42.12

type MagneticStoreRejectedDataLocation struct {

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

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

func (MagneticStoreRejectedDataLocation) GoString added in v1.42.12

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MagneticStoreRejectedDataLocation) SetS3Configuration added in v1.42.12

SetS3Configuration sets the S3Configuration field's value.

func (MagneticStoreRejectedDataLocation) String added in v1.42.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MagneticStoreRejectedDataLocation) Validate added in v1.42.12

Validate inspects the fields of the type to determine if they are valid.

type MagneticStoreWriteProperties added in v1.42.12

type MagneticStoreWriteProperties struct {

	// A flag to enable magnetic store writes.
	//
	// EnableMagneticStoreWrites is a required field
	EnableMagneticStoreWrites *bool `type:"boolean" required:"true"`

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

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

func (MagneticStoreWriteProperties) GoString added in v1.42.12

func (s MagneticStoreWriteProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MagneticStoreWriteProperties) SetEnableMagneticStoreWrites added in v1.42.12

func (s *MagneticStoreWriteProperties) SetEnableMagneticStoreWrites(v bool) *MagneticStoreWriteProperties

SetEnableMagneticStoreWrites sets the EnableMagneticStoreWrites field's value.

func (*MagneticStoreWriteProperties) SetMagneticStoreRejectedDataLocation added in v1.42.12

SetMagneticStoreRejectedDataLocation sets the MagneticStoreRejectedDataLocation field's value.

func (MagneticStoreWriteProperties) String added in v1.42.12

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MagneticStoreWriteProperties) Validate added in v1.42.12

func (s *MagneticStoreWriteProperties) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MeasureValue added in v1.42.12

type MeasureValue struct {

	// The name of the MeasureValue.
	//
	// For constraints on MeasureValue names, see Naming Constraints (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming)
	// in the Amazon Timestream Developer Guide.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Contains the data type of the MeasureValue for the time-series data point.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"MeasureValueType"`

	// The value for the MeasureValue.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (MeasureValue) GoString added in v1.42.12

func (s MeasureValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MeasureValue) SetName added in v1.42.12

func (s *MeasureValue) SetName(v string) *MeasureValue

SetName sets the Name field's value.

func (*MeasureValue) SetType added in v1.42.12

func (s *MeasureValue) SetType(v string) *MeasureValue

SetType sets the Type field's value.

func (*MeasureValue) SetValue added in v1.42.12

func (s *MeasureValue) SetValue(v string) *MeasureValue

SetValue sets the Value field's value.

func (MeasureValue) String added in v1.42.12

func (s MeasureValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MeasureValue) Validate added in v1.42.12

func (s *MeasureValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MixedMeasureMapping added in v1.44.210

type MixedMeasureMapping struct {
	MeasureName *string `min:"1" type:"string"`

	// MeasureValueType is a required field
	MeasureValueType *string `type:"string" required:"true" enum:"MeasureValueType"`

	MultiMeasureAttributeMappings []*MultiMeasureAttributeMapping `min:"1" type:"list"`

	SourceColumn *string `min:"1" type:"string"`

	TargetMeasureName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (MixedMeasureMapping) GoString added in v1.44.210

func (s MixedMeasureMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MixedMeasureMapping) SetMeasureName added in v1.44.210

func (s *MixedMeasureMapping) SetMeasureName(v string) *MixedMeasureMapping

SetMeasureName sets the MeasureName field's value.

func (*MixedMeasureMapping) SetMeasureValueType added in v1.44.210

func (s *MixedMeasureMapping) SetMeasureValueType(v string) *MixedMeasureMapping

SetMeasureValueType sets the MeasureValueType field's value.

func (*MixedMeasureMapping) SetMultiMeasureAttributeMappings added in v1.44.210

func (s *MixedMeasureMapping) SetMultiMeasureAttributeMappings(v []*MultiMeasureAttributeMapping) *MixedMeasureMapping

SetMultiMeasureAttributeMappings sets the MultiMeasureAttributeMappings field's value.

func (*MixedMeasureMapping) SetSourceColumn added in v1.44.210

func (s *MixedMeasureMapping) SetSourceColumn(v string) *MixedMeasureMapping

SetSourceColumn sets the SourceColumn field's value.

func (*MixedMeasureMapping) SetTargetMeasureName added in v1.44.210

func (s *MixedMeasureMapping) SetTargetMeasureName(v string) *MixedMeasureMapping

SetTargetMeasureName sets the TargetMeasureName field's value.

func (MixedMeasureMapping) String added in v1.44.210

func (s MixedMeasureMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MixedMeasureMapping) Validate added in v1.44.210

func (s *MixedMeasureMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MultiMeasureAttributeMapping added in v1.44.210

type MultiMeasureAttributeMapping struct {
	MeasureValueType *string `type:"string" enum:"ScalarMeasureValueType"`

	// SourceColumn is a required field
	SourceColumn *string `min:"1" type:"string" required:"true"`

	TargetMultiMeasureAttributeName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (MultiMeasureAttributeMapping) GoString added in v1.44.210

func (s MultiMeasureAttributeMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MultiMeasureAttributeMapping) SetMeasureValueType added in v1.44.210

SetMeasureValueType sets the MeasureValueType field's value.

func (*MultiMeasureAttributeMapping) SetSourceColumn added in v1.44.210

SetSourceColumn sets the SourceColumn field's value.

func (*MultiMeasureAttributeMapping) SetTargetMultiMeasureAttributeName added in v1.44.210

func (s *MultiMeasureAttributeMapping) SetTargetMultiMeasureAttributeName(v string) *MultiMeasureAttributeMapping

SetTargetMultiMeasureAttributeName sets the TargetMultiMeasureAttributeName field's value.

func (MultiMeasureAttributeMapping) String added in v1.44.210

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MultiMeasureAttributeMapping) Validate added in v1.44.210

func (s *MultiMeasureAttributeMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MultiMeasureMappings added in v1.44.210

type MultiMeasureMappings struct {

	// MultiMeasureAttributeMappings is a required field
	MultiMeasureAttributeMappings []*MultiMeasureAttributeMapping `min:"1" type:"list" required:"true"`

	TargetMultiMeasureName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (MultiMeasureMappings) GoString added in v1.44.210

func (s MultiMeasureMappings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MultiMeasureMappings) SetMultiMeasureAttributeMappings added in v1.44.210

func (s *MultiMeasureMappings) SetMultiMeasureAttributeMappings(v []*MultiMeasureAttributeMapping) *MultiMeasureMappings

SetMultiMeasureAttributeMappings sets the MultiMeasureAttributeMappings field's value.

func (*MultiMeasureMappings) SetTargetMultiMeasureName added in v1.44.210

func (s *MultiMeasureMappings) SetTargetMultiMeasureName(v string) *MultiMeasureMappings

SetTargetMultiMeasureName sets the TargetMultiMeasureName field's value.

func (MultiMeasureMappings) String added in v1.44.210

func (s MultiMeasureMappings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MultiMeasureMappings) Validate added in v1.44.210

func (s *MultiMeasureMappings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Record

type Record struct {

	// Contains the list of dimensions for time-series data points.
	Dimensions []*Dimension `type:"list"`

	// 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 `min:"1" type:"string"`

	// Contains the measure value for the time-series data point.
	MeasureValue *string `min:"1" type:"string"`

	// Contains the data type of the measure value for the time-series data point.
	// Default type is DOUBLE.
	MeasureValueType *string `type:"string" enum:"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 `type:"list"`

	// 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 `min:"1" type:"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 *string `type:"string" enum:"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 `type:"long"`
	// contains filtered or unexported fields
}

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 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). Additionally, a record contains the measure value and the value type, which is the data type of the measure value. Also, the record contains the timestamp of when the measure was collected and 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.

func (Record) GoString

func (s Record) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Record) SetDimensions

func (s *Record) SetDimensions(v []*Dimension) *Record

SetDimensions sets the Dimensions field's value.

func (*Record) SetMeasureName

func (s *Record) SetMeasureName(v string) *Record

SetMeasureName sets the MeasureName field's value.

func (*Record) SetMeasureValue

func (s *Record) SetMeasureValue(v string) *Record

SetMeasureValue sets the MeasureValue field's value.

func (*Record) SetMeasureValueType

func (s *Record) SetMeasureValueType(v string) *Record

SetMeasureValueType sets the MeasureValueType field's value.

func (*Record) SetMeasureValues added in v1.42.12

func (s *Record) SetMeasureValues(v []*MeasureValue) *Record

SetMeasureValues sets the MeasureValues field's value.

func (*Record) SetTime

func (s *Record) SetTime(v string) *Record

SetTime sets the Time field's value.

func (*Record) SetTimeUnit

func (s *Record) SetTimeUnit(v string) *Record

SetTimeUnit sets the TimeUnit field's value.

func (*Record) SetVersion added in v1.35.35

func (s *Record) SetVersion(v int64) *Record

SetVersion sets the Version field's value.

func (Record) String

func (s Record) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Record) Validate

func (s *Record) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RecordsIngested added in v1.42.12

type RecordsIngested struct {

	// Count of records ingested into the magnetic store.
	MagneticStore *int64 `type:"integer"`

	// Count of records ingested into the memory store.
	MemoryStore *int64 `type:"integer"`

	// Total count of successfully ingested records.
	Total *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information on the records ingested by this request.

func (RecordsIngested) GoString added in v1.42.12

func (s RecordsIngested) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecordsIngested) SetMagneticStore added in v1.42.12

func (s *RecordsIngested) SetMagneticStore(v int64) *RecordsIngested

SetMagneticStore sets the MagneticStore field's value.

func (*RecordsIngested) SetMemoryStore added in v1.42.12

func (s *RecordsIngested) SetMemoryStore(v int64) *RecordsIngested

SetMemoryStore sets the MemoryStore field's value.

func (*RecordsIngested) SetTotal added in v1.42.12

func (s *RecordsIngested) SetTotal(v int64) *RecordsIngested

SetTotal sets the Total field's value.

func (RecordsIngested) String added in v1.42.12

func (s RecordsIngested) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `type:"long"`

	// 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 `type:"string"`

	// The index of the record in the input request for WriteRecords. Indexes begin
	// with 0.
	RecordIndex *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents records that were not successfully inserted into Timestream due to data validation issues that must be resolved before reinserting time-series data into the system.

func (RejectedRecord) GoString

func (s RejectedRecord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RejectedRecord) SetExistingVersion added in v1.35.35

func (s *RejectedRecord) SetExistingVersion(v int64) *RejectedRecord

SetExistingVersion sets the ExistingVersion field's value.

func (*RejectedRecord) SetReason

func (s *RejectedRecord) SetReason(v string) *RejectedRecord

SetReason sets the Reason field's value.

func (*RejectedRecord) SetRecordIndex

func (s *RejectedRecord) SetRecordIndex(v int64) *RejectedRecord

SetRecordIndex sets the RecordIndex field's value.

func (RejectedRecord) String

func (s RejectedRecord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RejectedRecordsException

type RejectedRecordsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	RejectedRecords []*RejectedRecord `type:"list"`
	// 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 Amazon Timestream Developer Guide.

func (*RejectedRecordsException) Code

func (s *RejectedRecordsException) Code() string

Code returns the exception type name.

func (*RejectedRecordsException) Error

func (s *RejectedRecordsException) Error() string

func (RejectedRecordsException) GoString

func (s RejectedRecordsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RejectedRecordsException) Message

func (s *RejectedRecordsException) Message() string

Message returns the exception's message.

func (*RejectedRecordsException) OrigErr

func (s *RejectedRecordsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RejectedRecordsException) RequestID

func (s *RejectedRecordsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RejectedRecordsException) StatusCode

func (s *RejectedRecordsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RejectedRecordsException) String

func (s RejectedRecordsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReportConfiguration added in v1.44.210

type ReportConfiguration struct {

	// Configuration of an S3 location to write error reports and events for a batch
	// load.
	ReportS3Configuration *ReportS3Configuration `type:"structure"`
	// contains filtered or unexported fields
}

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

func (ReportConfiguration) GoString added in v1.44.210

func (s ReportConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportConfiguration) SetReportS3Configuration added in v1.44.210

func (s *ReportConfiguration) SetReportS3Configuration(v *ReportS3Configuration) *ReportConfiguration

SetReportS3Configuration sets the ReportS3Configuration field's value.

func (ReportConfiguration) String added in v1.44.210

func (s ReportConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportConfiguration) Validate added in v1.44.210

func (s *ReportConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReportS3Configuration added in v1.44.210

type ReportS3Configuration struct {

	// BucketName is a required field
	BucketName *string `min:"3" type:"string" required:"true"`

	EncryptionOption *string `type:"string" enum:"S3EncryptionOption"`

	KmsKeyId *string `min:"1" type:"string"`

	ObjectKeyPrefix *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ReportS3Configuration) GoString added in v1.44.210

func (s ReportS3Configuration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportS3Configuration) SetBucketName added in v1.44.210

func (s *ReportS3Configuration) SetBucketName(v string) *ReportS3Configuration

SetBucketName sets the BucketName field's value.

func (*ReportS3Configuration) SetEncryptionOption added in v1.44.210

func (s *ReportS3Configuration) SetEncryptionOption(v string) *ReportS3Configuration

SetEncryptionOption sets the EncryptionOption field's value.

func (*ReportS3Configuration) SetKmsKeyId added in v1.44.210

SetKmsKeyId sets the KmsKeyId field's value.

func (*ReportS3Configuration) SetObjectKeyPrefix added in v1.44.210

func (s *ReportS3Configuration) SetObjectKeyPrefix(v string) *ReportS3Configuration

SetObjectKeyPrefix sets the ObjectKeyPrefix field's value.

func (ReportS3Configuration) String added in v1.44.210

func (s ReportS3Configuration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportS3Configuration) Validate added in v1.44.210

func (s *ReportS3Configuration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"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) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResumeBatchLoadTaskInput added in v1.44.210

type ResumeBatchLoadTaskInput struct {

	// The ID of the batch load task to resume.
	//
	// TaskId is a required field
	TaskId *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ResumeBatchLoadTaskInput) GoString added in v1.44.210

func (s ResumeBatchLoadTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResumeBatchLoadTaskInput) SetTaskId added in v1.44.210

SetTaskId sets the TaskId field's value.

func (ResumeBatchLoadTaskInput) String added in v1.44.210

func (s ResumeBatchLoadTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResumeBatchLoadTaskInput) Validate added in v1.44.210

func (s *ResumeBatchLoadTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResumeBatchLoadTaskOutput added in v1.44.210

type ResumeBatchLoadTaskOutput struct {
	// contains filtered or unexported fields
}

func (ResumeBatchLoadTaskOutput) GoString added in v1.44.210

func (s ResumeBatchLoadTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ResumeBatchLoadTaskOutput) String added in v1.44.210

func (s ResumeBatchLoadTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetentionProperties

type RetentionProperties struct {

	// The duration for which data must be stored in the magnetic store.
	//
	// MagneticStoreRetentionPeriodInDays is a required field
	MagneticStoreRetentionPeriodInDays *int64 `min:"1" type:"long" required:"true"`

	// The duration for which data must be stored in the memory store.
	//
	// MemoryStoreRetentionPeriodInHours is a required field
	MemoryStoreRetentionPeriodInHours *int64 `min:"1" type:"long" required:"true"`
	// 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.

func (RetentionProperties) GoString

func (s RetentionProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetentionProperties) SetMagneticStoreRetentionPeriodInDays

func (s *RetentionProperties) SetMagneticStoreRetentionPeriodInDays(v int64) *RetentionProperties

SetMagneticStoreRetentionPeriodInDays sets the MagneticStoreRetentionPeriodInDays field's value.

func (*RetentionProperties) SetMemoryStoreRetentionPeriodInHours

func (s *RetentionProperties) SetMemoryStoreRetentionPeriodInHours(v int64) *RetentionProperties

SetMemoryStoreRetentionPeriodInHours sets the MemoryStoreRetentionPeriodInHours field's value.

func (RetentionProperties) String

func (s RetentionProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetentionProperties) Validate

func (s *RetentionProperties) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3Configuration added in v1.42.12

type S3Configuration struct {

	// The bucket name of the customer S3 bucket.
	BucketName *string `min:"3" type:"string"`

	// The encryption option for the customer S3 location. Options are S3 server-side
	// encryption with an S3 managed key or Amazon Web Services managed key.
	EncryptionOption *string `type:"string" enum:"S3EncryptionOption"`

	// The KMS key ID for the customer S3 location when encrypting with an Amazon
	// Web Services managed key.
	KmsKeyId *string `min:"1" type:"string"`

	// The object key preview for the customer S3 location.
	ObjectKeyPrefix *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The configuration that specifies an S3 location.

func (S3Configuration) GoString added in v1.42.12

func (s S3Configuration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Configuration) SetBucketName added in v1.42.12

func (s *S3Configuration) SetBucketName(v string) *S3Configuration

SetBucketName sets the BucketName field's value.

func (*S3Configuration) SetEncryptionOption added in v1.42.12

func (s *S3Configuration) SetEncryptionOption(v string) *S3Configuration

SetEncryptionOption sets the EncryptionOption field's value.

func (*S3Configuration) SetKmsKeyId added in v1.42.12

func (s *S3Configuration) SetKmsKeyId(v string) *S3Configuration

SetKmsKeyId sets the KmsKeyId field's value.

func (*S3Configuration) SetObjectKeyPrefix added in v1.42.12

func (s *S3Configuration) SetObjectKeyPrefix(v string) *S3Configuration

SetObjectKeyPrefix sets the ObjectKeyPrefix field's value.

func (S3Configuration) String added in v1.42.12

func (s S3Configuration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Configuration) Validate added in v1.42.12

func (s *S3Configuration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The instance quota of resource exceeded for this account.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Table

type Table struct {

	// The Amazon Resource Name that uniquely identifies this table.
	Arn *string `type:"string"`

	// The time when the Timestream table was created.
	CreationTime *time.Time `type:"timestamp"`

	// The name of the Timestream database that contains this table.
	DatabaseName *string `type:"string"`

	// The time when the Timestream table was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// Contains properties to set on the table when enabling magnetic store writes.
	MagneticStoreWriteProperties *MagneticStoreWriteProperties `type:"structure"`

	// The retention duration for the memory store and magnetic store.
	RetentionProperties *RetentionProperties `type:"structure"`

	// The name of the Timestream table.
	TableName *string `type:"string"`

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

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.

func (Table) GoString

func (s Table) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Table) SetArn

func (s *Table) SetArn(v string) *Table

SetArn sets the Arn field's value.

func (*Table) SetCreationTime

func (s *Table) SetCreationTime(v time.Time) *Table

SetCreationTime sets the CreationTime field's value.

func (*Table) SetDatabaseName

func (s *Table) SetDatabaseName(v string) *Table

SetDatabaseName sets the DatabaseName field's value.

func (*Table) SetLastUpdatedTime

func (s *Table) SetLastUpdatedTime(v time.Time) *Table

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*Table) SetMagneticStoreWriteProperties added in v1.42.12

func (s *Table) SetMagneticStoreWriteProperties(v *MagneticStoreWriteProperties) *Table

SetMagneticStoreWriteProperties sets the MagneticStoreWriteProperties field's value.

func (*Table) SetRetentionProperties

func (s *Table) SetRetentionProperties(v *RetentionProperties) *Table

SetRetentionProperties sets the RetentionProperties field's value.

func (*Table) SetTableName

func (s *Table) SetTableName(v string) *Table

SetTableName sets the TableName field's value.

func (*Table) SetTableStatus

func (s *Table) SetTableStatus(v string) *Table

SetTableStatus sets the TableStatus field's value.

func (Table) String

func (s Table) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag

type Tag struct {

	// The key of the tag. Tag keys are case sensitive.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag. Tag values are case-sensitive and can be null.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// 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. With tags, you can categorize databases and/or tables, for example, by purpose, owner, or environment.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput

type TagResourceInput struct {

	// Identifies the Timestream resource to which tags should be added. This value
	// is an Amazon Resource Name (ARN).
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The tags to be assigned to the Timestream resource.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimestreamWrite

type TimestreamWrite struct {
	*client.Client
	// contains filtered or unexported fields
}

TimestreamWrite provides the API operation methods for making requests to Amazon Timestream Write. See this package's package overview docs for details on the service.

TimestreamWrite methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the TimestreamWrite client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a TimestreamWrite client from just a session.
svc := timestreamwrite.New(mySession)

// Create a TimestreamWrite client with additional configuration
svc := timestreamwrite.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*TimestreamWrite) CreateBatchLoadTask added in v1.44.210

func (c *TimestreamWrite) CreateBatchLoadTask(input *CreateBatchLoadTaskInput) (*CreateBatchLoadTaskOutput, error)

CreateBatchLoadTask API operation for Amazon Timestream Write.

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 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 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). For details, see code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation CreateBatchLoadTask for usage and error information.

Returned Error Types:

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

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • AccessDeniedException You are not authorized to perform this action.

  • ValidationException An invalid or malformed request.

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

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

  • ServiceQuotaExceededException The instance quota of resource exceeded for this account.

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateBatchLoadTask

func (*TimestreamWrite) CreateBatchLoadTaskRequest added in v1.44.210

func (c *TimestreamWrite) CreateBatchLoadTaskRequest(input *CreateBatchLoadTaskInput) (req *request.Request, output *CreateBatchLoadTaskOutput)

CreateBatchLoadTaskRequest generates a "aws/request.Request" representing the client's request for the CreateBatchLoadTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBatchLoadTask for more information on using the CreateBatchLoadTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateBatchLoadTaskRequest method.
req, resp := client.CreateBatchLoadTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateBatchLoadTask

func (*TimestreamWrite) CreateBatchLoadTaskWithContext added in v1.44.210

func (c *TimestreamWrite) CreateBatchLoadTaskWithContext(ctx aws.Context, input *CreateBatchLoadTaskInput, opts ...request.Option) (*CreateBatchLoadTaskOutput, error)

CreateBatchLoadTaskWithContext is the same as CreateBatchLoadTask with the addition of the ability to pass a context and additional request options.

See CreateBatchLoadTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) CreateDatabase

func (c *TimestreamWrite) CreateDatabase(input *CreateDatabaseInput) (*CreateDatabaseOutput, error)

CreateDatabase API operation for Amazon Timestream Write.

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 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). For details, see code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation CreateDatabase for usage and error information.

Returned Error Types:

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

  • ValidationException An invalid or malformed request.

  • AccessDeniedException You are not authorized to perform this action.

  • ServiceQuotaExceededException The instance quota of resource exceeded for this account.

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • InvalidEndpointException The requested endpoint was not valid.

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

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateDatabase

func (*TimestreamWrite) CreateDatabaseRequest

func (c *TimestreamWrite) CreateDatabaseRequest(input *CreateDatabaseInput) (req *request.Request, output *CreateDatabaseOutput)

CreateDatabaseRequest generates a "aws/request.Request" representing the client's request for the CreateDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDatabase for more information on using the CreateDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDatabaseRequest method.
req, resp := client.CreateDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateDatabase

func (*TimestreamWrite) CreateDatabaseWithContext

func (c *TimestreamWrite) CreateDatabaseWithContext(ctx aws.Context, input *CreateDatabaseInput, opts ...request.Option) (*CreateDatabaseOutput, error)

CreateDatabaseWithContext is the same as CreateDatabase with the addition of the ability to pass a context and additional request options.

See CreateDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) CreateTable

func (c *TimestreamWrite) CreateTable(input *CreateTableInput) (*CreateTableOutput, error)

CreateTable API operation for Amazon Timestream Write.

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 (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation CreateTable for usage and error information.

Returned Error Types:

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

  • ValidationException An invalid or malformed request.

  • AccessDeniedException You are not authorized to perform this action.

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

  • ServiceQuotaExceededException The instance quota of resource exceeded for this account.

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • InvalidEndpointException The requested endpoint was not valid.

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

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTable

func (*TimestreamWrite) CreateTableRequest

func (c *TimestreamWrite) CreateTableRequest(input *CreateTableInput) (req *request.Request, output *CreateTableOutput)

CreateTableRequest generates a "aws/request.Request" representing the client's request for the CreateTable operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTable for more information on using the CreateTable API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateTableRequest method.
req, resp := client.CreateTableRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTable

func (*TimestreamWrite) CreateTableWithContext

func (c *TimestreamWrite) CreateTableWithContext(ctx aws.Context, input *CreateTableInput, opts ...request.Option) (*CreateTableOutput, error)

CreateTableWithContext is the same as CreateTable with the addition of the ability to pass a context and additional request options.

See CreateTable for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) DeleteDatabase

func (c *TimestreamWrite) DeleteDatabase(input *DeleteDatabaseInput) (*DeleteDatabaseOutput, error)

DeleteDatabase API operation for Amazon Timestream Write.

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

All tables in the database must be deleted first, or a ValidationException error will be thrown.

Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.

See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation DeleteDatabase for usage and error information.

Returned Error Types:

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

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

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

  • ValidationException An invalid or malformed request.

  • AccessDeniedException You are not authorized to perform this action.

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DeleteDatabase

func (*TimestreamWrite) DeleteDatabaseRequest

func (c *TimestreamWrite) DeleteDatabaseRequest(input *DeleteDatabaseInput) (req *request.Request, output *DeleteDatabaseOutput)

DeleteDatabaseRequest generates a "aws/request.Request" representing the client's request for the DeleteDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDatabase for more information on using the DeleteDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDatabaseRequest method.
req, resp := client.DeleteDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DeleteDatabase

func (*TimestreamWrite) DeleteDatabaseWithContext

func (c *TimestreamWrite) DeleteDatabaseWithContext(ctx aws.Context, input *DeleteDatabaseInput, opts ...request.Option) (*DeleteDatabaseOutput, error)

DeleteDatabaseWithContext is the same as DeleteDatabase with the addition of the ability to pass a context and additional request options.

See DeleteDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) DeleteTable

func (c *TimestreamWrite) DeleteTable(input *DeleteTableInput) (*DeleteTableOutput, error)

DeleteTable API operation for Amazon Timestream Write.

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

Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.

See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation DeleteTable for usage and error information.

Returned Error Types:

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

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • ValidationException An invalid or malformed request.

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

  • AccessDeniedException You are not authorized to perform this action.

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DeleteTable

func (*TimestreamWrite) DeleteTableRequest

func (c *TimestreamWrite) DeleteTableRequest(input *DeleteTableInput) (req *request.Request, output *DeleteTableOutput)

DeleteTableRequest generates a "aws/request.Request" representing the client's request for the DeleteTable operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTable for more information on using the DeleteTable API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteTableRequest method.
req, resp := client.DeleteTableRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DeleteTable

func (*TimestreamWrite) DeleteTableWithContext

func (c *TimestreamWrite) DeleteTableWithContext(ctx aws.Context, input *DeleteTableInput, opts ...request.Option) (*DeleteTableOutput, error)

DeleteTableWithContext is the same as DeleteTable with the addition of the ability to pass a context and additional request options.

See DeleteTable for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) DescribeBatchLoadTask added in v1.44.210

func (c *TimestreamWrite) DescribeBatchLoadTask(input *DescribeBatchLoadTaskInput) (*DescribeBatchLoadTaskOutput, error)

DescribeBatchLoadTask API operation for Amazon Timestream Write.

Returns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation DescribeBatchLoadTask for usage and error information.

Returned Error Types:

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

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • AccessDeniedException You are not authorized to perform this action.

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

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeBatchLoadTask

func (*TimestreamWrite) DescribeBatchLoadTaskRequest added in v1.44.210

func (c *TimestreamWrite) DescribeBatchLoadTaskRequest(input *DescribeBatchLoadTaskInput) (req *request.Request, output *DescribeBatchLoadTaskOutput)

DescribeBatchLoadTaskRequest generates a "aws/request.Request" representing the client's request for the DescribeBatchLoadTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBatchLoadTask for more information on using the DescribeBatchLoadTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeBatchLoadTaskRequest method.
req, resp := client.DescribeBatchLoadTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeBatchLoadTask

func (*TimestreamWrite) DescribeBatchLoadTaskWithContext added in v1.44.210

func (c *TimestreamWrite) DescribeBatchLoadTaskWithContext(ctx aws.Context, input *DescribeBatchLoadTaskInput, opts ...request.Option) (*DescribeBatchLoadTaskOutput, error)

DescribeBatchLoadTaskWithContext is the same as DescribeBatchLoadTask with the addition of the ability to pass a context and additional request options.

See DescribeBatchLoadTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) DescribeDatabase

func (c *TimestreamWrite) DescribeDatabase(input *DescribeDatabaseInput) (*DescribeDatabaseOutput, error)

DescribeDatabase API operation for Amazon Timestream Write.

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 (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation DescribeDatabase for usage and error information.

Returned Error Types:

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

  • ValidationException An invalid or malformed request.

  • AccessDeniedException You are not authorized to perform this action.

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

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

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeDatabase

func (*TimestreamWrite) DescribeDatabaseRequest

func (c *TimestreamWrite) DescribeDatabaseRequest(input *DescribeDatabaseInput) (req *request.Request, output *DescribeDatabaseOutput)

DescribeDatabaseRequest generates a "aws/request.Request" representing the client's request for the DescribeDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDatabase for more information on using the DescribeDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDatabaseRequest method.
req, resp := client.DescribeDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeDatabase

func (*TimestreamWrite) DescribeDatabaseWithContext

func (c *TimestreamWrite) DescribeDatabaseWithContext(ctx aws.Context, input *DescribeDatabaseInput, opts ...request.Option) (*DescribeDatabaseOutput, error)

DescribeDatabaseWithContext is the same as DescribeDatabase with the addition of the ability to pass a context and additional request options.

See DescribeDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) DescribeEndpoints

func (c *TimestreamWrite) DescribeEndpoints(input *DescribeEndpointsInput) (*DescribeEndpointsOutput, error)

DescribeEndpoints API operation for Amazon Timestream Write.

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:

For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern (https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation DescribeEndpoints for usage and error information.

Returned Error Types:

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

  • ValidationException An invalid or malformed request.

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeEndpoints

func (*TimestreamWrite) DescribeEndpointsRequest

func (c *TimestreamWrite) DescribeEndpointsRequest(input *DescribeEndpointsInput) (req *request.Request, output *DescribeEndpointsOutput)

DescribeEndpointsRequest generates a "aws/request.Request" representing the client's request for the DescribeEndpoints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEndpoints for more information on using the DescribeEndpoints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEndpointsRequest method.
req, resp := client.DescribeEndpointsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeEndpoints

func (*TimestreamWrite) DescribeEndpointsWithContext

func (c *TimestreamWrite) DescribeEndpointsWithContext(ctx aws.Context, input *DescribeEndpointsInput, opts ...request.Option) (*DescribeEndpointsOutput, error)

DescribeEndpointsWithContext is the same as DescribeEndpoints with the addition of the ability to pass a context and additional request options.

See DescribeEndpoints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) DescribeTable

func (c *TimestreamWrite) DescribeTable(input *DescribeTableInput) (*DescribeTableOutput, error)

DescribeTable API operation for Amazon Timestream Write.

Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation DescribeTable for usage and error information.

Returned Error Types:

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

  • ValidationException An invalid or malformed request.

  • AccessDeniedException You are not authorized to perform this action.

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

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

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeTable

func (*TimestreamWrite) DescribeTableRequest

func (c *TimestreamWrite) DescribeTableRequest(input *DescribeTableInput) (req *request.Request, output *DescribeTableOutput)

DescribeTableRequest generates a "aws/request.Request" representing the client's request for the DescribeTable operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTable for more information on using the DescribeTable API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTableRequest method.
req, resp := client.DescribeTableRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeTable

func (*TimestreamWrite) DescribeTableWithContext

func (c *TimestreamWrite) DescribeTableWithContext(ctx aws.Context, input *DescribeTableInput, opts ...request.Option) (*DescribeTableOutput, error)

DescribeTableWithContext is the same as DescribeTable with the addition of the ability to pass a context and additional request options.

See DescribeTable for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) ListBatchLoadTasks added in v1.44.210

func (c *TimestreamWrite) ListBatchLoadTasks(input *ListBatchLoadTasksInput) (*ListBatchLoadTasksOutput, error)

ListBatchLoadTasks API operation for Amazon Timestream Write.

Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation ListBatchLoadTasks for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You are not authorized to perform this action.

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • ValidationException An invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListBatchLoadTasks

func (*TimestreamWrite) ListBatchLoadTasksPages added in v1.44.210

func (c *TimestreamWrite) ListBatchLoadTasksPages(input *ListBatchLoadTasksInput, fn func(*ListBatchLoadTasksOutput, bool) bool) error

ListBatchLoadTasksPages iterates over the pages of a ListBatchLoadTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBatchLoadTasks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListBatchLoadTasks operation.
pageNum := 0
err := client.ListBatchLoadTasksPages(params,
    func(page *timestreamwrite.ListBatchLoadTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TimestreamWrite) ListBatchLoadTasksPagesWithContext added in v1.44.210

func (c *TimestreamWrite) ListBatchLoadTasksPagesWithContext(ctx aws.Context, input *ListBatchLoadTasksInput, fn func(*ListBatchLoadTasksOutput, bool) bool, opts ...request.Option) error

ListBatchLoadTasksPagesWithContext same as ListBatchLoadTasksPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) ListBatchLoadTasksRequest added in v1.44.210

func (c *TimestreamWrite) ListBatchLoadTasksRequest(input *ListBatchLoadTasksInput) (req *request.Request, output *ListBatchLoadTasksOutput)

ListBatchLoadTasksRequest generates a "aws/request.Request" representing the client's request for the ListBatchLoadTasks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBatchLoadTasks for more information on using the ListBatchLoadTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListBatchLoadTasksRequest method.
req, resp := client.ListBatchLoadTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListBatchLoadTasks

func (*TimestreamWrite) ListBatchLoadTasksWithContext added in v1.44.210

func (c *TimestreamWrite) ListBatchLoadTasksWithContext(ctx aws.Context, input *ListBatchLoadTasksInput, opts ...request.Option) (*ListBatchLoadTasksOutput, error)

ListBatchLoadTasksWithContext is the same as ListBatchLoadTasks with the addition of the ability to pass a context and additional request options.

See ListBatchLoadTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) ListDatabases

func (c *TimestreamWrite) ListDatabases(input *ListDatabasesInput) (*ListDatabasesOutput, error)

ListDatabases API operation for Amazon Timestream Write.

Returns a list of your Timestream databases. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation ListDatabases for usage and error information.

Returned Error Types:

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

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • ValidationException An invalid or malformed request.

  • AccessDeniedException You are not authorized to perform this action.

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListDatabases

func (*TimestreamWrite) ListDatabasesPages

func (c *TimestreamWrite) ListDatabasesPages(input *ListDatabasesInput, fn func(*ListDatabasesOutput, bool) bool) error

ListDatabasesPages iterates over the pages of a ListDatabases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDatabases method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDatabases operation.
pageNum := 0
err := client.ListDatabasesPages(params,
    func(page *timestreamwrite.ListDatabasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TimestreamWrite) ListDatabasesPagesWithContext

func (c *TimestreamWrite) ListDatabasesPagesWithContext(ctx aws.Context, input *ListDatabasesInput, fn func(*ListDatabasesOutput, bool) bool, opts ...request.Option) error

ListDatabasesPagesWithContext same as ListDatabasesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) ListDatabasesRequest

func (c *TimestreamWrite) ListDatabasesRequest(input *ListDatabasesInput) (req *request.Request, output *ListDatabasesOutput)

ListDatabasesRequest generates a "aws/request.Request" representing the client's request for the ListDatabases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDatabases for more information on using the ListDatabases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDatabasesRequest method.
req, resp := client.ListDatabasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListDatabases

func (*TimestreamWrite) ListDatabasesWithContext

func (c *TimestreamWrite) ListDatabasesWithContext(ctx aws.Context, input *ListDatabasesInput, opts ...request.Option) (*ListDatabasesOutput, error)

ListDatabasesWithContext is the same as ListDatabases with the addition of the ability to pass a context and additional request options.

See ListDatabases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) ListTables

func (c *TimestreamWrite) ListTables(input *ListTablesInput) (*ListTablesOutput, error)

ListTables API operation for Amazon Timestream Write.

Provides a list of tables, along with the name, status, and retention properties of each table. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation ListTables for usage and error information.

Returned Error Types:

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

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • ValidationException An invalid or malformed request.

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

  • AccessDeniedException You are not authorized to perform this action.

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTables

func (*TimestreamWrite) ListTablesPages

func (c *TimestreamWrite) ListTablesPages(input *ListTablesInput, fn func(*ListTablesOutput, bool) bool) error

ListTablesPages iterates over the pages of a ListTables operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTables method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTables operation.
pageNum := 0
err := client.ListTablesPages(params,
    func(page *timestreamwrite.ListTablesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TimestreamWrite) ListTablesPagesWithContext

func (c *TimestreamWrite) ListTablesPagesWithContext(ctx aws.Context, input *ListTablesInput, fn func(*ListTablesOutput, bool) bool, opts ...request.Option) error

ListTablesPagesWithContext same as ListTablesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) ListTablesRequest

func (c *TimestreamWrite) ListTablesRequest(input *ListTablesInput) (req *request.Request, output *ListTablesOutput)

ListTablesRequest generates a "aws/request.Request" representing the client's request for the ListTables operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTables for more information on using the ListTables API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTablesRequest method.
req, resp := client.ListTablesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTables

func (*TimestreamWrite) ListTablesWithContext

func (c *TimestreamWrite) ListTablesWithContext(ctx aws.Context, input *ListTablesInput, opts ...request.Option) (*ListTablesOutput, error)

ListTablesWithContext is the same as ListTables with the addition of the ability to pass a context and additional request options.

See ListTables for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) ListTagsForResource

func (c *TimestreamWrite) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Timestream Write.

Lists all tags on a Timestream resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation ListTagsForResource for usage and error information.

Returned Error Types:

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

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • ValidationException An invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTagsForResource

func (*TimestreamWrite) ListTagsForResourceRequest

func (c *TimestreamWrite) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTagsForResource

func (*TimestreamWrite) ListTagsForResourceWithContext

func (c *TimestreamWrite) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) ResumeBatchLoadTask added in v1.44.210

func (c *TimestreamWrite) ResumeBatchLoadTask(input *ResumeBatchLoadTaskInput) (*ResumeBatchLoadTaskOutput, error)

ResumeBatchLoadTask API operation for Amazon Timestream Write.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation ResumeBatchLoadTask for usage and error information.

Returned Error Types:

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

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • AccessDeniedException You are not authorized to perform this action.

  • ValidationException An invalid or malformed request.

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

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ResumeBatchLoadTask

func (*TimestreamWrite) ResumeBatchLoadTaskRequest added in v1.44.210

func (c *TimestreamWrite) ResumeBatchLoadTaskRequest(input *ResumeBatchLoadTaskInput) (req *request.Request, output *ResumeBatchLoadTaskOutput)

ResumeBatchLoadTaskRequest generates a "aws/request.Request" representing the client's request for the ResumeBatchLoadTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResumeBatchLoadTask for more information on using the ResumeBatchLoadTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ResumeBatchLoadTaskRequest method.
req, resp := client.ResumeBatchLoadTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ResumeBatchLoadTask

func (*TimestreamWrite) ResumeBatchLoadTaskWithContext added in v1.44.210

func (c *TimestreamWrite) ResumeBatchLoadTaskWithContext(ctx aws.Context, input *ResumeBatchLoadTaskInput, opts ...request.Option) (*ResumeBatchLoadTaskOutput, error)

ResumeBatchLoadTaskWithContext is the same as ResumeBatchLoadTask with the addition of the ability to pass a context and additional request options.

See ResumeBatchLoadTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) TagResource

func (c *TimestreamWrite) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Timestream Write.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation TagResource for usage and error information.

Returned Error Types:

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

  • ServiceQuotaExceededException The instance quota of resource exceeded for this account.

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • ValidationException An invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/TagResource

func (*TimestreamWrite) TagResourceRequest

func (c *TimestreamWrite) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/TagResource

func (*TimestreamWrite) TagResourceWithContext

func (c *TimestreamWrite) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) UntagResource

func (c *TimestreamWrite) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Timestream Write.

Removes the association of tags from a Timestream resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation UntagResource for usage and error information.

Returned Error Types:

  • ValidationException An invalid or malformed request.

  • ServiceQuotaExceededException The instance quota of resource exceeded for this account.

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

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

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UntagResource

func (*TimestreamWrite) UntagResourceRequest

func (c *TimestreamWrite) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UntagResource

func (*TimestreamWrite) UntagResourceWithContext

func (c *TimestreamWrite) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) UpdateDatabase

func (c *TimestreamWrite) UpdateDatabase(input *UpdateDatabaseInput) (*UpdateDatabaseOutput, error)

UpdateDatabase API operation for Amazon Timestream Write.

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 (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation UpdateDatabase for usage and error information.

Returned Error Types:

  • ValidationException An invalid or malformed request.

  • AccessDeniedException You are not authorized to perform this action.

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

  • ServiceQuotaExceededException The instance quota of resource exceeded for this account.

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

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

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateDatabase

func (*TimestreamWrite) UpdateDatabaseRequest

func (c *TimestreamWrite) UpdateDatabaseRequest(input *UpdateDatabaseInput) (req *request.Request, output *UpdateDatabaseOutput)

UpdateDatabaseRequest generates a "aws/request.Request" representing the client's request for the UpdateDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDatabase for more information on using the UpdateDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateDatabaseRequest method.
req, resp := client.UpdateDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateDatabase

func (*TimestreamWrite) UpdateDatabaseWithContext

func (c *TimestreamWrite) UpdateDatabaseWithContext(ctx aws.Context, input *UpdateDatabaseInput, opts ...request.Option) (*UpdateDatabaseOutput, error)

UpdateDatabaseWithContext is the same as UpdateDatabase with the addition of the ability to pass a context and additional request options.

See UpdateDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) UpdateTable

func (c *TimestreamWrite) UpdateTable(input *UpdateTableInput) (*UpdateTableOutput, error)

UpdateTable API operation for Amazon Timestream Write.

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 (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html) for details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation UpdateTable for usage and error information.

Returned Error Types:

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

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • ValidationException An invalid or malformed request.

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

  • AccessDeniedException You are not authorized to perform this action.

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTable

func (*TimestreamWrite) UpdateTableRequest

func (c *TimestreamWrite) UpdateTableRequest(input *UpdateTableInput) (req *request.Request, output *UpdateTableOutput)

UpdateTableRequest generates a "aws/request.Request" representing the client's request for the UpdateTable operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateTable for more information on using the UpdateTable API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateTableRequest method.
req, resp := client.UpdateTableRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTable

func (*TimestreamWrite) UpdateTableWithContext

func (c *TimestreamWrite) UpdateTableWithContext(ctx aws.Context, input *UpdateTableInput, opts ...request.Option) (*UpdateTableOutput, error)

UpdateTableWithContext is the same as UpdateTable with the addition of the ability to pass a context and additional request options.

See UpdateTable for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TimestreamWrite) WriteRecords

func (c *TimestreamWrite) WriteRecords(input *WriteRecordsInput) (*WriteRecordsOutput, error)

WriteRecords API operation for Amazon Timestream Write.

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 (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html).

See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html) 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Timestream Write's API operation WriteRecords for usage and error information.

Returned Error Types:

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

  • ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.

  • ValidationException An invalid or malformed request.

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

  • AccessDeniedException You are not authorized to perform this action.

  • RejectedRecordsException 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 Amazon Timestream Developer Guide.

  • InvalidEndpointException The requested endpoint was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecords

func (*TimestreamWrite) WriteRecordsRequest

func (c *TimestreamWrite) WriteRecordsRequest(input *WriteRecordsInput) (req *request.Request, output *WriteRecordsOutput)

WriteRecordsRequest generates a "aws/request.Request" representing the client's request for the WriteRecords operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See WriteRecords for more information on using the WriteRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the WriteRecordsRequest method.
req, resp := client.WriteRecordsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecords

func (*TimestreamWrite) WriteRecordsWithContext

func (c *TimestreamWrite) WriteRecordsWithContext(ctx aws.Context, input *WriteRecordsInput, opts ...request.Option) (*WriteRecordsOutput, error)

WriteRecordsWithContext is the same as WriteRecords with the addition of the ability to pass a context and additional request options.

See WriteRecords for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type UntagResourceInput

type UntagResourceInput struct {

	// The Timestream resource that the tags will be removed from. This value is
	// an Amazon Resource Name (ARN).
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A list of tags keys. Existing tags of the resource whose keys are members
	// of this list will be removed from the Timestream resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDatabaseInput

type UpdateDatabaseInput struct {

	// The name of the database.
	//
	// DatabaseName is a required field
	DatabaseName *string `type:"string" required:"true"`

	// 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
	//
	// KmsKeyId is a required field
	KmsKeyId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDatabaseInput) GoString

func (s UpdateDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDatabaseInput) SetDatabaseName

func (s *UpdateDatabaseInput) SetDatabaseName(v string) *UpdateDatabaseInput

SetDatabaseName sets the DatabaseName field's value.

func (*UpdateDatabaseInput) SetKmsKeyId

func (s *UpdateDatabaseInput) SetKmsKeyId(v string) *UpdateDatabaseInput

SetKmsKeyId sets the KmsKeyId field's value.

func (UpdateDatabaseInput) String

func (s UpdateDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDatabaseInput) Validate

func (s *UpdateDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDatabaseOutput

type UpdateDatabaseOutput struct {

	// 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.
	Database *Database `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDatabaseOutput) GoString

func (s UpdateDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDatabaseOutput) SetDatabase

SetDatabase sets the Database field's value.

func (UpdateDatabaseOutput) String

func (s UpdateDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateTableInput

type UpdateTableInput struct {

	// The name of the Timestream database.
	//
	// DatabaseName is a required field
	DatabaseName *string `type:"string" required:"true"`

	// Contains properties to set on the table when enabling magnetic store writes.
	MagneticStoreWriteProperties *MagneticStoreWriteProperties `type:"structure"`

	// The retention duration of the memory store and the magnetic store.
	RetentionProperties *RetentionProperties `type:"structure"`

	// The name of the Timestream table.
	//
	// TableName is a required field
	TableName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTableInput) GoString

func (s UpdateTableInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTableInput) SetDatabaseName

func (s *UpdateTableInput) SetDatabaseName(v string) *UpdateTableInput

SetDatabaseName sets the DatabaseName field's value.

func (*UpdateTableInput) SetMagneticStoreWriteProperties added in v1.42.12

func (s *UpdateTableInput) SetMagneticStoreWriteProperties(v *MagneticStoreWriteProperties) *UpdateTableInput

SetMagneticStoreWriteProperties sets the MagneticStoreWriteProperties field's value.

func (*UpdateTableInput) SetRetentionProperties

func (s *UpdateTableInput) SetRetentionProperties(v *RetentionProperties) *UpdateTableInput

SetRetentionProperties sets the RetentionProperties field's value.

func (*UpdateTableInput) SetTableName

func (s *UpdateTableInput) SetTableName(v string) *UpdateTableInput

SetTableName sets the TableName field's value.

func (UpdateTableInput) String

func (s UpdateTableInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTableInput) Validate

func (s *UpdateTableInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateTableOutput

type UpdateTableOutput struct {

	// The updated Timestream table.
	Table *Table `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateTableOutput) GoString

func (s UpdateTableOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTableOutput) SetTable

func (s *UpdateTableOutput) SetTable(v *Table) *UpdateTableOutput

SetTable sets the Table field's value.

func (UpdateTableOutput) String

func (s UpdateTableOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An invalid or malformed request.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WriteRecordsInput

type WriteRecordsInput struct {

	// 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.
	CommonAttributes *Record `type:"structure"`

	// The name of the Timestream database.
	//
	// DatabaseName is a required field
	DatabaseName *string `type:"string" required:"true"`

	// An array of records that contain the unique measure, dimension, time, and
	// version attributes for each time-series data point.
	//
	// Records is a required field
	Records []*Record `min:"1" type:"list" required:"true"`

	// The name of the Timestream table.
	//
	// TableName is a required field
	TableName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (WriteRecordsInput) GoString

func (s WriteRecordsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteRecordsInput) SetCommonAttributes

func (s *WriteRecordsInput) SetCommonAttributes(v *Record) *WriteRecordsInput

SetCommonAttributes sets the CommonAttributes field's value.

func (*WriteRecordsInput) SetDatabaseName

func (s *WriteRecordsInput) SetDatabaseName(v string) *WriteRecordsInput

SetDatabaseName sets the DatabaseName field's value.

func (*WriteRecordsInput) SetRecords

func (s *WriteRecordsInput) SetRecords(v []*Record) *WriteRecordsInput

SetRecords sets the Records field's value.

func (*WriteRecordsInput) SetTableName

func (s *WriteRecordsInput) SetTableName(v string) *WriteRecordsInput

SetTableName sets the TableName field's value.

func (WriteRecordsInput) String

func (s WriteRecordsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteRecordsInput) Validate

func (s *WriteRecordsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WriteRecordsOutput

type WriteRecordsOutput struct {

	// Information on the records ingested by this request.
	RecordsIngested *RecordsIngested `type:"structure"`
	// contains filtered or unexported fields
}

func (WriteRecordsOutput) GoString

func (s WriteRecordsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteRecordsOutput) SetRecordsIngested added in v1.42.12

func (s *WriteRecordsOutput) SetRecordsIngested(v *RecordsIngested) *WriteRecordsOutput

SetRecordsIngested sets the RecordsIngested field's value.

func (WriteRecordsOutput) String

func (s WriteRecordsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package timestreamwriteiface provides an interface to enable mocking the Amazon Timestream Write service client for testing your code.
Package timestreamwriteiface provides an interface to enable mocking the Amazon Timestream Write service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL