timestreamquery

package module
v1.25.4 Latest Latest
Warning

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

Go to latest
Published: Jul 18, 2024 License: Apache-2.0 Imports: 46 Imported by: 8

Documentation

Overview

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

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

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

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

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.16.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.19.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.19.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.19.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.19.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CancelQueryInput

type CancelQueryInput struct {

	//  The ID of the query that needs to be cancelled. QueryID is returned as part of
	// the query result.
	//
	// This member is required.
	QueryId *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

func (*Client) CreateScheduledQuery added in v1.8.0

func (c *Client) CreateScheduledQuery(ctx context.Context, params *CreateScheduledQueryInput, optFns ...func(*Options)) (*CreateScheduledQueryOutput, error)
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.

func (*Client) DeleteScheduledQuery added in v1.8.0

func (c *Client) DeleteScheduledQuery(ctx context.Context, params *DeleteScheduledQueryInput, optFns ...func(*Options)) (*DeleteScheduledQueryOutput, error)

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

func (*Client) DescribeAccountSettings added in v1.23.0

func (c *Client) DescribeAccountSettings(ctx context.Context, params *DescribeAccountSettingsInput, optFns ...func(*Options)) (*DescribeAccountSettingsOutput, error)

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.

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

func (*Client) DescribeScheduledQuery added in v1.8.0

func (c *Client) DescribeScheduledQuery(ctx context.Context, params *DescribeScheduledQueryInput, optFns ...func(*Options)) (*DescribeScheduledQueryOutput, error)

Provides detailed information about a scheduled query.

func (*Client) ExecuteScheduledQuery added in v1.8.0

func (c *Client) ExecuteScheduledQuery(ctx context.Context, params *ExecuteScheduledQueryInput, optFns ...func(*Options)) (*ExecuteScheduledQueryOutput, error)

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

func (*Client) ListScheduledQueries added in v1.8.0

func (c *Client) ListScheduledQueries(ctx context.Context, params *ListScheduledQueriesInput, optFns ...func(*Options)) (*ListScheduledQueriesOutput, error)

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

func (*Client) ListTagsForResource added in v1.8.0

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

List all tags on a Timestream query resource.

func (*Client) Options added in v1.20.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PrepareQuery added in v1.8.0

func (c *Client) PrepareQuery(ctx context.Context, params *PrepareQueryInput, optFns ...func(*Options)) (*PrepareQueryOutput, error)

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 .

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

func (*Client) TagResource added in v1.8.0

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

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.

func (*Client) UntagResource added in v1.8.0

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes the association of tags from a Timestream query resource.

func (*Client) UpdateAccountSettings added in v1.23.0

func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error)

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.

func (*Client) UpdateScheduledQuery added in v1.8.0

func (c *Client) UpdateScheduledQuery(ctx context.Context, params *UpdateScheduledQueryInput, optFns ...func(*Options)) (*UpdateScheduledQueryOutput, error)

Update a scheduled query.

type CreateScheduledQueryInput added in v1.8.0

type CreateScheduledQueryInput struct {

	// Configuration for error reporting. Error reports will be generated when a
	// problem is encountered when writing the query results.
	//
	// This member is required.
	ErrorReportConfiguration *types.ErrorReportConfiguration

	// Name of the scheduled query.
	//
	// This member is required.
	Name *string

	// 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.
	//
	// This member is required.
	NotificationConfiguration *types.NotificationConfiguration

	// 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.
	//
	// This member is required.
	QueryString *string

	// The schedule configuration for the query.
	//
	// This member is required.
	ScheduleConfiguration *types.ScheduleConfiguration

	// The ARN for the IAM role that Timestream will assume when running the scheduled
	// query.
	//
	// This member is required.
	ScheduledQueryExecutionRoleArn *string

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

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

	// A list of key-value pairs to label the scheduled query.
	Tags []types.Tag

	// Configuration used for writing the result of a query.
	TargetConfiguration *types.TargetConfiguration
	// contains filtered or unexported fields
}

type CreateScheduledQueryOutput added in v1.8.0

type CreateScheduledQueryOutput struct {

	// ARN for the created scheduled query.
	//
	// This member is required.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteScheduledQueryInput added in v1.8.0

type DeleteScheduledQueryInput struct {

	// The ARN of the scheduled query.
	//
	// This member is required.
	ScheduledQueryArn *string
	// contains filtered or unexported fields
}

type DeleteScheduledQueryOutput added in v1.8.0

type DeleteScheduledQueryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAccountSettingsInput added in v1.23.0

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

type DescribeAccountSettingsOutput added in v1.23.0

type DescribeAccountSettingsOutput struct {

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

	// The pricing model for queries in your account.
	QueryPricingModel types.QueryPricingModel

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeEndpointsInput

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

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
	// contains filtered or unexported fields
}

type DescribeScheduledQueryInput added in v1.8.0

type DescribeScheduledQueryInput struct {

	// The ARN of the scheduled query.
	//
	// This member is required.
	ScheduledQueryArn *string
	// contains filtered or unexported fields
}

type DescribeScheduledQueryOutput added in v1.8.0

type DescribeScheduledQueryOutput struct {

	// The scheduled query.
	//
	// This member is required.
	ScheduledQuery *types.ScheduledQueryDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointDiscoveryOptions added in v1.3.0

type EndpointDiscoveryOptions struct {
	// Enables endpoint discovery
	EnableEndpointDiscovery aws.EndpointDiscoveryEnableState

	// Allows configuring an endpoint resolver to use when attempting an endpoint
	// discovery api request.
	EndpointResolverUsedForDiscovery EndpointResolver
}

EndpointDiscoveryOptions used to configure endpoint discovery

type EndpointParameters added in v1.16.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.16.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.16.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

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

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.16.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExecuteScheduledQueryInput added in v1.8.0

type ExecuteScheduledQueryInput struct {

	// The timestamp in UTC. Query will be run as if it was invoked at this timestamp.
	//
	// This member is required.
	InvocationTime *time.Time

	// ARN of the scheduled query.
	//
	// This member is required.
	ScheduledQueryArn *string

	// Not used.
	ClientToken *string
	// contains filtered or unexported fields
}

type ExecuteScheduledQueryOutput added in v1.8.0

type ExecuteScheduledQueryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type ListScheduledQueriesAPIClient interface {
	ListScheduledQueries(context.Context, *ListScheduledQueriesInput, ...func(*Options)) (*ListScheduledQueriesOutput, error)
}

ListScheduledQueriesAPIClient is a client that implements the ListScheduledQueries operation.

type ListScheduledQueriesInput added in v1.8.0

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 *int32

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

type ListScheduledQueriesOutput added in v1.8.0

type ListScheduledQueriesOutput struct {

	// A list of scheduled queries.
	//
	// This member is required.
	ScheduledQueries []types.ScheduledQuery

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListScheduledQueriesPaginator added in v1.8.0

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

ListScheduledQueriesPaginator is a paginator for ListScheduledQueries

func NewListScheduledQueriesPaginator added in v1.8.0

NewListScheduledQueriesPaginator returns a new ListScheduledQueriesPaginator

func (*ListScheduledQueriesPaginator) HasMorePages added in v1.8.0

func (p *ListScheduledQueriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListScheduledQueriesPaginator) NextPage added in v1.8.0

NextPage retrieves the next ListScheduledQueries page.

type ListScheduledQueriesPaginatorOptions added in v1.8.0

type ListScheduledQueriesPaginatorOptions 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 .
	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
}

ListScheduledQueriesPaginatorOptions is the paginator options for ListScheduledQueries

type ListTagsForResourceAPIClient added in v1.8.0

type ListTagsForResourceAPIClient interface {
	ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error)
}

ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.

type ListTagsForResourceInput added in v1.8.0

type ListTagsForResourceInput struct {

	// The Timestream resource with tags to be listed. This value is an Amazon
	// Resource Name (ARN).
	//
	// This member is required.
	ResourceARN *string

	// The maximum number of tags to return.
	MaxResults *int32

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

type ListTagsForResourceOutput added in v1.8.0

type ListTagsForResourceOutput struct {

	// The tags currently associated with the Timestream resource.
	//
	// This member is required.
	Tags []types.Tag

	// A pagination token to resume pagination with a subsequent call to
	// ListTagsForResourceResponse .
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTagsForResourcePaginator added in v1.8.0

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

ListTagsForResourcePaginator is a paginator for ListTagsForResource

func NewListTagsForResourcePaginator added in v1.8.0

func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator

NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator

func (*ListTagsForResourcePaginator) HasMorePages added in v1.8.0

func (p *ListTagsForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsForResourcePaginator) NextPage added in v1.8.0

func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

NextPage retrieves the next ListTagsForResource page.

type ListTagsForResourcePaginatorOptions added in v1.8.0

type ListTagsForResourcePaginatorOptions struct {
	// The maximum number of tags to return.
	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
}

ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource

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

	// Indicates how aws account ID is applied in endpoint2.0 routing
	AccountIDEndpointMode aws.AccountIDEndpointMode

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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 configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// Allows configuring endpoint discovery
	EndpointDiscovery EndpointDiscoveryOptions

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.19.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PrepareQueryInput added in v1.8.0

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.
	//
	// This member is required.
	QueryString *string

	// 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
	// contains filtered or unexported fields
}

type PrepareQueryOutput added in v1.8.0

type PrepareQueryOutput struct {

	// A list of SELECT clause columns of the submitted query string.
	//
	// This member is required.
	Columns []types.SelectColumn

	// A list of parameters used in the submitted query string.
	//
	// This member is required.
	Parameters []types.ParameterMapping

	// The query string that you want prepare.
	//
	// This member is required.
	QueryString *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type QueryAPIClient added in v0.2.0

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 run by Timestream.
	//
	// This member is required.
	QueryString *string

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

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

	//  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
	// contains filtered or unexported fields
}

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 scanned.
	QueryStatus *types.QueryStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type QueryPaginator added in v0.2.0

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

QueryPaginator is a paginator for Query

func NewQueryPaginator added in v0.2.0

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

NewQueryPaginator returns a new QueryPaginator

func (*QueryPaginator) HasMorePages added in v0.2.0

func (p *QueryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*QueryPaginator) NextPage added in v0.2.0

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

NextPage retrieves the next Query page.

type QueryPaginatorOptions added in v0.2.0

type QueryPaginatorOptions struct {
	//  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.
	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

type TagResourceInput added in v1.8.0

type TagResourceInput struct {

	// Identifies the Timestream resource to which tags should be added. This value is
	// an Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceARN *string

	// The tags to be assigned to the Timestream resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput added in v1.8.0

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput added in v1.8.0

type UntagResourceInput struct {

	// The Timestream resource that the tags will be removed from. This value is an
	// Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceARN *string

	// A list of tags keys. Existing tags of the resource whose keys are members of
	// this list will be removed from the Timestream resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v1.8.0

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAccountSettingsInput added in v1.23.0

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].
	//
	// [Default quotas]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.default
	MaxQueryTCU *int32

	// The pricing model for queries in an account.
	//
	// The QueryPricingModel parameter is used by several Timestream operations;
	// however, the UpdateAccountSettings API operation doesn't recognize any values
	// other than COMPUTE_UNITS .
	QueryPricingModel types.QueryPricingModel
	// contains filtered or unexported fields
}

type UpdateAccountSettingsOutput added in v1.23.0

type UpdateAccountSettingsOutput struct {

	// The configured maximum number of compute units the service will use at any
	// point in time to serve your queries.
	MaxQueryTCU *int32

	// The pricing model for an account.
	QueryPricingModel types.QueryPricingModel

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateScheduledQueryInput added in v1.8.0

type UpdateScheduledQueryInput struct {

	// ARN of the scheuled query.
	//
	// This member is required.
	ScheduledQueryArn *string

	// State of the scheduled query.
	//
	// This member is required.
	State types.ScheduledQueryState
	// contains filtered or unexported fields
}

type UpdateScheduledQueryOutput added in v1.8.0

type UpdateScheduledQueryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL