timestreamquery

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

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

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

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

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 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 struct {

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

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

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

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 struct {

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

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 struct {
	// Enables endpoint discovery
	EnableEndpointDiscovery aws.EndpointDiscoveryEnableState

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

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
}

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

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

type EndpointResolverOptions = internalendpoints.Options

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,
	)
}

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 struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

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 interface {
	GetIdempotencyToken() (string, error)
}

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

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

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
}

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

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

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
}

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

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

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 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 interface {
	Query(context.Context, *QueryInput, ...func(*Options)) (*QueryOutput, error)
}

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

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
}

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

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 struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}