@aws-sdk/client-forecastquery 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.
Files changed (7) hide show
  1. package/dist-types/Forecastquery.d.ts +3 -0
  2. package/dist-types/ForecastqueryClient.d.ts +24 -4
  3. package/dist-types/commands/QueryForecastCommand.d.ts +16 -0
  4. package/dist-types/commands/QueryWhatIfForecastCommand.d.ts +16 -0
  5. package/dist-types/models/ForecastqueryServiceException.d.ts +2 -0
  6. package/dist-types/models/models_0.d.ts +21 -2
  7. package/package.json +29 -29
package/dist-types/Forecastquery.d.ts CHANGED
@@ -3,10 +3,12 @@ import { QueryForecastCommandInput, QueryForecastCommandOutput } from "./command
3
3
  import { QueryWhatIfForecastCommandInput, QueryWhatIfForecastCommandOutput } from "./commands/QueryWhatIfForecastCommand";
4
4
  import { ForecastqueryClient } from "./ForecastqueryClient";
5
5
  /**
6
+ * @public
6
7
  * <p>Provides APIs for creating and managing Amazon Forecast resources.</p>
7
8
  */
8
9
  export declare class Forecastquery extends ForecastqueryClient {
9
10
  /**
11
+ * @public
10
12
  * <p>Retrieves a forecast for a single item, filtered by the supplied criteria.</p>
11
13
  * <p>The criteria is a key-value pair. The key is either <code>item_id</code> (or the
12
14
  * equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset,
@@ -24,6 +26,7 @@ export declare class Forecastquery extends ForecastqueryClient {
24
26
  queryForecast(args: QueryForecastCommandInput, cb: (err: any, data?: QueryForecastCommandOutput) => void): void;
25
27
  queryForecast(args: QueryForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryForecastCommandOutput) => void): void;
26
28
  /**
29
+ * @public
27
30
  * <p>Retrieves a what-if forecast.</p>
28
31
  */
29
32
  queryWhatIfForecast(args: QueryWhatIfForecastCommandInput, options?: __HttpHandlerOptions): Promise<QueryWhatIfForecastCommandOutput>;
package/dist-types/ForecastqueryClient.d.ts CHANGED
@@ -10,15 +10,24 @@ import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as
10
10
  import { QueryForecastCommandInput, QueryForecastCommandOutput } from "./commands/QueryForecastCommand";
11
11
  import { QueryWhatIfForecastCommandInput, QueryWhatIfForecastCommandOutput } from "./commands/QueryWhatIfForecastCommand";
12
12
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
13
+ /**
14
+ * @public
15
+ */
13
16
  export type ServiceInputTypes = QueryForecastCommandInput | QueryWhatIfForecastCommandInput;
17
+ /**
18
+ * @public
19
+ */
14
20
  export type ServiceOutputTypes = QueryForecastCommandOutput | QueryWhatIfForecastCommandOutput;
21
+ /**
22
+ * @public
23
+ */
15
24
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
16
25
  /**
17
26
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
18
27
  */
19
28
  requestHandler?: __HttpHandler;
20
29
  /**
21
- * A constructor for a class implementing the {@link __Checksum} interface
30
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
22
31
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
23
32
  * @internal
24
33
  */
@@ -108,23 +117,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
108
117
  */
109
118
  logger?: __Logger;
110
119
  /**
111
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
120
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
112
121
  */
113
122
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
114
123
  }
124
+ /**
125
+ * @public
126
+ */
115
127
  type ForecastqueryClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
116
128
  /**
117
- * The configuration interface of ForecastqueryClient class constructor that set the region, credentials and other options.
129
+ * @public
130
+ *
131
+ * The configuration interface of ForecastqueryClient class constructor that set the region, credentials and other options.
118
132
  */
119
133
  export interface ForecastqueryClientConfig extends ForecastqueryClientConfigType {
120
134
  }
135
+ /**
136
+ * @public
137
+ */
121
138
  type ForecastqueryClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
122
139
  /**
123
- * The resolved configuration interface of ForecastqueryClient class. This is resolved and normalized from the {@link ForecastqueryClientConfig | constructor configuration interface}.
140
+ * @public
141
+ *
142
+ * The resolved configuration interface of ForecastqueryClient class. This is resolved and normalized from the {@link ForecastqueryClientConfig | constructor configuration interface}.
124
143
  */
125
144
  export interface ForecastqueryClientResolvedConfig extends ForecastqueryClientResolvedConfigType {
126
145
  }
127
146
  /**
147
+ * @public
128
148
  * <p>Provides APIs for creating and managing Amazon Forecast resources.</p>
129
149
  */
130
150
  export declare class ForecastqueryClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ForecastqueryClientResolvedConfig> {
package/dist-types/commands/QueryForecastCommand.d.ts CHANGED
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastqueryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastqueryClient";
5
5
  import { QueryForecastRequest, QueryForecastResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link QueryForecastCommand}.
8
10
  */
9
11
  export interface QueryForecastCommandInput extends QueryForecastRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link QueryForecastCommand}.
13
17
  */
14
18
  export interface QueryForecastCommandOutput extends QueryForecastResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a forecast for a single item, filtered by the supplied criteria.</p>
18
23
  * <p>The criteria is a key-value pair. The key is either <code>item_id</code> (or the
19
24
  * equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset,
@@ -36,6 +41,8 @@ export interface QueryForecastCommandOutput extends QueryForecastResponse, __Met
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param QueryForecastCommandInput - {@link QueryForecastCommandInput}
45
+ * @returns {@link QueryForecastCommandOutput}
39
46
  * @see {@link QueryForecastCommandInput} for command's `input` shape.
40
47
  * @see {@link QueryForecastCommandOutput} for command's `response` shape.
41
48
  * @see {@link ForecastqueryClientResolvedConfig | config} for ForecastqueryClient's `config` shape.
@@ -61,11 +68,20 @@ export interface QueryForecastCommandOutput extends QueryForecastResponse, __Met
61
68
  export declare class QueryForecastCommand extends $Command<QueryForecastCommandInput, QueryForecastCommandOutput, ForecastqueryClientResolvedConfig> {
62
69
  readonly input: QueryForecastCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: QueryForecastCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastqueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<QueryForecastCommandInput, QueryForecastCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
package/dist-types/commands/QueryWhatIfForecastCommand.d.ts CHANGED
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastqueryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastqueryClient";
5
5
  import { QueryWhatIfForecastRequest, QueryWhatIfForecastResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link QueryWhatIfForecastCommand}.
8
10
  */
9
11
  export interface QueryWhatIfForecastCommandInput extends QueryWhatIfForecastRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link QueryWhatIfForecastCommand}.
13
17
  */
14
18
  export interface QueryWhatIfForecastCommandOutput extends QueryWhatIfForecastResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a what-if forecast.</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 QueryWhatIfForecastCommandOutput extends QueryWhatIfForecastRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param QueryWhatIfForecastCommandInput - {@link QueryWhatIfForecastCommandInput}
34
+ * @returns {@link QueryWhatIfForecastCommandOutput}
28
35
  * @see {@link QueryWhatIfForecastCommandInput} for command's `input` shape.
29
36
  * @see {@link QueryWhatIfForecastCommandOutput} for command's `response` shape.
30
37
  * @see {@link ForecastqueryClientResolvedConfig | config} for ForecastqueryClient's `config` shape.
@@ -50,11 +57,20 @@ export interface QueryWhatIfForecastCommandOutput extends QueryWhatIfForecastRes
50
57
  export declare class QueryWhatIfForecastCommand extends $Command<QueryWhatIfForecastCommandInput, QueryWhatIfForecastCommandOutput, ForecastqueryClientResolvedConfig> {
51
58
  readonly input: QueryWhatIfForecastCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: QueryWhatIfForecastCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastqueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<QueryWhatIfForecastCommandInput, QueryWhatIfForecastCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
package/dist-types/models/ForecastqueryServiceException.d.ts CHANGED
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from Forecastquery service.
4
6
  */
5
7
  export declare class ForecastqueryServiceException extends __ServiceException {
package/dist-types/models/models_0.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ForecastqueryServiceException as __BaseException } from "./ForecastqueryServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>The value is invalid or is too long.</p>
5
6
  */
6
7
  export declare class InvalidInputException extends __BaseException {
@@ -13,6 +14,7 @@ export declare class InvalidInputException extends __BaseException {
13
14
  constructor(opts: __ExceptionOptionType<InvalidInputException, __BaseException>);
14
15
  }
15
16
  /**
17
+ * @public
16
18
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
17
19
  */
18
20
  export declare class InvalidNextTokenException extends __BaseException {
@@ -25,6 +27,7 @@ export declare class InvalidNextTokenException extends __BaseException {
25
27
  constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
26
28
  }
27
29
  /**
30
+ * @public
28
31
  * <p>The limit on the number of requests per second has been exceeded.</p>
29
32
  */
30
33
  export declare class LimitExceededException extends __BaseException {
@@ -36,6 +39,9 @@ export declare class LimitExceededException extends __BaseException {
36
39
  */
37
40
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
38
41
  }
42
+ /**
43
+ * @public
44
+ */
39
45
  export interface QueryForecastRequest {
40
46
  /**
41
47
  * <p>The Amazon Resource Name (ARN) of the forecast to query.</p>
@@ -56,7 +62,7 @@ export interface QueryForecastRequest {
56
62
  * forecast for <code>client_21</code> in the electricity usage dataset, specify the
57
63
  * following:</p>
58
64
  * <p>
59
- * <code>{"item_id" : "client_21"}</code>
65
+ * <code>\{"item_id" : "client_21"\}</code>
60
66
  * </p>
61
67
  *
62
68
  *
@@ -71,6 +77,7 @@ export interface QueryForecastRequest {
71
77
  NextToken?: string;
72
78
  }
73
79
  /**
80
+ * @public
74
81
  * <p>The forecast value for a specific date. Part of the <a>Forecast</a>
75
82
  * object.</p>
76
83
  */
@@ -85,6 +92,7 @@ export interface DataPoint {
85
92
  Value?: number;
86
93
  }
87
94
  /**
95
+ * @public
88
96
  * <p>Provides information about a forecast. Returned as part of the <a>QueryForecast</a> response.</p>
89
97
  */
90
98
  export interface Forecast {
@@ -108,6 +116,9 @@ export interface Forecast {
108
116
  */
109
117
  Predictions?: Record<string, DataPoint[]>;
110
118
  }
119
+ /**
120
+ * @public
121
+ */
111
122
  export interface QueryForecastResponse {
112
123
  /**
113
124
  * <p>The forecast.</p>
@@ -115,6 +126,7 @@ export interface QueryForecastResponse {
115
126
  Forecast?: Forecast;
116
127
  }
117
128
  /**
129
+ * @public
118
130
  * <p>The specified resource is in use.</p>
119
131
  */
120
132
  export declare class ResourceInUseException extends __BaseException {
@@ -127,6 +139,7 @@ export declare class ResourceInUseException extends __BaseException {
127
139
  constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
128
140
  }
129
141
  /**
142
+ * @public
130
143
  * <p>We can't find that resource. Check the information that you've provided and try
131
144
  * again.</p>
132
145
  */
@@ -139,6 +152,9 @@ export declare class ResourceNotFoundException extends __BaseException {
139
152
  */
140
153
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
141
154
  }
155
+ /**
156
+ * @public
157
+ */
142
158
  export interface QueryWhatIfForecastRequest {
143
159
  /**
144
160
  * <p>The Amazon Resource Name (ARN) of the what-if forecast to query.</p>
@@ -159,7 +175,7 @@ export interface QueryWhatIfForecastRequest {
159
175
  * forecast for <code>client_21</code> in the electricity usage dataset, specify the
160
176
  * following:</p>
161
177
  * <p>
162
- * <code>{"item_id" : "client_21"}</code>
178
+ * <code>\{"item_id" : "client_21"\}</code>
163
179
  * </p>
164
180
  * <p>To get the full what-if forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html">CreateForecastExportJob</a> operation.</p>
165
181
  */
@@ -171,6 +187,9 @@ export interface QueryWhatIfForecastRequest {
171
187
  */
172
188
  NextToken?: string;
173
189
  }
190
+ /**
191
+ * @public
192
+ */
174
193
  export interface QueryWhatIfForecastResponse {
175
194
  /**
176
195
  * <p>Provides information about a forecast. Returned as part of the <a>QueryForecast</a> response.</p>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-forecastquery",
3
3
  "description": "AWS SDK for JavaScript Forecastquery Client for Node.js, Browser and React Native",
4
- "version": "3.295.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },