timestreamquery

package
v1.38.18 Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2021 License: Apache-2.0 Imports: 13 Imported by: 42

Documentation

Overview

Package timestreamquery provides the client and types for making API requests to 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 (
	// 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 (

	// 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".
	//
	// Timestream was unable to fully process this request because of an internal
	// server error.
	ErrCodeInternalServerException = "InternalServerException"

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

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

	// 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

Variables

This section is empty.

Functions

func ScalarType_Values 

func ScalarType_Values() []string

ScalarType_Values returns all elements of the ScalarType 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

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

type CancelQueryInput 

type CancelQueryInput struct {

	// The id of the query that needs to be cancelled. QueryID is returned as part
	// of QueryResult.
	//
	// 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

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

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

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

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 meta data 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

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

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

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

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 of 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

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

type DescribeEndpointsInput 

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

func (DescribeEndpointsInput) GoString 

func (s DescribeEndpointsInput) GoString() string

GoString returns the string representation

func (DescribeEndpointsInput) String 

func (s DescribeEndpointsInput) String() string

String returns the string representation

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

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

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 agaisnt, as well as the TTL for that endpoint.

func (Endpoint) GoString 

func (s Endpoint) GoString() string

GoString returns the string representation

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

type InternalServerException 

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

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

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

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation

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

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

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

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

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

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

type QueryInput 

type QueryInput struct {

	// Unique, case-sensitive string of up to 64 ASCII characters that you specify
	// when you make a Query request. Providing a ClientToken makes the call to
	// Query idempotent, meaning that multiple identical calls have the same effect
	// as one single call.
	//
	// Your query request will fail in the following cases:
	//
	//    * If you submit a request with the same client token outside the 5-minute
	//    idepotency window.
	//
	//    * If you submit a request with the same client token but a change in other
	//    parameters within the 5-minute idempotency window.
	//
	// After 4 hours, any request with the same client token is treated as a new
	// request.
	ClientToken *string `min:"32" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The total number of rows to return in the output. If the total number of
	// rows available is more than the value specified, a NextToken is provided
	// in the command's output. To resume pagination, provide the NextToken value
	// in the starting-token argument of a subsequent command.
	MaxRows *int64 `min:"1" type:"integer"`

	// A pagination token passed to get a set of results.
	NextToken *string `type:"string"`

	// The query to be executed by Timestream.
	//
	// QueryString is a required field
	QueryString *string `type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (QueryInput) GoString 

func (s QueryInput) GoString() string

GoString returns the string representation

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

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 `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 scannned.
	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

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

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 execution 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 scannned.

func (QueryStatus) GoString added in v1.35.34 

func (s QueryStatus) GoString() string

GoString returns the string representation

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

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

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

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

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

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 datatype 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 timeseries. It represents a tuple of (time, measure value) in a timeseries.

func (TimeSeriesDataPoint) GoString 

func (s TimeSeriesDataPoint) GoString() string

GoString returns the string representation

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

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 guaranteed only if the query has not completed execution 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.

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 Timestream 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 invalid.

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) 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 Timestream’s 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:

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

  • You require better control over the client-side implementation

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

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

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

Returned Error Types:

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

  • ValidationException 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) 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 execute a query. Query will timeout after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. The result set will be truncated to 1MB. Service quotas apply. For more information, see Quotas in the Timestream Developer Guide.

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 Timestream 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 invalid.

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.

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

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

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

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

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.