timestreamquery

package
v1.52.1 Latest Latest
Warning

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

 Go to latest Published: May 2, 2024 License: Apache-2.0 Imports: 13 Imported by: 44

Documentation

Overview

Package timestreamquery provides the client and types for making API requests to Amazon Timestream Query.

Amazon Timestream Query

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

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

Using the Client

To contact Amazon Timestream Query 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 Query client TimestreamQuery for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/timestreamquery/#New

Index

Constants

View Source 
const (
	// MeasureValueTypeBigint is a MeasureValueType enum value
	MeasureValueTypeBigint = "BIGINT"

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

	// MeasureValueTypeDouble is a MeasureValueType enum value
	MeasureValueTypeDouble = "DOUBLE"

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

	// MeasureValueTypeMulti is a MeasureValueType enum value
	MeasureValueTypeMulti = "MULTI"
)
View Source 
const (
	// QueryPricingModelBytesScanned is a QueryPricingModel enum value
	QueryPricingModelBytesScanned = "BYTES_SCANNED"

	// QueryPricingModelComputeUnits is a QueryPricingModel enum value
	QueryPricingModelComputeUnits = "COMPUTE_UNITS"
)
View Source 
const (
	// S3EncryptionOptionSseS3 is a S3EncryptionOption enum value
	S3EncryptionOptionSseS3 = "SSE_S3"

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

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

	// ScalarMeasureValueTypeDouble is a ScalarMeasureValueType enum value
	ScalarMeasureValueTypeDouble = "DOUBLE"

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

	// ScalarMeasureValueTypeTimestamp is a ScalarMeasureValueType enum value
	ScalarMeasureValueTypeTimestamp = "TIMESTAMP"
)
View Source 
const (
	// ScalarTypeVarchar is a ScalarType enum value
	ScalarTypeVarchar = "VARCHAR"

	// ScalarTypeBoolean is a ScalarType enum value
	ScalarTypeBoolean = "BOOLEAN"

	// ScalarTypeBigint is a ScalarType enum value
	ScalarTypeBigint = "BIGINT"

	// ScalarTypeDouble is a ScalarType enum value
	ScalarTypeDouble = "DOUBLE"

	// ScalarTypeTimestamp is a ScalarType enum value
	ScalarTypeTimestamp = "TIMESTAMP"

	// ScalarTypeDate is a ScalarType enum value
	ScalarTypeDate = "DATE"

	// ScalarTypeTime is a ScalarType enum value
	ScalarTypeTime = "TIME"

	// ScalarTypeIntervalDayToSecond is a ScalarType enum value
	ScalarTypeIntervalDayToSecond = "INTERVAL_DAY_TO_SECOND"

	// ScalarTypeIntervalYearToMonth is a ScalarType enum value
	ScalarTypeIntervalYearToMonth = "INTERVAL_YEAR_TO_MONTH"

	// ScalarTypeUnknown is a ScalarType enum value
	ScalarTypeUnknown = "UNKNOWN"

	// ScalarTypeInteger is a ScalarType enum value
	ScalarTypeInteger = "INTEGER"
)
View Source 
const (
	// ScheduledQueryRunStatusAutoTriggerSuccess is a ScheduledQueryRunStatus enum value
	ScheduledQueryRunStatusAutoTriggerSuccess = "AUTO_TRIGGER_SUCCESS"

	// ScheduledQueryRunStatusAutoTriggerFailure is a ScheduledQueryRunStatus enum value
	ScheduledQueryRunStatusAutoTriggerFailure = "AUTO_TRIGGER_FAILURE"

	// ScheduledQueryRunStatusManualTriggerSuccess is a ScheduledQueryRunStatus enum value
	ScheduledQueryRunStatusManualTriggerSuccess = "MANUAL_TRIGGER_SUCCESS"

	// ScheduledQueryRunStatusManualTriggerFailure is a ScheduledQueryRunStatus enum value
	ScheduledQueryRunStatusManualTriggerFailure = "MANUAL_TRIGGER_FAILURE"
)
View Source 
const (
	// ScheduledQueryStateEnabled is a ScheduledQueryState enum value
	ScheduledQueryStateEnabled = "ENABLED"

	// ScheduledQueryStateDisabled is a ScheduledQueryState enum value
	ScheduledQueryStateDisabled = "DISABLED"
)
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".
	//
	// Unable to poll results for a cancelled query.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The service 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"

	// ErrCodeQueryExecutionException for service response error code
	// "QueryExecutionException".
	//
	// Timestream was unable to run the query successfully.
	ErrCodeQueryExecutionException = "QueryExecutionException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource could not be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// You have exceeded the service quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

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

Service information constants

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

Variables

This section is empty.

Functions

func DimensionValueType_Values added in v1.42.12 

func DimensionValueType_Values() []string

DimensionValueType_Values returns all elements of the DimensionValueType enum

func MeasureValueType_Values added in v1.42.12 

func MeasureValueType_Values() []string

MeasureValueType_Values returns all elements of the MeasureValueType enum

func QueryPricingModel_Values added in v1.51.31 

func QueryPricingModel_Values() []string

QueryPricingModel_Values returns all elements of the QueryPricingModel 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.42.12 

func ScalarMeasureValueType_Values() []string

ScalarMeasureValueType_Values returns all elements of the ScalarMeasureValueType enum

func ScalarType_Values 

func ScalarType_Values() []string

ScalarType_Values returns all elements of the ScalarType enum

func ScheduledQueryRunStatus_Values added in v1.42.12 

func ScheduledQueryRunStatus_Values() []string

ScheduledQueryRunStatus_Values returns all elements of the ScheduledQueryRunStatus enum

func ScheduledQueryState_Values added in v1.42.12 

func ScheduledQueryState_Values() []string

ScheduledQueryState_Values returns all elements of the ScheduledQueryState 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 CancelQueryInput 

type CancelQueryInput struct {

	// The ID of the query that needs to be cancelled. QueryID is returned as part
	// of the query result.
	//
	// QueryId is a required field
	QueryId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelQueryInput) GoString 

func (s CancelQueryInput) 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 (*CancelQueryInput) SetQueryId 

func (s *CancelQueryInput) SetQueryId(v string) *CancelQueryInput

SetQueryId sets the QueryId field's value.

func (CancelQueryInput) String 

func (s CancelQueryInput) 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 (*CancelQueryInput) Validate 

func (s *CancelQueryInput) Validate() error

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

type CancelQueryOutput 

type CancelQueryOutput struct {

	// A CancellationMessage is returned when a CancelQuery request for the query
	// specified by QueryId has already been issued.
	CancellationMessage *string `type:"string"`
	// contains filtered or unexported fields
}

func (CancelQueryOutput) GoString 

func (s CancelQueryOutput) 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 (*CancelQueryOutput) SetCancellationMessage 

func (s *CancelQueryOutput) SetCancellationMessage(v string) *CancelQueryOutput

SetCancellationMessage sets the CancellationMessage field's value.

func (CancelQueryOutput) String 

func (s CancelQueryOutput) 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 ColumnInfo 

type ColumnInfo struct {

	// The name of the result set column. The name of the result set is available
	// for columns of all data types except for arrays.
	Name *string `type:"string"`

	// The data type of the result set column. The data type can be a scalar or
	// complex. Scalar data types are integers, strings, doubles, Booleans, and
	// others. Complex data types are types such as arrays, rows, and others.
	//
	// Type is a required field
	Type *Type `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains the metadata for query results such as the column names, data types, and other attributes.

func (ColumnInfo) GoString 

func (s ColumnInfo) 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 (*ColumnInfo) SetName 

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

SetName sets the Name field's value.

func (*ColumnInfo) SetType 

func (s *ColumnInfo) SetType(v *Type) *ColumnInfo

SetType sets the Type field's value.

func (ColumnInfo) String 

func (s ColumnInfo) 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
}

Unable to poll results for a cancelled query.

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 CreateScheduledQueryInput added in v1.42.12 

type CreateScheduledQueryInput struct {

	// Using a ClientToken makes the call to CreateScheduledQuery idempotent, in
	// other words, making the same request repeatedly will produce the same result.
	// Making multiple identical CreateScheduledQuery requests has the same effect
	// as making a single request.
	//
	//    * If CreateScheduledQuery is called without a ClientToken, the Query SDK
	//    generates a ClientToken on your behalf.
	//
	//    * After 8 hours, any request with the same ClientToken is treated as a
	//    new request.
	//
	// ClientToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateScheduledQueryInput's
	// String and GoString methods.
	ClientToken *string `min:"32" type:"string" idempotencyToken:"true" sensitive:"true"`

	// Configuration for error reporting. Error reports will be generated when a
	// problem is encountered when writing the query results.
	//
	// ErrorReportConfiguration is a required field
	ErrorReportConfiguration *ErrorReportConfiguration `type:"structure" required:"true"`

	// The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
	// If the Amazon KMS key is not specified, the scheduled query resource will
	// be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key,
	// use the key ID, key ARN, alias name, or alias ARN. When using an alias name,
	// prefix the name with alias/
	//
	// If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId
	// is used to encrypt the error report at rest.
	KmsKeyId *string `min:"1" type:"string"`

	// Name of the scheduled query.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Notification configuration for the scheduled query. A notification is sent
	// by Timestream when a query run finishes, when the state is updated or when
	// you delete it.
	//
	// NotificationConfiguration is a required field
	NotificationConfiguration *NotificationConfiguration `type:"structure" required:"true"`

	// The query string to run. Parameter names can be specified in the query string
	// @ character followed by an identifier. The named Parameter @scheduled_runtime
	// is reserved and can be used in the query to get the time at which the query
	// is scheduled to run.
	//
	// The timestamp calculated according to the ScheduleConfiguration parameter,
	// will be the value of @scheduled_runtime paramater for each query run. For
	// example, consider an instance of a scheduled query executing on 2021-12-01
	// 00:00:00. For this instance, the @scheduled_runtime parameter is initialized
	// to the timestamp 2021-12-01 00:00:00 when invoking the query.
	//
	// QueryString is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateScheduledQueryInput's
	// String and GoString methods.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The schedule configuration for the query.
	//
	// ScheduleConfiguration is a required field
	ScheduleConfiguration *ScheduleConfiguration `type:"structure" required:"true"`

	// The ARN for the IAM role that Timestream will assume when running the scheduled
	// query.
	//
	// ScheduledQueryExecutionRoleArn is a required field
	ScheduledQueryExecutionRoleArn *string `min:"1" type:"string" required:"true"`

	// A list of key-value pairs to label the scheduled query.
	Tags []*Tag `type:"list"`

	// Configuration used for writing the result of a query.
	TargetConfiguration *TargetConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateScheduledQueryInput) GoString added in v1.42.12 

func (s CreateScheduledQueryInput) 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 (*CreateScheduledQueryInput) SetClientToken added in v1.42.12 

func (s *CreateScheduledQueryInput) SetClientToken(v string) *CreateScheduledQueryInput

SetClientToken sets the ClientToken field's value.

func (*CreateScheduledQueryInput) SetErrorReportConfiguration added in v1.42.12 

func (s *CreateScheduledQueryInput) SetErrorReportConfiguration(v *ErrorReportConfiguration) *CreateScheduledQueryInput

SetErrorReportConfiguration sets the ErrorReportConfiguration field's value.

func (*CreateScheduledQueryInput) SetKmsKeyId added in v1.42.12 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateScheduledQueryInput) SetName added in v1.42.12 

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

SetName sets the Name field's value.

func (*CreateScheduledQueryInput) SetNotificationConfiguration added in v1.42.12 

func (s *CreateScheduledQueryInput) SetNotificationConfiguration(v *NotificationConfiguration) *CreateScheduledQueryInput

SetNotificationConfiguration sets the NotificationConfiguration field's value.

func (*CreateScheduledQueryInput) SetQueryString added in v1.42.12 

func (s *CreateScheduledQueryInput) SetQueryString(v string) *CreateScheduledQueryInput

SetQueryString sets the QueryString field's value.

func (*CreateScheduledQueryInput) SetScheduleConfiguration added in v1.42.12 

func (s *CreateScheduledQueryInput) SetScheduleConfiguration(v *ScheduleConfiguration) *CreateScheduledQueryInput

SetScheduleConfiguration sets the ScheduleConfiguration field's value.

func (*CreateScheduledQueryInput) SetScheduledQueryExecutionRoleArn added in v1.42.12 

func (s *CreateScheduledQueryInput) SetScheduledQueryExecutionRoleArn(v string) *CreateScheduledQueryInput

SetScheduledQueryExecutionRoleArn sets the ScheduledQueryExecutionRoleArn field's value.

func (*CreateScheduledQueryInput) SetTags added in v1.42.12 

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

SetTags sets the Tags field's value.

func (*CreateScheduledQueryInput) SetTargetConfiguration added in v1.42.12 

func (s *CreateScheduledQueryInput) SetTargetConfiguration(v *TargetConfiguration) *CreateScheduledQueryInput

SetTargetConfiguration sets the TargetConfiguration field's value.

func (CreateScheduledQueryInput) String added in v1.42.12 

func (s CreateScheduledQueryInput) 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 (*CreateScheduledQueryInput) Validate added in v1.42.12 

func (s *CreateScheduledQueryInput) Validate() error

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

type CreateScheduledQueryOutput added in v1.42.12 

type CreateScheduledQueryOutput struct {

	// ARN for the created scheduled query.
	//
	// Arn is a required field
	Arn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateScheduledQueryOutput) GoString added in v1.42.12 

func (s CreateScheduledQueryOutput) 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 (*CreateScheduledQueryOutput) SetArn added in v1.42.12 

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

SetArn sets the Arn field's value.

func (CreateScheduledQueryOutput) String added in v1.42.12 

func (s CreateScheduledQueryOutput) 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 Datum 

type Datum struct {

	// Indicates if the data point is an array.
	ArrayValue []*Datum `type:"list"`

	// Indicates if the data point is null.
	NullValue *bool `type:"boolean"`

	// Indicates if the data point is a row.
	RowValue *Row `type:"structure"`

	// Indicates if the data point is a scalar value such as integer, string, double,
	// or Boolean.
	ScalarValue *string `type:"string"`

	// Indicates if the data point is a timeseries data type.
	TimeSeriesValue []*TimeSeriesDataPoint `type:"list"`
	// contains filtered or unexported fields
}

Datum represents a single data point in a query result.

func (Datum) GoString 

func (s Datum) 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 (*Datum) SetArrayValue 

func (s *Datum) SetArrayValue(v []*Datum) *Datum

SetArrayValue sets the ArrayValue field's value.

func (*Datum) SetNullValue 

func (s *Datum) SetNullValue(v bool) *Datum

SetNullValue sets the NullValue field's value.

func (*Datum) SetRowValue 

func (s *Datum) SetRowValue(v *Row) *Datum

SetRowValue sets the RowValue field's value.

func (*Datum) SetScalarValue 

func (s *Datum) SetScalarValue(v string) *Datum

SetScalarValue sets the ScalarValue field's value.

func (*Datum) SetTimeSeriesValue 

func (s *Datum) SetTimeSeriesValue(v []*TimeSeriesDataPoint) *Datum

SetTimeSeriesValue sets the TimeSeriesValue field's value.

func (Datum) String 

func (s Datum) 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 DeleteScheduledQueryInput added in v1.42.12 

type DeleteScheduledQueryInput struct {

	// The ARN of the scheduled query.
	//
	// ScheduledQueryArn is a required field
	ScheduledQueryArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteScheduledQueryInput) GoString added in v1.42.12 

func (s DeleteScheduledQueryInput) 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 (*DeleteScheduledQueryInput) SetScheduledQueryArn added in v1.42.12 

func (s *DeleteScheduledQueryInput) SetScheduledQueryArn(v string) *DeleteScheduledQueryInput

SetScheduledQueryArn sets the ScheduledQueryArn field's value.

func (DeleteScheduledQueryInput) String added in v1.42.12 

func (s DeleteScheduledQueryInput) 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 (*DeleteScheduledQueryInput) Validate added in v1.42.12 

func (s *DeleteScheduledQueryInput) Validate() error

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

type DeleteScheduledQueryOutput added in v1.42.12 

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

func (DeleteScheduledQueryOutput) GoString added in v1.42.12 

func (s DeleteScheduledQueryOutput) 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 (DeleteScheduledQueryOutput) String added in v1.42.12 

func (s DeleteScheduledQueryOutput) 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 DescribeAccountSettingsInput added in v1.51.31 

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

func (DescribeAccountSettingsInput) GoString added in v1.51.31 

func (s DescribeAccountSettingsInput) 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 (DescribeAccountSettingsInput) String added in v1.51.31 

func (s DescribeAccountSettingsInput) 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 DescribeAccountSettingsOutput added in v1.51.31 

type DescribeAccountSettingsOutput struct {

	// The maximum number of Timestream compute units (https://docs.aws.amazon.com/timestream/latest/developerguide/tcu.html)
	// (TCUs) the service will use at any point in time to serve your queries.
	MaxQueryTCU *int64 `type:"integer"`

	// The pricing model for queries in your account.
	QueryPricingModel *string `type:"string" enum:"QueryPricingModel"`
	// contains filtered or unexported fields
}

func (DescribeAccountSettingsOutput) GoString added in v1.51.31 

func (s DescribeAccountSettingsOutput) 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 (*DescribeAccountSettingsOutput) SetMaxQueryTCU added in v1.51.31 

func (s *DescribeAccountSettingsOutput) SetMaxQueryTCU(v int64) *DescribeAccountSettingsOutput

SetMaxQueryTCU sets the MaxQueryTCU field's value.

func (*DescribeAccountSettingsOutput) SetQueryPricingModel added in v1.51.31 

func (s *DescribeAccountSettingsOutput) SetQueryPricingModel(v string) *DescribeAccountSettingsOutput

SetQueryPricingModel sets the QueryPricingModel field's value.

func (DescribeAccountSettingsOutput) String added in v1.51.31 

func (s DescribeAccountSettingsOutput) 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 

func (s *DescribeEndpointsOutput) SetEndpoints(v []*Endpoint) *DescribeEndpointsOutput

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 DescribeScheduledQueryInput added in v1.42.12 

type DescribeScheduledQueryInput struct {

	// The ARN of the scheduled query.
	//
	// ScheduledQueryArn is a required field
	ScheduledQueryArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeScheduledQueryInput) GoString added in v1.42.12 

func (s DescribeScheduledQueryInput) 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 (*DescribeScheduledQueryInput) SetScheduledQueryArn added in v1.42.12 

func (s *DescribeScheduledQueryInput) SetScheduledQueryArn(v string) *DescribeScheduledQueryInput

SetScheduledQueryArn sets the ScheduledQueryArn field's value.

func (DescribeScheduledQueryInput) String added in v1.42.12 

func (s DescribeScheduledQueryInput) 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 (*DescribeScheduledQueryInput) Validate added in v1.42.12 

func (s *DescribeScheduledQueryInput) Validate() error

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

type DescribeScheduledQueryOutput added in v1.42.12 

type DescribeScheduledQueryOutput struct {

	// The scheduled query.
	//
	// ScheduledQuery is a required field
	ScheduledQuery *ScheduledQueryDescription `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeScheduledQueryOutput) GoString added in v1.42.12 

func (s DescribeScheduledQueryOutput) 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 (*DescribeScheduledQueryOutput) SetScheduledQuery added in v1.42.12 

func (s *DescribeScheduledQueryOutput) SetScheduledQuery(v *ScheduledQueryDescription) *DescribeScheduledQueryOutput

SetScheduledQuery sets the ScheduledQuery field's value.

func (DescribeScheduledQueryOutput) String added in v1.42.12 

func (s DescribeScheduledQueryOutput) 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 DimensionMapping added in v1.42.12 

type DimensionMapping struct {

	// Type for the dimension.
	//
	// DimensionValueType is a required field
	DimensionValueType *string `type:"string" required:"true" enum:"DimensionValueType"`

	// Column name from query result.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

This type is used to map column(s) from the query result to a dimension in the destination table.

func (DimensionMapping) GoString added in v1.42.12 

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) SetDimensionValueType added in v1.42.12 

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

SetDimensionValueType sets the DimensionValueType field's value.

func (*DimensionMapping) SetName added in v1.42.12 

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

SetName sets the Name field's value.

func (DimensionMapping) String added in v1.42.12 

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.42.12 

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 ErrorReportConfiguration added in v1.42.12 

type ErrorReportConfiguration struct {

	// The S3 configuration for the error reports.
	//
	// S3Configuration is a required field
	S3Configuration *S3Configuration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Configuration required for error reporting.

func (ErrorReportConfiguration) GoString added in v1.42.12 

func (s ErrorReportConfiguration) 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 (*ErrorReportConfiguration) SetS3Configuration added in v1.42.12 

func (s *ErrorReportConfiguration) SetS3Configuration(v *S3Configuration) *ErrorReportConfiguration

SetS3Configuration sets the S3Configuration field's value.

func (ErrorReportConfiguration) String added in v1.42.12 

func (s ErrorReportConfiguration) 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 (*ErrorReportConfiguration) Validate added in v1.42.12 

func (s *ErrorReportConfiguration) Validate() error

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

type ErrorReportLocation added in v1.42.12 

type ErrorReportLocation struct {

	// The S3 location where error reports are written.
	S3ReportLocation *S3ReportLocation `type:"structure"`
	// contains filtered or unexported fields
}

This contains the location of the error report for a single scheduled query call.

func (ErrorReportLocation) GoString added in v1.42.12 

func (s ErrorReportLocation) 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 (*ErrorReportLocation) SetS3ReportLocation added in v1.42.12 

func (s *ErrorReportLocation) SetS3ReportLocation(v *S3ReportLocation) *ErrorReportLocation

SetS3ReportLocation sets the S3ReportLocation field's value.

func (ErrorReportLocation) String added in v1.42.12 

func (s ErrorReportLocation) 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 ExecuteScheduledQueryInput added in v1.42.12 

type ExecuteScheduledQueryInput struct {

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

	// The timestamp in UTC. Query will be run as if it was invoked at this timestamp.
	//
	// InvocationTime is a required field
	InvocationTime *time.Time `type:"timestamp" required:"true"`

	// ARN of the scheduled query.
	//
	// ScheduledQueryArn is a required field
	ScheduledQueryArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExecuteScheduledQueryInput) GoString added in v1.42.12 

func (s ExecuteScheduledQueryInput) 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 (*ExecuteScheduledQueryInput) SetClientToken added in v1.42.12 

func (s *ExecuteScheduledQueryInput) SetClientToken(v string) *ExecuteScheduledQueryInput

SetClientToken sets the ClientToken field's value.

func (*ExecuteScheduledQueryInput) SetInvocationTime added in v1.42.12 

func (s *ExecuteScheduledQueryInput) SetInvocationTime(v time.Time) *ExecuteScheduledQueryInput

SetInvocationTime sets the InvocationTime field's value.

func (*ExecuteScheduledQueryInput) SetScheduledQueryArn added in v1.42.12 

func (s *ExecuteScheduledQueryInput) SetScheduledQueryArn(v string) *ExecuteScheduledQueryInput

SetScheduledQueryArn sets the ScheduledQueryArn field's value.

func (ExecuteScheduledQueryInput) String added in v1.42.12 

func (s ExecuteScheduledQueryInput) 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 (*ExecuteScheduledQueryInput) Validate added in v1.42.12 

func (s *ExecuteScheduledQueryInput) Validate() error

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

type ExecuteScheduledQueryOutput added in v1.42.12 

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

func (ExecuteScheduledQueryOutput) GoString added in v1.42.12 

func (s ExecuteScheduledQueryOutput) 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 (ExecuteScheduledQueryOutput) String added in v1.42.12 

func (s ExecuteScheduledQueryOutput) 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 ExecutionStats added in v1.42.12 

type ExecutionStats struct {

	// Bytes metered for a single scheduled query run.
	BytesMetered *int64 `type:"long"`

	// Bytes scanned for a single scheduled query run.
	CumulativeBytesScanned *int64 `type:"long"`

	// Data writes metered for records ingested in a single scheduled query run.
	DataWrites *int64 `type:"long"`

	// Total time, measured in milliseconds, that was needed for the scheduled query
	// run to complete.
	ExecutionTimeInMillis *int64 `type:"long"`

	// Number of rows present in the output from running a query before ingestion
	// to destination data source.
	QueryResultRows *int64 `type:"long"`

	// The number of records ingested for a single scheduled query run.
	RecordsIngested *int64 `type:"long"`
	// contains filtered or unexported fields
}

Statistics for a single scheduled query run.

func (ExecutionStats) GoString added in v1.42.12 

func (s ExecutionStats) 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 (*ExecutionStats) SetBytesMetered added in v1.42.12 

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

SetBytesMetered sets the BytesMetered field's value.

func (*ExecutionStats) SetCumulativeBytesScanned added in v1.51.31 

func (s *ExecutionStats) SetCumulativeBytesScanned(v int64) *ExecutionStats

SetCumulativeBytesScanned sets the CumulativeBytesScanned field's value.

func (*ExecutionStats) SetDataWrites added in v1.42.12 

func (s *ExecutionStats) SetDataWrites(v int64) *ExecutionStats

SetDataWrites sets the DataWrites field's value.

func (*ExecutionStats) SetExecutionTimeInMillis added in v1.42.12 

func (s *ExecutionStats) SetExecutionTimeInMillis(v int64) *ExecutionStats

SetExecutionTimeInMillis sets the ExecutionTimeInMillis field's value.

func (*ExecutionStats) SetQueryResultRows added in v1.42.12 

func (s *ExecutionStats) SetQueryResultRows(v int64) *ExecutionStats

SetQueryResultRows sets the QueryResultRows field's value.

func (*ExecutionStats) SetRecordsIngested added in v1.42.12 

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

SetRecordsIngested sets the RecordsIngested field's value.

func (ExecutionStats) String added in v1.42.12 

func (s ExecutionStats) 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
}

The service 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 ListScheduledQueriesInput added in v1.42.12 

type ListScheduledQueriesInput struct {

	// The maximum 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 the argument
	// to the subsequent call to ListScheduledQueriesRequest.
	MaxResults *int64 `min:"1" type:"integer"`

	// A pagination token to resume pagination.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListScheduledQueriesInput) GoString added in v1.42.12 

func (s ListScheduledQueriesInput) 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 (*ListScheduledQueriesInput) SetMaxResults added in v1.42.12 

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

SetMaxResults sets the MaxResults field's value.

func (*ListScheduledQueriesInput) SetNextToken added in v1.42.12 

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

SetNextToken sets the NextToken field's value.

func (ListScheduledQueriesInput) String added in v1.42.12 

func (s ListScheduledQueriesInput) 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 (*ListScheduledQueriesInput) Validate added in v1.42.12 

func (s *ListScheduledQueriesInput) Validate() error

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

type ListScheduledQueriesOutput added in v1.42.12 

type ListScheduledQueriesOutput 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 scheduled queries.
	//
	// ScheduledQueries is a required field
	ScheduledQueries []*ScheduledQuery `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListScheduledQueriesOutput) GoString added in v1.42.12 

func (s ListScheduledQueriesOutput) 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 (*ListScheduledQueriesOutput) SetNextToken added in v1.42.12 

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

SetNextToken sets the NextToken field's value.

func (*ListScheduledQueriesOutput) SetScheduledQueries added in v1.42.12 

func (s *ListScheduledQueriesOutput) SetScheduledQueries(v []*ScheduledQuery) *ListScheduledQueriesOutput

SetScheduledQueries sets the ScheduledQueries field's value.

func (ListScheduledQueriesOutput) String added in v1.42.12 

func (s ListScheduledQueriesOutput) 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 added in v1.42.12 

type ListTagsForResourceInput struct {

	// The maximum number of tags to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// A pagination token to resume pagination.
	NextToken *string `type:"string"`

	// 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 added in v1.42.12 

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) SetMaxResults added in v1.42.12 

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

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken added in v1.42.12 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceARN added in v1.42.12 

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

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.42.12 

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 added in v1.42.12 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.42.12 

type ListTagsForResourceOutput struct {

	// A pagination token to resume pagination with a subsequent call to ListTagsForResourceResponse.
	NextToken *string `type:"string"`

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

func (ListTagsForResourceOutput) GoString added in v1.42.12 

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) SetNextToken added in v1.42.12 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.42.12 

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.42.12 

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 MixedMeasureMapping added in v1.42.12 

type MixedMeasureMapping struct {

	// Refers to the value of measure_name in a result row. This field is required
	// if MeasureNameColumn is provided.
	MeasureName *string `type:"string"`

	// Type of the value that is to be read from sourceColumn. If the mapping is
	// for MULTI, use MeasureValueType.MULTI.
	//
	// MeasureValueType is a required field
	MeasureValueType *string `type:"string" required:"true" enum:"MeasureValueType"`

	// Required when measureValueType is MULTI. Attribute mappings for MULTI value
	// measures.
	MultiMeasureAttributeMappings []*MultiMeasureAttributeMapping `min:"1" type:"list"`

	// This field refers to the source column from which measure-value is to be
	// read for result materialization.
	SourceColumn *string `type:"string"`

	// Target measure name to be used. If not provided, the target measure name
	// by default would be measure-name if provided, or sourceColumn otherwise.
	TargetMeasureName *string `type:"string"`
	// contains filtered or unexported fields
}

MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.

func (MixedMeasureMapping) GoString added in v1.42.12 

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.42.12 

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

SetMeasureName sets the MeasureName field's value.

func (*MixedMeasureMapping) SetMeasureValueType added in v1.42.12 

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

SetMeasureValueType sets the MeasureValueType field's value.

func (*MixedMeasureMapping) SetMultiMeasureAttributeMappings added in v1.42.12 

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

SetMultiMeasureAttributeMappings sets the MultiMeasureAttributeMappings field's value.

func (*MixedMeasureMapping) SetSourceColumn added in v1.42.12 

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

SetSourceColumn sets the SourceColumn field's value.

func (*MixedMeasureMapping) SetTargetMeasureName added in v1.42.12 

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

SetTargetMeasureName sets the TargetMeasureName field's value.

func (MixedMeasureMapping) String added in v1.42.12 

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.42.12 

func (s *MixedMeasureMapping) Validate() error

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

type MultiMeasureAttributeMapping added in v1.42.12 

type MultiMeasureAttributeMapping struct {

	// Type of the attribute to be read from the source column.
	//
	// MeasureValueType is a required field
	MeasureValueType *string `type:"string" required:"true" enum:"ScalarMeasureValueType"`

	// Source column from where the attribute value is to be read.
	//
	// SourceColumn is a required field
	SourceColumn *string `type:"string" required:"true"`

	// Custom name to be used for attribute name in derived table. If not provided,
	// source column name would be used.
	TargetMultiMeasureAttributeName *string `type:"string"`
	// contains filtered or unexported fields
}

Attribute mapping for MULTI value measures.

func (MultiMeasureAttributeMapping) GoString added in v1.42.12 

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.42.12 

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

SetMeasureValueType sets the MeasureValueType field's value.

func (*MultiMeasureAttributeMapping) SetSourceColumn added in v1.42.12 

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

SetSourceColumn sets the SourceColumn field's value.

func (*MultiMeasureAttributeMapping) SetTargetMultiMeasureAttributeName added in v1.42.12 

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

SetTargetMultiMeasureAttributeName sets the TargetMultiMeasureAttributeName field's value.

func (MultiMeasureAttributeMapping) String added in v1.42.12 

func (s MultiMeasureAttributeMapping) 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 (*MultiMeasureAttributeMapping) Validate added in v1.42.12 

func (s *MultiMeasureAttributeMapping) Validate() error

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

type MultiMeasureMappings added in v1.42.12 

type MultiMeasureMappings struct {

	// Required. Attribute mappings to be used for mapping query results to ingest
	// data for multi-measure attributes.
	//
	// MultiMeasureAttributeMappings is a required field
	MultiMeasureAttributeMappings []*MultiMeasureAttributeMapping `min:"1" type:"list" required:"true"`

	// The name of the target multi-measure name in the derived table. This input
	// is required when measureNameColumn is not provided. If MeasureNameColumn
	// is provided, then value from that column will be used as multi-measure name.
	TargetMultiMeasureName *string `type:"string"`
	// contains filtered or unexported fields
}

Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided. MultiMeasureMappings can be used to ingest data as multi measures in the derived table.

func (MultiMeasureMappings) GoString added in v1.42.12 

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.42.12 

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

SetMultiMeasureAttributeMappings sets the MultiMeasureAttributeMappings field's value.

func (*MultiMeasureMappings) SetTargetMultiMeasureName added in v1.42.12 

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

SetTargetMultiMeasureName sets the TargetMultiMeasureName field's value.

func (MultiMeasureMappings) String added in v1.42.12 

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.42.12 

func (s *MultiMeasureMappings) Validate() error

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

type NotificationConfiguration added in v1.42.12 

type NotificationConfiguration struct {

	// Details on SNS configuration.
	//
	// SnsConfiguration is a required field
	SnsConfiguration *SnsConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Notification configuration for a scheduled query. A notification is sent by Timestream when a scheduled query is created, its state is updated or when it is deleted.

func (NotificationConfiguration) GoString added in v1.42.12 

func (s NotificationConfiguration) 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 (*NotificationConfiguration) SetSnsConfiguration added in v1.42.12 

func (s *NotificationConfiguration) SetSnsConfiguration(v *SnsConfiguration) *NotificationConfiguration

SetSnsConfiguration sets the SnsConfiguration field's value.

func (NotificationConfiguration) String added in v1.42.12 

func (s NotificationConfiguration) 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 (*NotificationConfiguration) Validate added in v1.42.12 

func (s *NotificationConfiguration) Validate() error

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

type ParameterMapping added in v1.42.12 

type ParameterMapping struct {

	// Parameter name.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// Contains the data type of a column in a query result set. The data type can
	// be scalar or complex. The supported scalar data types are integers, Boolean,
	// string, double, timestamp, date, time, and intervals. The supported complex
	// data types are arrays, rows, and timeseries.
	//
	// Type is a required field
	Type *Type `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Mapping for named parameters.

func (ParameterMapping) GoString added in v1.42.12 

func (s ParameterMapping) 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 (*ParameterMapping) SetName added in v1.42.12 

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

SetName sets the Name field's value.

func (*ParameterMapping) SetType added in v1.42.12 

func (s *ParameterMapping) SetType(v *Type) *ParameterMapping

SetType sets the Type field's value.

func (ParameterMapping) String added in v1.42.12 

func (s ParameterMapping) 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 PrepareQueryInput added in v1.42.12 

type PrepareQueryInput struct {

	// The Timestream query string that you want to use as a prepared statement.
	// Parameter names can be specified in the query string @ character followed
	// by an identifier.
	//
	// QueryString is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PrepareQueryInput's
	// String and GoString methods.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// By setting this value to true, Timestream will only validate that the query
	// string is a valid Timestream query, and not store the prepared query for
	// later use.
	ValidateOnly *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (PrepareQueryInput) GoString added in v1.42.12 

func (s PrepareQueryInput) 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 (*PrepareQueryInput) SetQueryString added in v1.42.12 

func (s *PrepareQueryInput) SetQueryString(v string) *PrepareQueryInput

SetQueryString sets the QueryString field's value.

func (*PrepareQueryInput) SetValidateOnly added in v1.42.12 

func (s *PrepareQueryInput) SetValidateOnly(v bool) *PrepareQueryInput

SetValidateOnly sets the ValidateOnly field's value.

func (PrepareQueryInput) String added in v1.42.12 

func (s PrepareQueryInput) 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 (*PrepareQueryInput) Validate added in v1.42.12 

func (s *PrepareQueryInput) Validate() error

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

type PrepareQueryOutput added in v1.42.12 

type PrepareQueryOutput struct {

	// A list of SELECT clause columns of the submitted query string.
	//
	// Columns is a required field
	Columns []*SelectColumn `type:"list" required:"true"`

	// A list of parameters used in the submitted query string.
	//
	// Parameters is a required field
	Parameters []*ParameterMapping `type:"list" required:"true"`

	// The query string that you want prepare.
	//
	// QueryString is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PrepareQueryOutput's
	// String and GoString methods.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (PrepareQueryOutput) GoString added in v1.42.12 

func (s PrepareQueryOutput) 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 (*PrepareQueryOutput) SetColumns added in v1.42.12 

func (s *PrepareQueryOutput) SetColumns(v []*SelectColumn) *PrepareQueryOutput

SetColumns sets the Columns field's value.

func (*PrepareQueryOutput) SetParameters added in v1.42.12 

func (s *PrepareQueryOutput) SetParameters(v []*ParameterMapping) *PrepareQueryOutput

SetParameters sets the Parameters field's value.

func (*PrepareQueryOutput) SetQueryString added in v1.42.12 

func (s *PrepareQueryOutput) SetQueryString(v string) *PrepareQueryOutput

SetQueryString sets the QueryString field's value.

func (PrepareQueryOutput) String added in v1.42.12 

func (s PrepareQueryOutput) 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 QueryExecutionException 

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

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

Timestream was unable to run the query successfully.

func (*QueryExecutionException) Code 

func (s *QueryExecutionException) Code() string

Code returns the exception type name.

func (*QueryExecutionException) Error 

func (s *QueryExecutionException) Error() string

func (QueryExecutionException) GoString 

func (s QueryExecutionException) 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 (*QueryExecutionException) Message 

func (s *QueryExecutionException) Message() string

Message returns the exception's message.

func (*QueryExecutionException) OrigErr 

func (s *QueryExecutionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*QueryExecutionException) RequestID 

func (s *QueryExecutionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*QueryExecutionException) StatusCode 

func (s *QueryExecutionException) StatusCode() int

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

func (QueryExecutionException) String 

func (s QueryExecutionException) 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 QueryInput 

type QueryInput struct {

	// Unique, case-sensitive string of up to 64 ASCII characters specified when
	// a Query request is made. Providing a ClientToken makes the call to Query
	// idempotent. This means that running the same query repeatedly will produce
	// the same result. In other words, making multiple identical Query requests
	// has the same effect as making a single request. When using ClientToken in
	// a query, note the following:
	//
	//    * If the Query API is instantiated without a ClientToken, the Query SDK
	//    generates a ClientToken on your behalf.
	//
	//    * If the Query invocation only contains the ClientToken but does not include
	//    a NextToken, that invocation of Query is assumed to be a new query run.
	//
	//    * If the invocation contains NextToken, that particular invocation is
	//    assumed to be a subsequent invocation of a prior call to the Query API,
	//    and a result set is returned.
	//
	//    * After 4 hours, any request with the same ClientToken is treated as a
	//    new request.
	//
	// ClientToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by QueryInput's
	// String and GoString methods.
	ClientToken *string `min:"32" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The total number of rows to be returned in the Query output. The initial
	// run of Query with a MaxRows value specified will return the result set of
	// the query in two cases:
	//
	//    * The size of the result is less than 1MB.
	//
	//    * The number of rows in the result set is less than the value of maxRows.
	//
	// Otherwise, the initial invocation of Query only returns a NextToken, which
	// can then be used in subsequent calls to fetch the result set. To resume pagination,
	// provide the NextToken value in the subsequent command.
	//
	// If the row size is large (e.g. a row has many columns), Timestream may return
	// fewer rows to keep the response size from exceeding the 1 MB limit. If MaxRows
	// is not provided, Timestream will send the necessary number of rows to meet
	// the 1 MB limit.
	MaxRows *int64 `min:"1" type:"integer"`

	// A pagination token used to return a set of results. When the Query API is
	// invoked using NextToken, that particular invocation is assumed to be a subsequent
	// invocation of a prior call to Query, and a result set is returned. However,
	// if the Query invocation only contains the ClientToken, that invocation of
	// Query is assumed to be a new query run.
	//
	// Note the following when using NextToken in a query:
	//
	//    * A pagination token can be used for up to five Query invocations, OR
	//    for a duration of up to 1 hour – whichever comes first.
	//
	//    * Using the same NextToken will return the same set of records. To keep
	//    paginating through the result set, you must to use the most recent nextToken.
	//
	//    * Suppose a Query invocation returns two NextToken values, TokenA and
	//    TokenB. If TokenB is used in a subsequent Query invocation, then TokenA
	//    is invalidated and cannot be reused.
	//
	//    * To request a previous result set from a query after pagination has begun,
	//    you must re-invoke the Query API.
	//
	//    * The latest NextToken should be used to paginate until null is returned,
	//    at which point a new NextToken should be used.
	//
	//    * If the IAM principal of the query initiator and the result reader are
	//    not the same and/or the query initiator and the result reader do not have
	//    the same query string in the query requests, the query will fail with
	//    an Invalid pagination token error.
	NextToken *string `min:"1" type:"string"`

	// The query to be run by Timestream.
	//
	// QueryString is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by QueryInput's
	// String and GoString methods.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (QueryInput) GoString 

func (s QueryInput) 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 (*QueryInput) SetClientToken 

func (s *QueryInput) SetClientToken(v string) *QueryInput

SetClientToken sets the ClientToken field's value.

func (*QueryInput) SetMaxRows 

func (s *QueryInput) SetMaxRows(v int64) *QueryInput

SetMaxRows sets the MaxRows field's value.

func (*QueryInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*QueryInput) SetQueryString 

func (s *QueryInput) SetQueryString(v string) *QueryInput

SetQueryString sets the QueryString field's value.

func (QueryInput) String 

func (s QueryInput) 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 (*QueryInput) Validate 

func (s *QueryInput) Validate() error

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

type QueryOutput 

type QueryOutput struct {

	// The column data types of the returned result set.
	//
	// ColumnInfo is a required field
	ColumnInfo []*ColumnInfo `type:"list" required:"true"`

	// A pagination token that can be used again on a Query call to get the next
	// set of results.
	NextToken *string `min:"1" type:"string"`

	// A unique ID for the given query.
	//
	// QueryId is a required field
	QueryId *string `min:"1" type:"string" required:"true"`

	// Information about the status of the query, including progress and bytes scanned.
	QueryStatus *QueryStatus `type:"structure"`

	// The result set rows returned by the query.
	//
	// Rows is a required field
	Rows []*Row `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (QueryOutput) GoString 

func (s QueryOutput) 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 (*QueryOutput) SetColumnInfo 

func (s *QueryOutput) SetColumnInfo(v []*ColumnInfo) *QueryOutput

SetColumnInfo sets the ColumnInfo field's value.

func (*QueryOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*QueryOutput) SetQueryId 

func (s *QueryOutput) SetQueryId(v string) *QueryOutput

SetQueryId sets the QueryId field's value.

func (*QueryOutput) SetQueryStatus added in v1.35.34 

func (s *QueryOutput) SetQueryStatus(v *QueryStatus) *QueryOutput

SetQueryStatus sets the QueryStatus field's value.

func (*QueryOutput) SetRows 

func (s *QueryOutput) SetRows(v []*Row) *QueryOutput

SetRows sets the Rows field's value.

func (QueryOutput) String 

func (s QueryOutput) 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 QueryStatus added in v1.35.34 

type QueryStatus struct {

	// The amount of data scanned by the query in bytes that you will be charged
	// for. This is a cumulative sum and represents the total amount of data that
	// you will be charged for since the query was started. The charge is applied
	// only once and is either applied when the query completes running or when
	// the query is cancelled.
	CumulativeBytesMetered *int64 `type:"long"`

	// The amount of data scanned by the query in bytes. This is a cumulative sum
	// and represents the total amount of bytes scanned since the query was started.
	CumulativeBytesScanned *int64 `type:"long"`

	// The progress of the query, expressed as a percentage.
	ProgressPercentage *float64 `type:"double"`
	// contains filtered or unexported fields
}

Information about the status of the query, including progress and bytes scanned.

func (QueryStatus) GoString added in v1.35.34 

func (s QueryStatus) 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 (*QueryStatus) SetCumulativeBytesMetered added in v1.35.34 

func (s *QueryStatus) SetCumulativeBytesMetered(v int64) *QueryStatus

SetCumulativeBytesMetered sets the CumulativeBytesMetered field's value.

func (*QueryStatus) SetCumulativeBytesScanned added in v1.35.34 

func (s *QueryStatus) SetCumulativeBytesScanned(v int64) *QueryStatus

SetCumulativeBytesScanned sets the CumulativeBytesScanned field's value.

func (*QueryStatus) SetProgressPercentage added in v1.35.34 

func (s *QueryStatus) SetProgressPercentage(v float64) *QueryStatus

SetProgressPercentage sets the ProgressPercentage field's value.

func (QueryStatus) String added in v1.35.34 

func (s QueryStatus) 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 ResourceNotFoundException added in v1.42.12 

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

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

	// The ARN of the scheduled query.
	ScheduledQueryArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The requested resource could not be found.

func (*ResourceNotFoundException) Code added in v1.42.12 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.42.12 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.42.12 

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 added in v1.42.12 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.42.12 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.42.12 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.42.12 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String added in v1.42.12 

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 Row 

type Row struct {

	// List of data points in a single row of the result set.
	//
	// Data is a required field
	Data []*Datum `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents a single row in the query results.

func (Row) GoString 

func (s Row) 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 (*Row) SetData 

func (s *Row) SetData(v []*Datum) *Row

SetData sets the Data field's value.

func (Row) String 

func (s Row) 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 S3Configuration added in v1.42.12 

type S3Configuration struct {

	// Name of the S3 bucket under which error reports will be created.
	//
	// BucketName is a required field
	BucketName *string `min:"3" type:"string" required:"true"`

	// Encryption at rest options for the error reports. If no encryption option
	// is specified, Timestream will choose SSE_S3 as default.
	EncryptionOption *string `type:"string" enum:"S3EncryptionOption"`

	// Prefix for the error report key. Timestream by default adds the following
	// prefix to the error report path.
	ObjectKeyPrefix *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Details on S3 location for error reports that result from running a query.

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) 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 S3ReportLocation added in v1.42.12 

type S3ReportLocation struct {

	// S3 bucket name.
	BucketName *string `min:"3" type:"string"`

	// S3 key.
	ObjectKey *string `type:"string"`
	// contains filtered or unexported fields
}

S3 report location for the scheduled query run.

func (S3ReportLocation) GoString added in v1.42.12 

func (s S3ReportLocation) 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 (*S3ReportLocation) SetBucketName added in v1.42.12 

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

SetBucketName sets the BucketName field's value.

func (*S3ReportLocation) SetObjectKey added in v1.42.12 

func (s *S3ReportLocation) SetObjectKey(v string) *S3ReportLocation

SetObjectKey sets the ObjectKey field's value.

func (S3ReportLocation) String added in v1.42.12 

func (s S3ReportLocation) 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 ScheduleConfiguration added in v1.42.12 

type ScheduleConfiguration struct {

	// An expression that denotes when to trigger the scheduled query run. This
	// can be a cron expression or a rate expression.
	//
	// ScheduleExpression is a required field
	ScheduleExpression *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration of the schedule of the query.

func (ScheduleConfiguration) GoString added in v1.42.12 

func (s ScheduleConfiguration) 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 (*ScheduleConfiguration) SetScheduleExpression added in v1.42.12 

func (s *ScheduleConfiguration) SetScheduleExpression(v string) *ScheduleConfiguration

SetScheduleExpression sets the ScheduleExpression field's value.

func (ScheduleConfiguration) String added in v1.42.12 

func (s ScheduleConfiguration) 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 (*ScheduleConfiguration) Validate added in v1.42.12 

func (s *ScheduleConfiguration) Validate() error

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

type ScheduledQuery added in v1.42.12 

type ScheduledQuery struct {

	// The Amazon Resource Name.
	//
	// Arn is a required field
	Arn *string `min:"1" type:"string" required:"true"`

	// The creation time of the scheduled query.
	CreationTime *time.Time `type:"timestamp"`

	// Configuration for scheduled query error reporting.
	ErrorReportConfiguration *ErrorReportConfiguration `type:"structure"`

	// Status of the last scheduled query run.
	LastRunStatus *string `type:"string" enum:"ScheduledQueryRunStatus"`

	// The name of the scheduled query.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The next time the scheduled query is to be run.
	NextInvocationTime *time.Time `type:"timestamp"`

	// The last time the scheduled query was run.
	PreviousInvocationTime *time.Time `type:"timestamp"`

	// State of scheduled query.
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"ScheduledQueryState"`

	// Target data source where final scheduled query result will be written.
	TargetDestination *TargetDestination `type:"structure"`
	// contains filtered or unexported fields
}

Scheduled Query

func (ScheduledQuery) GoString added in v1.42.12 

func (s ScheduledQuery) 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 (*ScheduledQuery) SetArn added in v1.42.12 

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

SetArn sets the Arn field's value.

func (*ScheduledQuery) SetCreationTime added in v1.42.12 

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

SetCreationTime sets the CreationTime field's value.

func (*ScheduledQuery) SetErrorReportConfiguration added in v1.42.12 

func (s *ScheduledQuery) SetErrorReportConfiguration(v *ErrorReportConfiguration) *ScheduledQuery

SetErrorReportConfiguration sets the ErrorReportConfiguration field's value.

func (*ScheduledQuery) SetLastRunStatus added in v1.42.12 

func (s *ScheduledQuery) SetLastRunStatus(v string) *ScheduledQuery

SetLastRunStatus sets the LastRunStatus field's value.

func (*ScheduledQuery) SetName added in v1.42.12 

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

SetName sets the Name field's value.

func (*ScheduledQuery) SetNextInvocationTime added in v1.42.12 

func (s *ScheduledQuery) SetNextInvocationTime(v time.Time) *ScheduledQuery

SetNextInvocationTime sets the NextInvocationTime field's value.

func (*ScheduledQuery) SetPreviousInvocationTime added in v1.42.12 

func (s *ScheduledQuery) SetPreviousInvocationTime(v time.Time) *ScheduledQuery

SetPreviousInvocationTime sets the PreviousInvocationTime field's value.

func (*ScheduledQuery) SetState added in v1.42.12 

func (s *ScheduledQuery) SetState(v string) *ScheduledQuery

SetState sets the State field's value.

func (*ScheduledQuery) SetTargetDestination added in v1.42.12 

func (s *ScheduledQuery) SetTargetDestination(v *TargetDestination) *ScheduledQuery

SetTargetDestination sets the TargetDestination field's value.

func (ScheduledQuery) String added in v1.42.12 

func (s ScheduledQuery) 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 ScheduledQueryDescription added in v1.42.12 

type ScheduledQueryDescription struct {

	// Scheduled query ARN.
	//
	// Arn is a required field
	Arn *string `min:"1" type:"string" required:"true"`

	// Creation time of the scheduled query.
	CreationTime *time.Time `type:"timestamp"`

	// Error-reporting configuration for the scheduled query.
	ErrorReportConfiguration *ErrorReportConfiguration `type:"structure"`

	// A customer provided KMS key used to encrypt the scheduled query resource.
	KmsKeyId *string `min:"1" type:"string"`

	// Runtime summary for the last scheduled query run.
	LastRunSummary *ScheduledQueryRunSummary `type:"structure"`

	// Name of the scheduled query.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The next time the scheduled query is scheduled to run.
	NextInvocationTime *time.Time `type:"timestamp"`

	// Notification configuration.
	//
	// NotificationConfiguration is a required field
	NotificationConfiguration *NotificationConfiguration `type:"structure" required:"true"`

	// Last time the query was run.
	PreviousInvocationTime *time.Time `type:"timestamp"`

	// The query to be run.
	//
	// QueryString is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ScheduledQueryDescription's
	// String and GoString methods.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// Runtime summary for the last five failed scheduled query runs.
	RecentlyFailedRuns []*ScheduledQueryRunSummary `type:"list"`

	// Schedule configuration.
	//
	// ScheduleConfiguration is a required field
	ScheduleConfiguration *ScheduleConfiguration `type:"structure" required:"true"`

	// IAM role that Timestream uses to run the schedule query.
	ScheduledQueryExecutionRoleArn *string `min:"1" type:"string"`

	// State of the scheduled query.
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"ScheduledQueryState"`

	// Scheduled query target store configuration.
	TargetConfiguration *TargetConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Structure that describes scheduled query.

func (ScheduledQueryDescription) GoString added in v1.42.12 

func (s ScheduledQueryDescription) 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 (*ScheduledQueryDescription) SetArn added in v1.42.12 

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

SetArn sets the Arn field's value.

func (*ScheduledQueryDescription) SetCreationTime added in v1.42.12 

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

SetCreationTime sets the CreationTime field's value.

func (*ScheduledQueryDescription) SetErrorReportConfiguration added in v1.42.12 

func (s *ScheduledQueryDescription) SetErrorReportConfiguration(v *ErrorReportConfiguration) *ScheduledQueryDescription

SetErrorReportConfiguration sets the ErrorReportConfiguration field's value.

func (*ScheduledQueryDescription) SetKmsKeyId added in v1.42.12 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*ScheduledQueryDescription) SetLastRunSummary added in v1.42.12 

func (s *ScheduledQueryDescription) SetLastRunSummary(v *ScheduledQueryRunSummary) *ScheduledQueryDescription

SetLastRunSummary sets the LastRunSummary field's value.

func (*ScheduledQueryDescription) SetName added in v1.42.12 

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

SetName sets the Name field's value.

func (*ScheduledQueryDescription) SetNextInvocationTime added in v1.42.12 

func (s *ScheduledQueryDescription) SetNextInvocationTime(v time.Time) *ScheduledQueryDescription

SetNextInvocationTime sets the NextInvocationTime field's value.

func (*ScheduledQueryDescription) SetNotificationConfiguration added in v1.42.12 

func (s *ScheduledQueryDescription) SetNotificationConfiguration(v *NotificationConfiguration) *ScheduledQueryDescription

SetNotificationConfiguration sets the NotificationConfiguration field's value.

func (*ScheduledQueryDescription) SetPreviousInvocationTime added in v1.42.12 

func (s *ScheduledQueryDescription) SetPreviousInvocationTime(v time.Time) *ScheduledQueryDescription

SetPreviousInvocationTime sets the PreviousInvocationTime field's value.

func (*ScheduledQueryDescription) SetQueryString added in v1.42.12 

func (s *ScheduledQueryDescription) SetQueryString(v string) *ScheduledQueryDescription

SetQueryString sets the QueryString field's value.

func (*ScheduledQueryDescription) SetRecentlyFailedRuns added in v1.42.12 

func (s *ScheduledQueryDescription) SetRecentlyFailedRuns(v []*ScheduledQueryRunSummary) *ScheduledQueryDescription

SetRecentlyFailedRuns sets the RecentlyFailedRuns field's value.

func (*ScheduledQueryDescription) SetScheduleConfiguration added in v1.42.12 

func (s *ScheduledQueryDescription) SetScheduleConfiguration(v *ScheduleConfiguration) *ScheduledQueryDescription

SetScheduleConfiguration sets the ScheduleConfiguration field's value.

func (*ScheduledQueryDescription) SetScheduledQueryExecutionRoleArn added in v1.42.12 

func (s *ScheduledQueryDescription) SetScheduledQueryExecutionRoleArn(v string) *ScheduledQueryDescription

SetScheduledQueryExecutionRoleArn sets the ScheduledQueryExecutionRoleArn field's value.

func (*ScheduledQueryDescription) SetState added in v1.42.12 

func (s *ScheduledQueryDescription) SetState(v string) *ScheduledQueryDescription

SetState sets the State field's value.

func (*ScheduledQueryDescription) SetTargetConfiguration added in v1.42.12 

func (s *ScheduledQueryDescription) SetTargetConfiguration(v *TargetConfiguration) *ScheduledQueryDescription

SetTargetConfiguration sets the TargetConfiguration field's value.

func (ScheduledQueryDescription) String added in v1.42.12 

func (s ScheduledQueryDescription) 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 ScheduledQueryRunSummary added in v1.42.12 

type ScheduledQueryRunSummary struct {

	// S3 location for error report.
	ErrorReportLocation *ErrorReportLocation `type:"structure"`

	// Runtime statistics for a scheduled run.
	ExecutionStats *ExecutionStats `type:"structure"`

	// Error message for the scheduled query in case of failure. You might have
	// to look at the error report to get more detailed error reasons.
	FailureReason *string `type:"string"`

	// InvocationTime for this run. This is the time at which the query is scheduled
	// to run. Parameter @scheduled_runtime can be used in the query to get the
	// value.
	InvocationTime *time.Time `type:"timestamp"`

	// The status of a scheduled query run.
	RunStatus *string `type:"string" enum:"ScheduledQueryRunStatus"`

	// The actual time when the query was run.
	TriggerTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Run summary for the scheduled query

func (ScheduledQueryRunSummary) GoString added in v1.42.12 

func (s ScheduledQueryRunSummary) 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 (*ScheduledQueryRunSummary) SetErrorReportLocation added in v1.42.12 

func (s *ScheduledQueryRunSummary) SetErrorReportLocation(v *ErrorReportLocation) *ScheduledQueryRunSummary

SetErrorReportLocation sets the ErrorReportLocation field's value.

func (*ScheduledQueryRunSummary) SetExecutionStats added in v1.42.12 

func (s *ScheduledQueryRunSummary) SetExecutionStats(v *ExecutionStats) *ScheduledQueryRunSummary

SetExecutionStats sets the ExecutionStats field's value.

func (*ScheduledQueryRunSummary) SetFailureReason added in v1.42.12 

func (s *ScheduledQueryRunSummary) SetFailureReason(v string) *ScheduledQueryRunSummary

SetFailureReason sets the FailureReason field's value.

func (*ScheduledQueryRunSummary) SetInvocationTime added in v1.42.12 

func (s *ScheduledQueryRunSummary) SetInvocationTime(v time.Time) *ScheduledQueryRunSummary

SetInvocationTime sets the InvocationTime field's value.

func (*ScheduledQueryRunSummary) SetRunStatus added in v1.42.12 

func (s *ScheduledQueryRunSummary) SetRunStatus(v string) *ScheduledQueryRunSummary

SetRunStatus sets the RunStatus field's value.

func (*ScheduledQueryRunSummary) SetTriggerTime added in v1.42.12 

func (s *ScheduledQueryRunSummary) SetTriggerTime(v time.Time) *ScheduledQueryRunSummary

SetTriggerTime sets the TriggerTime field's value.

func (ScheduledQueryRunSummary) String added in v1.42.12 

func (s ScheduledQueryRunSummary) 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 SelectColumn added in v1.42.12 

type SelectColumn struct {

	// True, if the column name was aliased by the query. False otherwise.
	Aliased *bool `type:"boolean"`

	// Database that has this column.
	DatabaseName *string `type:"string"`

	// Name of the column.
	Name *string `type:"string"`

	// Table within the database that has this column.
	TableName *string `type:"string"`

	// Contains the data type of a column in a query result set. The data type can
	// be scalar or complex. The supported scalar data types are integers, Boolean,
	// string, double, timestamp, date, time, and intervals. The supported complex
	// data types are arrays, rows, and timeseries.
	Type *Type `type:"structure"`
	// contains filtered or unexported fields
}

Details of the column that is returned by the query.

func (SelectColumn) GoString added in v1.42.12 

func (s SelectColumn) 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 (*SelectColumn) SetAliased added in v1.42.12 

func (s *SelectColumn) SetAliased(v bool) *SelectColumn

SetAliased sets the Aliased field's value.

func (*SelectColumn) SetDatabaseName added in v1.42.12 

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

SetDatabaseName sets the DatabaseName field's value.

func (*SelectColumn) SetName added in v1.42.12 

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

SetName sets the Name field's value.

func (*SelectColumn) SetTableName added in v1.42.12 

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

SetTableName sets the TableName field's value.

func (*SelectColumn) SetType added in v1.42.12 

func (s *SelectColumn) SetType(v *Type) *SelectColumn

SetType sets the Type field's value.

func (SelectColumn) String added in v1.42.12 

func (s SelectColumn) 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 ServiceQuotaExceededException added in v1.42.12 

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

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

You have exceeded the service quota.

func (*ServiceQuotaExceededException) Code added in v1.42.12 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error added in v1.42.12 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString added in v1.42.12 

func (s ServiceQuotaExceededException) 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 (*ServiceQuotaExceededException) Message added in v1.42.12 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr added in v1.42.12 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID added in v1.42.12 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode added in v1.42.12 

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String added in v1.42.12 

func (s ServiceQuotaExceededException) 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 SnsConfiguration added in v1.42.12 

type SnsConfiguration struct {

	// SNS topic ARN that the scheduled query status notifications will be sent
	// to.
	//
	// TopicArn is a required field
	TopicArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Details on SNS that are required to send the notification.

func (SnsConfiguration) GoString added in v1.42.12 

func (s SnsConfiguration) 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 (*SnsConfiguration) SetTopicArn added in v1.42.12 

func (s *SnsConfiguration) SetTopicArn(v string) *SnsConfiguration

SetTopicArn sets the TopicArn field's value.

func (SnsConfiguration) String added in v1.42.12 

func (s SnsConfiguration) 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 (*SnsConfiguration) Validate added in v1.42.12 

func (s *SnsConfiguration) Validate() error

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

type Tag added in v1.42.12 

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. Tags enable you to categorize databases and/or tables, for example, by purpose, owner, or environment.

func (Tag) GoString added in v1.42.12 

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 added in v1.42.12 

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

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.42.12 

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

SetValue sets the Value field's value.

func (Tag) String added in v1.42.12 

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 added in v1.42.12 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.42.12 

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 added in v1.42.12 

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 added in v1.42.12 

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

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.42.12 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.42.12 

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 added in v1.42.12 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.42.12 

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

func (TagResourceOutput) GoString added in v1.42.12 

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 added in v1.42.12 

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 TargetConfiguration added in v1.42.12 

type TargetConfiguration struct {

	// Configuration needed to write data into the Timestream database and table.
	//
	// TimestreamConfiguration is a required field
	TimestreamConfiguration *TimestreamConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Configuration used for writing the output of a query.

func (TargetConfiguration) GoString added in v1.42.12 

func (s TargetConfiguration) 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 (*TargetConfiguration) SetTimestreamConfiguration added in v1.42.12 

func (s *TargetConfiguration) SetTimestreamConfiguration(v *TimestreamConfiguration) *TargetConfiguration

SetTimestreamConfiguration sets the TimestreamConfiguration field's value.

func (TargetConfiguration) String added in v1.42.12 

func (s TargetConfiguration) 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 (*TargetConfiguration) Validate added in v1.42.12 

func (s *TargetConfiguration) Validate() error

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

type TargetDestination added in v1.42.12 

type TargetDestination struct {

	// Query result destination details for Timestream data source.
	TimestreamDestination *TimestreamDestination `type:"structure"`
	// contains filtered or unexported fields
}

Destination details to write data for a target data source. Current supported data source is Timestream.

func (TargetDestination) GoString added in v1.42.12 

func (s TargetDestination) 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 (*TargetDestination) SetTimestreamDestination added in v1.42.12 

func (s *TargetDestination) SetTimestreamDestination(v *TimestreamDestination) *TargetDestination

SetTimestreamDestination sets the TimestreamDestination field's value.

func (TargetDestination) String added in v1.42.12 

func (s TargetDestination) 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
}

The request was denied due to request throttling.

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 TimeSeriesDataPoint 

type TimeSeriesDataPoint struct {

	// The timestamp when the measure value was collected.
	//
	// Time is a required field
	Time *string `type:"string" required:"true"`

	// The measure value for the data point.
	//
	// Value is a required field
	Value *Datum `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The timeseries data type represents the values of a measure over time. A time series is an array of rows of timestamps and measure values, with rows sorted in ascending order of time. A TimeSeriesDataPoint is a single data point in the time series. It represents a tuple of (time, measure value) in a time series.

func (TimeSeriesDataPoint) GoString 

func (s TimeSeriesDataPoint) 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 (*TimeSeriesDataPoint) SetTime 

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

SetTime sets the Time field's value.

func (*TimeSeriesDataPoint) SetValue 

func (s *TimeSeriesDataPoint) SetValue(v *Datum) *TimeSeriesDataPoint

SetValue sets the Value field's value.

func (TimeSeriesDataPoint) String 

func (s TimeSeriesDataPoint) 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 TimestreamConfiguration added in v1.42.12 

type TimestreamConfiguration struct {

	// Name of Timestream database to which the query result will be written.
	//
	// DatabaseName is a required field
	DatabaseName *string `type:"string" required:"true"`

	// This is to allow mapping column(s) from the query result to the dimension
	// in the destination table.
	//
	// DimensionMappings is a required field
	DimensionMappings []*DimensionMapping `type:"list" required:"true"`

	// Name of the measure column.
	MeasureNameColumn *string `type:"string"`

	// Specifies how to map measures to multi-measure records.
	MixedMeasureMappings []*MixedMeasureMapping `min:"1" type:"list"`

	// Multi-measure mappings.
	MultiMeasureMappings *MultiMeasureMappings `type:"structure"`

	// Name of Timestream table that the query result will be written to. The table
	// should be within the same database that is provided in Timestream configuration.
	//
	// TableName is a required field
	TableName *string `type:"string" required:"true"`

	// Column from query result that should be used as the time column in destination
	// table. Column type for this should be TIMESTAMP.
	//
	// TimeColumn is a required field
	TimeColumn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration to write data into Timestream database and table. This configuration allows the user to map the query result select columns into the destination table columns.

func (TimestreamConfiguration) GoString added in v1.42.12 

func (s TimestreamConfiguration) 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 (*TimestreamConfiguration) SetDatabaseName added in v1.42.12 

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

SetDatabaseName sets the DatabaseName field's value.

func (*TimestreamConfiguration) SetDimensionMappings added in v1.42.12 

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

SetDimensionMappings sets the DimensionMappings field's value.

func (*TimestreamConfiguration) SetMeasureNameColumn added in v1.42.12 

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

SetMeasureNameColumn sets the MeasureNameColumn field's value.

func (*TimestreamConfiguration) SetMixedMeasureMappings added in v1.42.12 

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

SetMixedMeasureMappings sets the MixedMeasureMappings field's value.

func (*TimestreamConfiguration) SetMultiMeasureMappings added in v1.42.12 

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

SetMultiMeasureMappings sets the MultiMeasureMappings field's value.

func (*TimestreamConfiguration) SetTableName added in v1.42.12 

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

SetTableName sets the TableName field's value.

func (*TimestreamConfiguration) SetTimeColumn added in v1.42.12 

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

SetTimeColumn sets the TimeColumn field's value.

func (TimestreamConfiguration) String added in v1.42.12 

func (s TimestreamConfiguration) 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 (*TimestreamConfiguration) Validate added in v1.42.12 

func (s *TimestreamConfiguration) Validate() error

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

type TimestreamDestination added in v1.42.12 

type TimestreamDestination struct {

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

	// Timestream table name.
	TableName *string `type:"string"`
	// contains filtered or unexported fields
}

Destination for scheduled query.

func (TimestreamDestination) GoString added in v1.42.12 

func (s TimestreamDestination) 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 (*TimestreamDestination) SetDatabaseName added in v1.42.12 

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

SetDatabaseName sets the DatabaseName field's value.

func (*TimestreamDestination) SetTableName added in v1.42.12 

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

SetTableName sets the TableName field's value.

func (TimestreamDestination) String added in v1.42.12 

func (s TimestreamDestination) 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 TimestreamQuery 

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

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *TimestreamQuery

New creates a new instance of the TimestreamQuery 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 TimestreamQuery client from just a session.
svc := timestreamquery.New(mySession)

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

func (*TimestreamQuery) CancelQuery 

func (c *TimestreamQuery) CancelQuery(input *CancelQueryInput) (*CancelQueryOutput, error)

CancelQuery API operation for Amazon Timestream Query.

Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.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 Query's API operation CancelQuery for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) CancelQueryRequest 

func (c *TimestreamQuery) CancelQueryRequest(input *CancelQueryInput) (req *request.Request, output *CancelQueryOutput)

CancelQueryRequest generates a "aws/request.Request" representing the client's request for the CancelQuery 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 CancelQuery for more information on using the CancelQuery 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 CancelQueryRequest method.
req, resp := client.CancelQueryRequest(params)

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

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

func (*TimestreamQuery) CancelQueryWithContext 

func (c *TimestreamQuery) CancelQueryWithContext(ctx aws.Context, input *CancelQueryInput, opts ...request.Option) (*CancelQueryOutput, error)

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

See CancelQuery 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 (*TimestreamQuery) CreateScheduledQuery added in v1.42.12 

func (c *TimestreamQuery) CreateScheduledQuery(input *CreateScheduledQueryInput) (*CreateScheduledQueryOutput, error)

CreateScheduledQuery API operation for Amazon Timestream Query.

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

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 Query's API operation CreateScheduledQuery for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

  • ConflictException Unable to poll results for a cancelled query.

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

  • ServiceQuotaExceededException You have exceeded the service quota.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) CreateScheduledQueryRequest added in v1.42.12 

func (c *TimestreamQuery) CreateScheduledQueryRequest(input *CreateScheduledQueryInput) (req *request.Request, output *CreateScheduledQueryOutput)

CreateScheduledQueryRequest generates a "aws/request.Request" representing the client's request for the CreateScheduledQuery 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 CreateScheduledQuery for more information on using the CreateScheduledQuery 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 CreateScheduledQueryRequest method.
req, resp := client.CreateScheduledQueryRequest(params)

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

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

func (*TimestreamQuery) CreateScheduledQueryWithContext added in v1.42.12 

func (c *TimestreamQuery) CreateScheduledQueryWithContext(ctx aws.Context, input *CreateScheduledQueryInput, opts ...request.Option) (*CreateScheduledQueryOutput, error)

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

See CreateScheduledQuery 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 (*TimestreamQuery) DeleteScheduledQuery added in v1.42.12 

func (c *TimestreamQuery) DeleteScheduledQuery(input *DeleteScheduledQueryInput) (*DeleteScheduledQueryOutput, error)

DeleteScheduledQuery API operation for Amazon Timestream Query.

Deletes a given scheduled query. This is an irreversible operation.

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 Query's API operation DeleteScheduledQuery for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

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

  • ResourceNotFoundException The requested resource could not be found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) DeleteScheduledQueryRequest added in v1.42.12 

func (c *TimestreamQuery) DeleteScheduledQueryRequest(input *DeleteScheduledQueryInput) (req *request.Request, output *DeleteScheduledQueryOutput)

DeleteScheduledQueryRequest generates a "aws/request.Request" representing the client's request for the DeleteScheduledQuery 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 DeleteScheduledQuery for more information on using the DeleteScheduledQuery 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 DeleteScheduledQueryRequest method.
req, resp := client.DeleteScheduledQueryRequest(params)

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

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

func (*TimestreamQuery) DeleteScheduledQueryWithContext added in v1.42.12 

func (c *TimestreamQuery) DeleteScheduledQueryWithContext(ctx aws.Context, input *DeleteScheduledQueryInput, opts ...request.Option) (*DeleteScheduledQueryOutput, error)

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

See DeleteScheduledQuery 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 (*TimestreamQuery) DescribeAccountSettings added in v1.51.31 

func (c *TimestreamQuery) DescribeAccountSettings(input *DescribeAccountSettingsInput) (*DescribeAccountSettingsOutput, error)

DescribeAccountSettings API operation for Amazon Timestream Query.

Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.

You're charged only for the duration of compute units used for your workloads.

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 Query's API operation DescribeAccountSettings for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

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

  • ThrottlingException The request was denied due to request throttling.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) DescribeAccountSettingsRequest added in v1.51.31 

func (c *TimestreamQuery) DescribeAccountSettingsRequest(input *DescribeAccountSettingsInput) (req *request.Request, output *DescribeAccountSettingsOutput)

DescribeAccountSettingsRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountSettings 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 DescribeAccountSettings for more information on using the DescribeAccountSettings 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 DescribeAccountSettingsRequest method.
req, resp := client.DescribeAccountSettingsRequest(params)

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

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

func (*TimestreamQuery) DescribeAccountSettingsWithContext added in v1.51.31 

func (c *TimestreamQuery) DescribeAccountSettingsWithContext(ctx aws.Context, input *DescribeAccountSettingsInput, opts ...request.Option) (*DescribeAccountSettingsOutput, error)

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

See DescribeAccountSettings 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 (*TimestreamQuery) DescribeEndpoints 

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

DescribeEndpoints API operation for Amazon Timestream Query.

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API 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 Query's API operation DescribeEndpoints for usage and error information.

Returned Error Types:

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

  • ValidationException Invalid or malformed request.

  • ThrottlingException The request was denied due to request throttling.

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

func (*TimestreamQuery) DescribeEndpointsRequest 

func (c *TimestreamQuery) 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-query-2018-11-01/DescribeEndpoints

func (*TimestreamQuery) DescribeEndpointsWithContext 

func (c *TimestreamQuery) 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 (*TimestreamQuery) DescribeScheduledQuery added in v1.42.12 

func (c *TimestreamQuery) DescribeScheduledQuery(input *DescribeScheduledQueryInput) (*DescribeScheduledQueryOutput, error)

DescribeScheduledQuery API operation for Amazon Timestream Query.

Provides detailed information about a scheduled query.

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 Query's API operation DescribeScheduledQuery for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

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

  • ResourceNotFoundException The requested resource could not be found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) DescribeScheduledQueryRequest added in v1.42.12 

func (c *TimestreamQuery) DescribeScheduledQueryRequest(input *DescribeScheduledQueryInput) (req *request.Request, output *DescribeScheduledQueryOutput)

DescribeScheduledQueryRequest generates a "aws/request.Request" representing the client's request for the DescribeScheduledQuery 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 DescribeScheduledQuery for more information on using the DescribeScheduledQuery 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 DescribeScheduledQueryRequest method.
req, resp := client.DescribeScheduledQueryRequest(params)

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

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

func (*TimestreamQuery) DescribeScheduledQueryWithContext added in v1.42.12 

func (c *TimestreamQuery) DescribeScheduledQueryWithContext(ctx aws.Context, input *DescribeScheduledQueryInput, opts ...request.Option) (*DescribeScheduledQueryOutput, error)

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

See DescribeScheduledQuery 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 (*TimestreamQuery) ExecuteScheduledQuery added in v1.42.12 

func (c *TimestreamQuery) ExecuteScheduledQuery(input *ExecuteScheduledQueryInput) (*ExecuteScheduledQueryOutput, error)

ExecuteScheduledQuery API operation for Amazon Timestream Query.

You can use this API to run a scheduled query manually.

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 Query's API operation ExecuteScheduledQuery for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

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

  • ResourceNotFoundException The requested resource could not be found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) ExecuteScheduledQueryRequest added in v1.42.12 

func (c *TimestreamQuery) ExecuteScheduledQueryRequest(input *ExecuteScheduledQueryInput) (req *request.Request, output *ExecuteScheduledQueryOutput)

ExecuteScheduledQueryRequest generates a "aws/request.Request" representing the client's request for the ExecuteScheduledQuery 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 ExecuteScheduledQuery for more information on using the ExecuteScheduledQuery 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 ExecuteScheduledQueryRequest method.
req, resp := client.ExecuteScheduledQueryRequest(params)

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

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

func (*TimestreamQuery) ExecuteScheduledQueryWithContext added in v1.42.12 

func (c *TimestreamQuery) ExecuteScheduledQueryWithContext(ctx aws.Context, input *ExecuteScheduledQueryInput, opts ...request.Option) (*ExecuteScheduledQueryOutput, error)

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

See ExecuteScheduledQuery 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 (*TimestreamQuery) ListScheduledQueries added in v1.42.12 

func (c *TimestreamQuery) ListScheduledQueries(input *ListScheduledQueriesInput) (*ListScheduledQueriesOutput, error)

ListScheduledQueries API operation for Amazon Timestream Query.

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

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 Query's API operation ListScheduledQueries for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) ListScheduledQueriesPages added in v1.42.12 

func (c *TimestreamQuery) ListScheduledQueriesPages(input *ListScheduledQueriesInput, fn func(*ListScheduledQueriesOutput, bool) bool) error

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

See ListScheduledQueries 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 ListScheduledQueries operation.
pageNum := 0
err := client.ListScheduledQueriesPages(params,
    func(page *timestreamquery.ListScheduledQueriesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TimestreamQuery) ListScheduledQueriesPagesWithContext added in v1.42.12 

func (c *TimestreamQuery) ListScheduledQueriesPagesWithContext(ctx aws.Context, input *ListScheduledQueriesInput, fn func(*ListScheduledQueriesOutput, bool) bool, opts ...request.Option) error

ListScheduledQueriesPagesWithContext same as ListScheduledQueriesPages 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 (*TimestreamQuery) ListScheduledQueriesRequest added in v1.42.12 

func (c *TimestreamQuery) ListScheduledQueriesRequest(input *ListScheduledQueriesInput) (req *request.Request, output *ListScheduledQueriesOutput)

ListScheduledQueriesRequest generates a "aws/request.Request" representing the client's request for the ListScheduledQueries 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 ListScheduledQueries for more information on using the ListScheduledQueries 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 ListScheduledQueriesRequest method.
req, resp := client.ListScheduledQueriesRequest(params)

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

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

func (*TimestreamQuery) ListScheduledQueriesWithContext added in v1.42.12 

func (c *TimestreamQuery) ListScheduledQueriesWithContext(ctx aws.Context, input *ListScheduledQueriesInput, opts ...request.Option) (*ListScheduledQueriesOutput, error)

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

See ListScheduledQueries 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 (*TimestreamQuery) ListTagsForResource added in v1.42.12 

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

ListTagsForResource API operation for Amazon Timestream Query.

List all tags on a Timestream query 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 Query's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) ListTagsForResourcePages added in v1.42.12 

func (c *TimestreamQuery) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

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

See ListTagsForResource 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 ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *timestreamquery.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TimestreamQuery) ListTagsForResourcePagesWithContext added in v1.42.12 

func (c *TimestreamQuery) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages 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 (*TimestreamQuery) ListTagsForResourceRequest added in v1.42.12 

func (c *TimestreamQuery) 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-query-2018-11-01/ListTagsForResource

func (*TimestreamQuery) ListTagsForResourceWithContext added in v1.42.12 

func (c *TimestreamQuery) 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 (*TimestreamQuery) PrepareQuery added in v1.42.12 

func (c *TimestreamQuery) PrepareQuery(input *PrepareQueryInput) (*PrepareQueryOutput, error)

PrepareQuery API operation for Amazon Timestream Query.

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with ValidateOnly set to true.

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 Query's API operation PrepareQuery for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) PrepareQueryRequest added in v1.42.12 

func (c *TimestreamQuery) PrepareQueryRequest(input *PrepareQueryInput) (req *request.Request, output *PrepareQueryOutput)

PrepareQueryRequest generates a "aws/request.Request" representing the client's request for the PrepareQuery 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 PrepareQuery for more information on using the PrepareQuery 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 PrepareQueryRequest method.
req, resp := client.PrepareQueryRequest(params)

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

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

func (*TimestreamQuery) PrepareQueryWithContext added in v1.42.12 

func (c *TimestreamQuery) PrepareQueryWithContext(ctx aws.Context, input *PrepareQueryInput, opts ...request.Option) (*PrepareQueryOutput, error)

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

See PrepareQuery 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 (*TimestreamQuery) Query 

func (c *TimestreamQuery) Query(input *QueryInput) (*QueryOutput, error)

Query API operation for Amazon Timestream Query.

Query is a synchronous operation that enables you to run a query against your Amazon Timestream data. Query will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html) for details.

Your query request will fail in the following cases:

  • If you submit a Query request with the same client token outside of the 5-minute idempotency window.

  • If you submit a Query request with the same client token, but change other parameters, within the 5-minute idempotency window.

  • If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message: Query aborted as max page response size has been exceeded by the output result row

  • If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an Invalid pagination token error.

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 Query's API operation Query for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

  • ConflictException Unable to poll results for a cancelled query.

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

  • QueryExecutionException Timestream was unable to run the query successfully.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) QueryPages 

func (c *TimestreamQuery) QueryPages(input *QueryInput, fn func(*QueryOutput, bool) bool) error

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

See Query 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 Query operation.
pageNum := 0
err := client.QueryPages(params,
    func(page *timestreamquery.QueryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TimestreamQuery) QueryPagesWithContext 

func (c *TimestreamQuery) QueryPagesWithContext(ctx aws.Context, input *QueryInput, fn func(*QueryOutput, bool) bool, opts ...request.Option) error

QueryPagesWithContext same as QueryPages 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 (*TimestreamQuery) QueryRequest 

func (c *TimestreamQuery) QueryRequest(input *QueryInput) (req *request.Request, output *QueryOutput)

QueryRequest generates a "aws/request.Request" representing the client's request for the Query 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 Query for more information on using the Query 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 QueryRequest method.
req, resp := client.QueryRequest(params)

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

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

func (*TimestreamQuery) QueryWithContext 

func (c *TimestreamQuery) QueryWithContext(ctx aws.Context, input *QueryInput, opts ...request.Option) (*QueryOutput, error)

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

See Query 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 (*TimestreamQuery) TagResource added in v1.42.12 

func (c *TimestreamQuery) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Timestream Query.

Associate 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 Query's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • ServiceQuotaExceededException You have exceeded the service quota.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) TagResourceRequest added in v1.42.12 

func (c *TimestreamQuery) 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-query-2018-11-01/TagResource

func (*TimestreamQuery) TagResourceWithContext added in v1.42.12 

func (c *TimestreamQuery) 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 (*TimestreamQuery) UntagResource added in v1.42.12 

func (c *TimestreamQuery) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Timestream Query.

Removes the association of tags from a Timestream query 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 Query's API operation UntagResource for usage and error information.

Returned Error Types:

  • ValidationException Invalid or malformed request.

  • ThrottlingException The request was denied due to request throttling.

  • ResourceNotFoundException The requested resource could not be found.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) UntagResourceRequest added in v1.42.12 

func (c *TimestreamQuery) 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-query-2018-11-01/UntagResource

func (*TimestreamQuery) UntagResourceWithContext added in v1.42.12 

func (c *TimestreamQuery) 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 (*TimestreamQuery) UpdateAccountSettings added in v1.51.31 

func (c *TimestreamQuery) UpdateAccountSettings(input *UpdateAccountSettingsInput) (*UpdateAccountSettingsOutput, error)

UpdateAccountSettings API operation for Amazon Timestream Query.

Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective.

After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.

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 Query's API operation UpdateAccountSettings for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) UpdateAccountSettingsRequest added in v1.51.31 

func (c *TimestreamQuery) UpdateAccountSettingsRequest(input *UpdateAccountSettingsInput) (req *request.Request, output *UpdateAccountSettingsOutput)

UpdateAccountSettingsRequest generates a "aws/request.Request" representing the client's request for the UpdateAccountSettings 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 UpdateAccountSettings for more information on using the UpdateAccountSettings 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 UpdateAccountSettingsRequest method.
req, resp := client.UpdateAccountSettingsRequest(params)

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

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

func (*TimestreamQuery) UpdateAccountSettingsWithContext added in v1.51.31 

func (c *TimestreamQuery) UpdateAccountSettingsWithContext(ctx aws.Context, input *UpdateAccountSettingsInput, opts ...request.Option) (*UpdateAccountSettingsOutput, error)

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

See UpdateAccountSettings 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 (*TimestreamQuery) UpdateScheduledQuery added in v1.42.12 

func (c *TimestreamQuery) UpdateScheduledQuery(input *UpdateScheduledQueryInput) (*UpdateScheduledQueryOutput, error)

UpdateScheduledQuery API operation for Amazon Timestream Query.

Update a scheduled query.

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 Query's API operation UpdateScheduledQuery for usage and error information.

Returned Error Types:

  • AccessDeniedException You are not authorized to perform this action.

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

  • ResourceNotFoundException The requested resource could not be found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid or malformed request.

  • InvalidEndpointException The requested endpoint was not valid.

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

func (*TimestreamQuery) UpdateScheduledQueryRequest added in v1.42.12 

func (c *TimestreamQuery) UpdateScheduledQueryRequest(input *UpdateScheduledQueryInput) (req *request.Request, output *UpdateScheduledQueryOutput)

UpdateScheduledQueryRequest generates a "aws/request.Request" representing the client's request for the UpdateScheduledQuery 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 UpdateScheduledQuery for more information on using the UpdateScheduledQuery 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 UpdateScheduledQueryRequest method.
req, resp := client.UpdateScheduledQueryRequest(params)

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

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

func (*TimestreamQuery) UpdateScheduledQueryWithContext added in v1.42.12 

func (c *TimestreamQuery) UpdateScheduledQueryWithContext(ctx aws.Context, input *UpdateScheduledQueryInput, opts ...request.Option) (*UpdateScheduledQueryOutput, error)

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

See UpdateScheduledQuery 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 Type 

type Type struct {

	// Indicates if the column is an array.
	ArrayColumnInfo *ColumnInfo `type:"structure"`

	// Indicates if the column is a row.
	RowColumnInfo []*ColumnInfo `type:"list"`

	// Indicates if the column is of type string, integer, Boolean, double, timestamp,
	// date, time. For more information, see Supported data types (https://docs.aws.amazon.com/timestream/latest/developerguide/supported-data-types.html).
	ScalarType *string `type:"string" enum:"ScalarType"`

	// Indicates if the column is a timeseries data type.
	TimeSeriesMeasureValueColumnInfo *ColumnInfo `type:"structure"`
	// contains filtered or unexported fields
}

Contains the data type of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, Boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries.

func (Type) GoString 

func (s Type) 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 (*Type) SetArrayColumnInfo 

func (s *Type) SetArrayColumnInfo(v *ColumnInfo) *Type

SetArrayColumnInfo sets the ArrayColumnInfo field's value.

func (*Type) SetRowColumnInfo 

func (s *Type) SetRowColumnInfo(v []*ColumnInfo) *Type

SetRowColumnInfo sets the RowColumnInfo field's value.

func (*Type) SetScalarType 

func (s *Type) SetScalarType(v string) *Type

SetScalarType sets the ScalarType field's value.

func (*Type) SetTimeSeriesMeasureValueColumnInfo 

func (s *Type) SetTimeSeriesMeasureValueColumnInfo(v *ColumnInfo) *Type

SetTimeSeriesMeasureValueColumnInfo sets the TimeSeriesMeasureValueColumnInfo field's value.

func (Type) String 

func (s Type) 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 UntagResourceInput added in v1.42.12 

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 added in v1.42.12 

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 added in v1.42.12 

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

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.42.12 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.42.12 

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 added in v1.42.12 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.42.12 

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

func (UntagResourceOutput) GoString added in v1.42.12 

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 added in v1.42.12 

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 UpdateAccountSettingsInput added in v1.51.31 

type UpdateAccountSettingsInput struct {

	// The maximum number of compute units the service will use at any point in
	// time to serve your queries. To run queries, you must set a minimum capacity
	// of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example,
	// 4, 8, 16, 32, and so on.
	//
	// The maximum value supported for MaxQueryTCU is 1000. To request an increase
	// to this soft limit, contact Amazon Web Services Support. For information
	// about the default quota for maxQueryTCU, see Default quotas (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.default).
	MaxQueryTCU *int64 `type:"integer"`

	// The pricing model for queries in an account.
	QueryPricingModel *string `type:"string" enum:"QueryPricingModel"`
	// contains filtered or unexported fields
}

func (UpdateAccountSettingsInput) GoString added in v1.51.31 

func (s UpdateAccountSettingsInput) 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 (*UpdateAccountSettingsInput) SetMaxQueryTCU added in v1.51.31 

func (s *UpdateAccountSettingsInput) SetMaxQueryTCU(v int64) *UpdateAccountSettingsInput

SetMaxQueryTCU sets the MaxQueryTCU field's value.

func (*UpdateAccountSettingsInput) SetQueryPricingModel added in v1.51.31 

func (s *UpdateAccountSettingsInput) SetQueryPricingModel(v string) *UpdateAccountSettingsInput

SetQueryPricingModel sets the QueryPricingModel field's value.

func (UpdateAccountSettingsInput) String added in v1.51.31 

func (s UpdateAccountSettingsInput) 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 UpdateAccountSettingsOutput added in v1.51.31 

type UpdateAccountSettingsOutput struct {

	// The configured maximum number of compute units the service will use at any
	// point in time to serve your queries.
	MaxQueryTCU *int64 `type:"integer"`

	// The pricing model for an account.
	QueryPricingModel *string `type:"string" enum:"QueryPricingModel"`
	// contains filtered or unexported fields
}

func (UpdateAccountSettingsOutput) GoString added in v1.51.31 

func (s UpdateAccountSettingsOutput) 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 (*UpdateAccountSettingsOutput) SetMaxQueryTCU added in v1.51.31 

func (s *UpdateAccountSettingsOutput) SetMaxQueryTCU(v int64) *UpdateAccountSettingsOutput

SetMaxQueryTCU sets the MaxQueryTCU field's value.

func (*UpdateAccountSettingsOutput) SetQueryPricingModel added in v1.51.31 

func (s *UpdateAccountSettingsOutput) SetQueryPricingModel(v string) *UpdateAccountSettingsOutput

SetQueryPricingModel sets the QueryPricingModel field's value.

func (UpdateAccountSettingsOutput) String added in v1.51.31 

func (s UpdateAccountSettingsOutput) 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 UpdateScheduledQueryInput added in v1.42.12 

type UpdateScheduledQueryInput struct {

	// ARN of the scheuled query.
	//
	// ScheduledQueryArn is a required field
	ScheduledQueryArn *string `min:"1" type:"string" required:"true"`

	// State of the scheduled query.
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"ScheduledQueryState"`
	// contains filtered or unexported fields
}

func (UpdateScheduledQueryInput) GoString added in v1.42.12 

func (s UpdateScheduledQueryInput) 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 (*UpdateScheduledQueryInput) SetScheduledQueryArn added in v1.42.12 

func (s *UpdateScheduledQueryInput) SetScheduledQueryArn(v string) *UpdateScheduledQueryInput

SetScheduledQueryArn sets the ScheduledQueryArn field's value.

func (*UpdateScheduledQueryInput) SetState added in v1.42.12 

func (s *UpdateScheduledQueryInput) SetState(v string) *UpdateScheduledQueryInput

SetState sets the State field's value.

func (UpdateScheduledQueryInput) String added in v1.42.12 

func (s UpdateScheduledQueryInput) 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 (*UpdateScheduledQueryInput) Validate added in v1.42.12 

func (s *UpdateScheduledQueryInput) Validate() error

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

type UpdateScheduledQueryOutput added in v1.42.12 

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

func (UpdateScheduledQueryOutput) GoString added in v1.42.12 

func (s UpdateScheduledQueryOutput) 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 (UpdateScheduledQueryOutput) String added in v1.42.12 

func (s UpdateScheduledQueryOutput) 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
}

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".

Source Files

View all Source files

Directories

Path Synopsis
Package timestreamqueryiface provides an interface to enable mocking the Amazon Timestream Query service client for testing your code.
 Package timestreamqueryiface provides an interface to enable mocking the Amazon Timestream Query service client for testing your code.

Jump to

Keyboard shortcuts

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