@aws-sdk/client-timestream-query 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14,12 +14,14 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
14
14
  import { UpdateScheduledQueryCommandInput, UpdateScheduledQueryCommandOutput } from "./commands/UpdateScheduledQueryCommand";
15
15
  import { TimestreamQueryClient } from "./TimestreamQueryClient";
16
16
  /**
17
+ * @public
17
18
  * <fullname>Amazon Timestream Query
18
19
  * </fullname>
19
20
  * <p></p>
20
21
  */
21
22
  export declare class TimestreamQuery extends TimestreamQueryClient {
22
23
  /**
24
+ * @public
23
25
  * <p> Cancels a query that has been issued. Cancellation is provided only if the query has
24
26
  * not completed running before the cancellation request was issued. Because cancellation
25
27
  * is an idempotent operation, subsequent cancellation requests will return a
@@ -31,6 +33,7 @@ export declare class TimestreamQuery extends TimestreamQueryClient {
31
33
  cancelQuery(args: CancelQueryCommandInput, cb: (err: any, data?: CancelQueryCommandOutput) => void): void;
32
34
  cancelQuery(args: CancelQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelQueryCommandOutput) => void): void;
33
35
  /**
36
+ * @public
34
37
  * <p> Create a scheduled query that will be run on your behalf at the configured schedule.
35
38
  * Timestream assumes the execution role provided as part of the
36
39
  * <code>ScheduledQueryExecutionRoleArn</code> parameter to run the query. You can use
@@ -41,12 +44,14 @@ export declare class TimestreamQuery extends TimestreamQueryClient {
41
44
  createScheduledQuery(args: CreateScheduledQueryCommandInput, cb: (err: any, data?: CreateScheduledQueryCommandOutput) => void): void;
42
45
  createScheduledQuery(args: CreateScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduledQueryCommandOutput) => void): void;
43
46
  /**
47
+ * @public
44
48
  * <p>Deletes a given scheduled query. This is an irreversible operation. </p>
45
49
  */
46
50
  deleteScheduledQuery(args: DeleteScheduledQueryCommandInput, options?: __HttpHandlerOptions): Promise<DeleteScheduledQueryCommandOutput>;
47
51
  deleteScheduledQuery(args: DeleteScheduledQueryCommandInput, cb: (err: any, data?: DeleteScheduledQueryCommandOutput) => void): void;
48
52
  deleteScheduledQuery(args: DeleteScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduledQueryCommandOutput) => void): void;
49
53
  /**
54
+ * @public
50
55
  * <p>DescribeEndpoints returns a list of available endpoints to make Timestream
51
56
  * API calls against. This API is available through both Write and Query.</p>
52
57
  * <p>Because the Timestream SDKs are designed to transparently work with the
@@ -73,30 +78,35 @@ export declare class TimestreamQuery extends TimestreamQueryClient {
73
78
  describeEndpoints(args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void): void;
74
79
  describeEndpoints(args: DescribeEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void): void;
75
80
  /**
81
+ * @public
76
82
  * <p>Provides detailed information about a scheduled query.</p>
77
83
  */
78
84
  describeScheduledQuery(args: DescribeScheduledQueryCommandInput, options?: __HttpHandlerOptions): Promise<DescribeScheduledQueryCommandOutput>;
79
85
  describeScheduledQuery(args: DescribeScheduledQueryCommandInput, cb: (err: any, data?: DescribeScheduledQueryCommandOutput) => void): void;
80
86
  describeScheduledQuery(args: DescribeScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduledQueryCommandOutput) => void): void;
81
87
  /**
88
+ * @public
82
89
  * <p> You can use this API to run a scheduled query manually. </p>
83
90
  */
84
91
  executeScheduledQuery(args: ExecuteScheduledQueryCommandInput, options?: __HttpHandlerOptions): Promise<ExecuteScheduledQueryCommandOutput>;
85
92
  executeScheduledQuery(args: ExecuteScheduledQueryCommandInput, cb: (err: any, data?: ExecuteScheduledQueryCommandOutput) => void): void;
86
93
  executeScheduledQuery(args: ExecuteScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteScheduledQueryCommandOutput) => void): void;
87
94
  /**
95
+ * @public
88
96
  * <p>Gets a list of all scheduled queries in the caller's Amazon account and Region. <code>ListScheduledQueries</code> is eventually consistent. </p>
89
97
  */
90
98
  listScheduledQueries(args: ListScheduledQueriesCommandInput, options?: __HttpHandlerOptions): Promise<ListScheduledQueriesCommandOutput>;
91
99
  listScheduledQueries(args: ListScheduledQueriesCommandInput, cb: (err: any, data?: ListScheduledQueriesCommandOutput) => void): void;
92
100
  listScheduledQueries(args: ListScheduledQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScheduledQueriesCommandOutput) => void): void;
93
101
  /**
102
+ * @public
94
103
  * <p>List all tags on a Timestream query resource.</p>
95
104
  */
96
105
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
97
106
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
98
107
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
99
108
  /**
109
+ * @public
100
110
  * <p>A synchronous operation that allows you to submit a query with parameters to be stored
101
111
  * by Timestream for later running. Timestream only supports using this operation with the
102
112
  * <code>PrepareQueryRequest$ValidateOnly</code> set to <code>true</code>. </p>
@@ -105,6 +115,7 @@ export declare class TimestreamQuery extends TimestreamQueryClient {
105
115
  prepareQuery(args: PrepareQueryCommandInput, cb: (err: any, data?: PrepareQueryCommandOutput) => void): void;
106
116
  prepareQuery(args: PrepareQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PrepareQueryCommandOutput) => void): void;
107
117
  /**
118
+ * @public
108
119
  * <p>
109
120
  * <code>Query</code> is a synchronous operation that enables you to run a query against
110
121
  * your Amazon Timestream data. <code>Query</code> will time out after 60 seconds.
@@ -141,6 +152,7 @@ export declare class TimestreamQuery extends TimestreamQueryClient {
141
152
  query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void;
142
153
  query(args: QueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryCommandOutput) => void): void;
143
154
  /**
155
+ * @public
144
156
  * <p>Associate a set of tags with a Timestream resource. You can then activate these
145
157
  * user-defined tags so that they appear on the Billing and Cost Management console for
146
158
  * cost allocation tracking. </p>
@@ -149,12 +161,14 @@ export declare class TimestreamQuery extends TimestreamQueryClient {
149
161
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
150
162
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
151
163
  /**
164
+ * @public
152
165
  * <p>Removes the association of tags from a Timestream query resource.</p>
153
166
  */
154
167
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
155
168
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
156
169
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
157
170
  /**
171
+ * @public
158
172
  * <p>Update a scheduled query.</p>
159
173
  */
160
174
  updateScheduledQuery(args: UpdateScheduledQueryCommandInput, options?: __HttpHandlerOptions): Promise<UpdateScheduledQueryCommandOutput>;
@@ -22,15 +22,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
22
22
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
23
23
  import { UpdateScheduledQueryCommandInput, UpdateScheduledQueryCommandOutput } from "./commands/UpdateScheduledQueryCommand";
24
24
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
25
+ /**
26
+ * @public
27
+ */
25
28
  export type ServiceInputTypes = CancelQueryCommandInput | CreateScheduledQueryCommandInput | DeleteScheduledQueryCommandInput | DescribeEndpointsCommandInput | DescribeScheduledQueryCommandInput | ExecuteScheduledQueryCommandInput | ListScheduledQueriesCommandInput | ListTagsForResourceCommandInput | PrepareQueryCommandInput | QueryCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateScheduledQueryCommandInput;
29
+ /**
30
+ * @public
31
+ */
26
32
  export type ServiceOutputTypes = CancelQueryCommandOutput | CreateScheduledQueryCommandOutput | DeleteScheduledQueryCommandOutput | DescribeEndpointsCommandOutput | DescribeScheduledQueryCommandOutput | ExecuteScheduledQueryCommandOutput | ListScheduledQueriesCommandOutput | ListTagsForResourceCommandOutput | PrepareQueryCommandOutput | QueryCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateScheduledQueryCommandOutput;
33
+ /**
34
+ * @public
35
+ */
27
36
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
28
37
  /**
29
38
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
30
39
  */
31
40
  requestHandler?: __HttpHandler;
32
41
  /**
33
- * A constructor for a class implementing the {@link __Checksum} interface
42
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
34
43
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
35
44
  * @internal
36
45
  */
@@ -126,23 +135,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
126
135
  */
127
136
  logger?: __Logger;
128
137
  /**
129
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
138
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
130
139
  */
131
140
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
132
141
  }
142
+ /**
143
+ * @public
144
+ */
133
145
  type TimestreamQueryClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & EndpointDiscoveryInputConfig & ClientInputEndpointParameters;
134
146
  /**
135
- * The configuration interface of TimestreamQueryClient class constructor that set the region, credentials and other options.
147
+ * @public
148
+ *
149
+ * The configuration interface of TimestreamQueryClient class constructor that set the region, credentials and other options.
136
150
  */
137
151
  export interface TimestreamQueryClientConfig extends TimestreamQueryClientConfigType {
138
152
  }
153
+ /**
154
+ * @public
155
+ */
139
156
  type TimestreamQueryClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & EndpointDiscoveryResolvedConfig & ClientResolvedEndpointParameters;
140
157
  /**
141
- * The resolved configuration interface of TimestreamQueryClient class. This is resolved and normalized from the {@link TimestreamQueryClientConfig | constructor configuration interface}.
158
+ * @public
159
+ *
160
+ * The resolved configuration interface of TimestreamQueryClient class. This is resolved and normalized from the {@link TimestreamQueryClientConfig | constructor configuration interface}.
142
161
  */
143
162
  export interface TimestreamQueryClientResolvedConfig extends TimestreamQueryClientResolvedConfigType {
144
163
  }
145
164
  /**
165
+ * @public
146
166
  * <fullname>Amazon Timestream Query
147
167
  * </fullname>
148
168
  * <p></p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CancelQueryRequest, CancelQueryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CancelQueryCommand}.
8
10
  */
9
11
  export interface CancelQueryCommandInput extends CancelQueryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CancelQueryCommand}.
13
17
  */
14
18
  export interface CancelQueryCommandOutput extends CancelQueryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Cancels a query that has been issued. Cancellation is provided only if the query has
18
23
  * not completed running before the cancellation request was issued. Because cancellation
19
24
  * is an idempotent operation, subsequent cancellation requests will return a
@@ -30,6 +35,8 @@ export interface CancelQueryCommandOutput extends CancelQueryResponse, __Metadat
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param CancelQueryCommandInput - {@link CancelQueryCommandInput}
39
+ * @returns {@link CancelQueryCommandOutput}
33
40
  * @see {@link CancelQueryCommandInput} for command's `input` shape.
34
41
  * @see {@link CancelQueryCommandOutput} for command's `response` shape.
35
42
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CancelQueryCommandOutput extends CancelQueryResponse, __Metadat
56
63
  export declare class CancelQueryCommand extends $Command<CancelQueryCommandInput, CancelQueryCommandOutput, TimestreamQueryClientResolvedConfig> {
57
64
  readonly input: CancelQueryCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CancelQueryCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelQueryCommandInput, CancelQueryCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateScheduledQueryRequest, CreateScheduledQueryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateScheduledQueryCommand}.
8
10
  */
9
11
  export interface CreateScheduledQueryCommandInput extends CreateScheduledQueryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateScheduledQueryCommand}.
13
17
  */
14
18
  export interface CreateScheduledQueryCommandOutput extends CreateScheduledQueryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Create a scheduled query that will be run on your behalf at the configured schedule.
18
23
  * Timestream assumes the execution role provided as part of the
19
24
  * <code>ScheduledQueryExecutionRoleArn</code> parameter to run the query. You can use
@@ -29,6 +34,8 @@ export interface CreateScheduledQueryCommandOutput extends CreateScheduledQueryR
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateScheduledQueryCommandInput - {@link CreateScheduledQueryCommandInput}
38
+ * @returns {@link CreateScheduledQueryCommandOutput}
32
39
  * @see {@link CreateScheduledQueryCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateScheduledQueryCommandOutput} for command's `response` shape.
34
41
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -61,11 +68,20 @@ export interface CreateScheduledQueryCommandOutput extends CreateScheduledQueryR
61
68
  export declare class CreateScheduledQueryCommand extends $Command<CreateScheduledQueryCommandInput, CreateScheduledQueryCommandOutput, TimestreamQueryClientResolvedConfig> {
62
69
  readonly input: CreateScheduledQueryCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: CreateScheduledQueryCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateScheduledQueryCommandInput, CreateScheduledQueryCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteScheduledQueryRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteScheduledQueryCommand}.
8
10
  */
9
11
  export interface DeleteScheduledQueryCommandInput extends DeleteScheduledQueryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteScheduledQueryCommand}.
13
17
  */
14
18
  export interface DeleteScheduledQueryCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a given scheduled query. This is an irreversible operation. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteScheduledQueryCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteScheduledQueryCommandInput - {@link DeleteScheduledQueryCommandInput}
34
+ * @returns {@link DeleteScheduledQueryCommandOutput}
28
35
  * @see {@link DeleteScheduledQueryCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteScheduledQueryCommandOutput} for command's `response` shape.
30
37
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteScheduledQueryCommandOutput extends __MetadataBearer {
54
61
  export declare class DeleteScheduledQueryCommand extends $Command<DeleteScheduledQueryCommandInput, DeleteScheduledQueryCommandOutput, TimestreamQueryClientResolvedConfig> {
55
62
  readonly input: DeleteScheduledQueryCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteScheduledQueryCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteScheduledQueryCommandInput, DeleteScheduledQueryCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeEndpointsRequest, DescribeEndpointsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEndpointsCommand}.
8
10
  */
9
11
  export interface DescribeEndpointsCommandInput extends DescribeEndpointsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEndpointsCommand}.
13
17
  */
14
18
  export interface DescribeEndpointsCommandOutput extends DescribeEndpointsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>DescribeEndpoints returns a list of available endpoints to make Timestream
18
23
  * API calls against. This API is available through both Write and Query.</p>
19
24
  * <p>Because the Timestream SDKs are designed to transparently work with the
@@ -45,6 +50,8 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param DescribeEndpointsCommandInput - {@link DescribeEndpointsCommandInput}
54
+ * @returns {@link DescribeEndpointsCommandOutput}
48
55
  * @see {@link DescribeEndpointsCommandInput} for command's `input` shape.
49
56
  * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape.
50
57
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -65,11 +72,20 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
65
72
  export declare class DescribeEndpointsCommand extends $Command<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, TimestreamQueryClientResolvedConfig> {
66
73
  readonly input: DescribeEndpointsCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: DescribeEndpointsCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeScheduledQueryRequest, DescribeScheduledQueryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeScheduledQueryCommand}.
8
10
  */
9
11
  export interface DescribeScheduledQueryCommandInput extends DescribeScheduledQueryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeScheduledQueryCommand}.
13
17
  */
14
18
  export interface DescribeScheduledQueryCommandOutput extends DescribeScheduledQueryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides detailed information about a scheduled query.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeScheduledQueryCommandOutput extends DescribeScheduledQu
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeScheduledQueryCommandInput - {@link DescribeScheduledQueryCommandInput}
34
+ * @returns {@link DescribeScheduledQueryCommandOutput}
28
35
  * @see {@link DescribeScheduledQueryCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeScheduledQueryCommandOutput} for command's `response` shape.
30
37
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DescribeScheduledQueryCommandOutput extends DescribeScheduledQu
54
61
  export declare class DescribeScheduledQueryCommand extends $Command<DescribeScheduledQueryCommandInput, DescribeScheduledQueryCommandOutput, TimestreamQueryClientResolvedConfig> {
55
62
  readonly input: DescribeScheduledQueryCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DescribeScheduledQueryCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeScheduledQueryCommandInput, DescribeScheduledQueryCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ExecuteScheduledQueryRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ExecuteScheduledQueryCommand}.
8
10
  */
9
11
  export interface ExecuteScheduledQueryCommandInput extends ExecuteScheduledQueryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ExecuteScheduledQueryCommand}.
13
17
  */
14
18
  export interface ExecuteScheduledQueryCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> You can use this API to run a scheduled query manually. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ExecuteScheduledQueryCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ExecuteScheduledQueryCommandInput - {@link ExecuteScheduledQueryCommandInput}
34
+ * @returns {@link ExecuteScheduledQueryCommandOutput}
28
35
  * @see {@link ExecuteScheduledQueryCommandInput} for command's `input` shape.
29
36
  * @see {@link ExecuteScheduledQueryCommandOutput} for command's `response` shape.
30
37
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -54,11 +61,20 @@ export interface ExecuteScheduledQueryCommandOutput extends __MetadataBearer {
54
61
  export declare class ExecuteScheduledQueryCommand extends $Command<ExecuteScheduledQueryCommandInput, ExecuteScheduledQueryCommandOutput, TimestreamQueryClientResolvedConfig> {
55
62
  readonly input: ExecuteScheduledQueryCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: ExecuteScheduledQueryCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteScheduledQueryCommandInput, ExecuteScheduledQueryCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListScheduledQueriesRequest, ListScheduledQueriesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListScheduledQueriesCommand}.
8
10
  */
9
11
  export interface ListScheduledQueriesCommandInput extends ListScheduledQueriesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListScheduledQueriesCommand}.
13
17
  */
14
18
  export interface ListScheduledQueriesCommandOutput extends ListScheduledQueriesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a list of all scheduled queries in the caller's Amazon account and Region. <code>ListScheduledQueries</code> is eventually consistent. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListScheduledQueriesCommandOutput extends ListScheduledQueriesR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListScheduledQueriesCommandInput - {@link ListScheduledQueriesCommandInput}
34
+ * @returns {@link ListScheduledQueriesCommandOutput}
28
35
  * @see {@link ListScheduledQueriesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListScheduledQueriesCommandOutput} for command's `response` shape.
30
37
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -51,11 +58,20 @@ export interface ListScheduledQueriesCommandOutput extends ListScheduledQueriesR
51
58
  export declare class ListScheduledQueriesCommand extends $Command<ListScheduledQueriesCommandInput, ListScheduledQueriesCommandOutput, TimestreamQueryClientResolvedConfig> {
52
59
  readonly input: ListScheduledQueriesCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: ListScheduledQueriesCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListScheduledQueriesCommandInput, ListScheduledQueriesCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all tags on a Timestream query resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
46
53
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, TimestreamQueryClientResolvedConfig> {
47
54
  readonly input: ListTagsForResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListTagsForResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PrepareQueryRequest, PrepareQueryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PrepareQueryCommand}.
8
10
  */
9
11
  export interface PrepareQueryCommandInput extends PrepareQueryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PrepareQueryCommand}.
13
17
  */
14
18
  export interface PrepareQueryCommandOutput extends PrepareQueryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>A synchronous operation that allows you to submit a query with parameters to be stored
18
23
  * by Timestream for later running. Timestream only supports using this operation with the
19
24
  * <code>PrepareQueryRequest$ValidateOnly</code> set to <code>true</code>. </p>
@@ -27,6 +32,8 @@ export interface PrepareQueryCommandOutput extends PrepareQueryResponse, __Metad
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param PrepareQueryCommandInput - {@link PrepareQueryCommandInput}
36
+ * @returns {@link PrepareQueryCommandOutput}
30
37
  * @see {@link PrepareQueryCommandInput} for command's `input` shape.
31
38
  * @see {@link PrepareQueryCommandOutput} for command's `response` shape.
32
39
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -53,11 +60,20 @@ export interface PrepareQueryCommandOutput extends PrepareQueryResponse, __Metad
53
60
  export declare class PrepareQueryCommand extends $Command<PrepareQueryCommandInput, PrepareQueryCommandOutput, TimestreamQueryClientResolvedConfig> {
54
61
  readonly input: PrepareQueryCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: PrepareQueryCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PrepareQueryCommandInput, PrepareQueryCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }