Documentation

Overview

    Package timestreamquery provides the API client, operations, and parameter types for Amazon Timestream Query.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-11-01"
    View Source
    const ServiceID = "Timestream Query"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type CancelQueryInput

          type CancelQueryInput struct {
          
          	// The id of the query that needs to be cancelled. QueryID is returned as part of
          	// QueryResult.
          	//
          	// This member is required.
          	QueryId *string
          }

          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
          
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

          type Client

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

            Client provides the API client to make operations call for Amazon Timestream Query.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) CancelQuery

                func (c *Client) CancelQuery(ctx context.Context, params *CancelQueryInput, optFns ...func(*Options)) (*CancelQueryOutput, error)

                  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.

                  func (*Client) DescribeEndpoints

                  func (c *Client) DescribeEndpoints(ctx context.Context, params *DescribeEndpointsInput, optFns ...func(*Options)) (*DescribeEndpointsOutput, error)

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

                    func (*Client) Query

                    func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(*Options)) (*QueryOutput, error)

                      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.

                      type DescribeEndpointsInput

                      type DescribeEndpointsInput struct {
                      }

                      type DescribeEndpointsOutput

                      type DescribeEndpointsOutput struct {
                      
                      	// An Endpoints object is returned when a DescribeEndpoints request is made.
                      	//
                      	// This member is required.
                      	Endpoints []types.Endpoint
                      
                      	// Metadata pertaining to the operation's result.
                      	ResultMetadata middleware.Metadata
                      }

                      type EndpointResolver

                      type EndpointResolver interface {
                      	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                      }

                        EndpointResolver interface for resolving service endpoints.

                        func EndpointResolverFromURL

                        func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                          EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                          type EndpointResolverFunc

                          type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                            EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                            func (EndpointResolverFunc) ResolveEndpoint

                            func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                            type EndpointResolverOptions

                            type EndpointResolverOptions = internalendpoints.Options

                              EndpointResolverOptions is the service endpoint resolver options

                              type HTTPClient

                              type HTTPClient interface {
                              	Do(*http.Request) (*http.Response, error)
                              }

                              type HTTPSignerV4

                              type HTTPSignerV4 interface {
                              	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                              }

                              type IdempotencyTokenProvider

                              type IdempotencyTokenProvider interface {
                              	GetIdempotencyToken() (string, error)
                              }

                                IdempotencyTokenProvider interface for providing idempotency token

                                type Options

                                type Options struct {
                                	// Set of options to modify how an operation is invoked. These apply to all
                                	// operations invoked for this client. Use functional options on operation call to
                                	// modify this list for per operation behavior.
                                	APIOptions []func(*middleware.Stack) error
                                
                                	// Configures the events that will be sent to the configured logger.
                                	ClientLogMode aws.ClientLogMode
                                
                                	// The credentials object to use when signing requests.
                                	Credentials aws.CredentialsProvider
                                
                                	// The endpoint options to be used when attempting to resolve an endpoint.
                                	EndpointOptions EndpointResolverOptions
                                
                                	// The service endpoint resolver.
                                	EndpointResolver EndpointResolver
                                
                                	// Signature Version 4 (SigV4) Signer
                                	HTTPSignerV4 HTTPSignerV4
                                
                                	// Provides idempotency tokens values that will be automatically populated into
                                	// idempotent API operations.
                                	IdempotencyTokenProvider IdempotencyTokenProvider
                                
                                	// The logger writer interface to write logging messages to.
                                	Logger logging.Logger
                                
                                	// The region to send requests to. (Required)
                                	Region string
                                
                                	// Retryer guides how HTTP requests should be retried in case of recoverable
                                	// failures. When nil the API client will use a default retryer.
                                	Retryer aws.Retryer
                                
                                	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                	// implementation if nil.
                                	HTTPClient HTTPClient
                                }

                                func (Options) Copy

                                func (o Options) Copy() Options

                                  Copy creates a clone where the APIOptions list is deep copied.

                                  type QueryAPIClient

                                  type QueryAPIClient interface {
                                  	Query(context.Context, *QueryInput, ...func(*Options)) (*QueryOutput, error)
                                  }

                                    QueryAPIClient is a client that implements the Query operation.

                                    type QueryInput

                                    type QueryInput struct {
                                    
                                    	// The query to be executed by Timestream.
                                    	//
                                    	// This member is required.
                                    	QueryString *string
                                    
                                    	// 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
                                    
                                    	// 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 *int32
                                    
                                    	// A pagination token passed to get a set of results.
                                    	NextToken *string
                                    }

                                    type QueryOutput

                                    type QueryOutput struct {
                                    
                                    	// The column data types of the returned result set.
                                    	//
                                    	// This member is required.
                                    	ColumnInfo []types.ColumnInfo
                                    
                                    	// A unique ID for the given query.
                                    	//
                                    	// This member is required.
                                    	QueryId *string
                                    
                                    	// The result set rows returned by the query.
                                    	//
                                    	// This member is required.
                                    	Rows []types.Row
                                    
                                    	// A pagination token that can be used again on a Query call to get the next set of
                                    	// results.
                                    	NextToken *string
                                    
                                    	// Information about the status of the query, including progress and bytes
                                    	// scannned.
                                    	QueryStatus *types.QueryStatus
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                    type QueryPaginator

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

                                      QueryPaginator is a paginator for Query

                                      func NewQueryPaginator

                                      func NewQueryPaginator(client QueryAPIClient, params *QueryInput, optFns ...func(*QueryPaginatorOptions)) *QueryPaginator

                                        NewQueryPaginator returns a new QueryPaginator

                                        func (*QueryPaginator) HasMorePages

                                        func (p *QueryPaginator) HasMorePages() bool

                                          HasMorePages returns a boolean indicating whether more pages are available

                                          func (*QueryPaginator) NextPage

                                          func (p *QueryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*QueryOutput, error)

                                            NextPage retrieves the next Query page.

                                            type QueryPaginatorOptions

                                            type QueryPaginatorOptions struct {
                                            	// 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.
                                            	Limit int32
                                            
                                            	// Set to true if pagination should stop if the service returns a pagination token
                                            	// that matches the most recent token provided to the service.
                                            	StopOnDuplicateToken bool
                                            }

                                              QueryPaginatorOptions is the paginator options for Query

                                              type ResolveEndpoint

                                              type ResolveEndpoint struct {
                                              	Resolver EndpointResolver
                                              	Options  EndpointResolverOptions
                                              }

                                              func (*ResolveEndpoint) HandleSerialize

                                              func (*ResolveEndpoint) ID

                                              func (*ResolveEndpoint) ID() string

                                              Directories

                                              Path Synopsis
                                              internal