@aws-sdk/client-forecastquery 3.35.0 → 3.36.0

package/src/ForecastqueryClient.ts

@@ -1,237 +0,0 @@
-import {
-  EndpointsInputConfig,
-  EndpointsResolvedConfig,
-  RegionInputConfig,
-  RegionResolvedConfig,
-  resolveEndpointsConfig,
-  resolveRegionConfig,
-} from "@aws-sdk/config-resolver";
-import { getContentLengthPlugin } from "@aws-sdk/middleware-content-length";
-import {
-  getHostHeaderPlugin,
-  HostHeaderInputConfig,
-  HostHeaderResolvedConfig,
-  resolveHostHeaderConfig,
-} from "@aws-sdk/middleware-host-header";
-import { getLoggerPlugin } from "@aws-sdk/middleware-logger";
-import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry";
-import {
-  AwsAuthInputConfig,
-  AwsAuthResolvedConfig,
-  getAwsAuthPlugin,
-  resolveAwsAuthConfig,
-} from "@aws-sdk/middleware-signing";
-import {
-  getUserAgentPlugin,
-  resolveUserAgentConfig,
-  UserAgentInputConfig,
-  UserAgentResolvedConfig,
-} from "@aws-sdk/middleware-user-agent";
-import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
-import {
-  Client as __Client,
-  SmithyConfiguration as __SmithyConfiguration,
-  SmithyResolvedConfiguration as __SmithyResolvedConfiguration,
-} from "@aws-sdk/smithy-client";
-import {
-  Credentials as __Credentials,
-  Decoder as __Decoder,
-  Encoder as __Encoder,
-  Hash as __Hash,
-  HashConstructor as __HashConstructor,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  Logger as __Logger,
-  Provider as __Provider,
-  Provider,
-  RegionInfoProvider,
-  StreamCollector as __StreamCollector,
-  UrlParser as __UrlParser,
-  UserAgent as __UserAgent,
-} from "@aws-sdk/types";
-
-import { QueryForecastCommandInput, QueryForecastCommandOutput } from "./commands/QueryForecastCommand";
-import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
-
-export type ServiceInputTypes = QueryForecastCommandInput;
-
-export type ServiceOutputTypes = QueryForecastCommandOutput;
-
-export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
-  /**
-   * The HTTP handler to use. Fetch in browser and Https in Nodejs.
-   */
-  requestHandler?: __HttpHandler;
-
-  /**
-   * A constructor for a class implementing the {@link __Hash} interface
-   * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
-   * @internal
-   */
-  sha256?: __HashConstructor;
-
-  /**
-   * The function that will be used to convert strings into HTTP endpoints.
-   * @internal
-   */
-  urlParser?: __UrlParser;
-
-  /**
-   * A function that can calculate the length of a request body.
-   * @internal
-   */
-  bodyLengthChecker?: (body: any) => number | undefined;
-
-  /**
-   * A function that converts a stream into an array of bytes.
-   * @internal
-   */
-  streamCollector?: __StreamCollector;
-
-  /**
-   * The function that will be used to convert a base64-encoded string to a byte array.
-   * @internal
-   */
-  base64Decoder?: __Decoder;
-
-  /**
-   * The function that will be used to convert binary data to a base64-encoded string.
-   * @internal
-   */
-  base64Encoder?: __Encoder;
-
-  /**
-   * The function that will be used to convert a UTF8-encoded string to a byte array.
-   * @internal
-   */
-  utf8Decoder?: __Decoder;
-
-  /**
-   * The function that will be used to convert binary data to a UTF-8 encoded string.
-   * @internal
-   */
-  utf8Encoder?: __Encoder;
-
-  /**
-   * The runtime environment.
-   * @internal
-   */
-  runtime?: string;
-
-  /**
-   * Disable dyanamically changing the endpoint of the client based on the hostPrefix
-   * trait of an operation.
-   */
-  disableHostPrefix?: boolean;
-
-  /**
-   * Value for how many times a request will be made at most in case of retry.
-   */
-  maxAttempts?: number | __Provider<number>;
-
-  /**
-   * Specifies which retry algorithm to use.
-   */
-  retryMode?: string | __Provider<string>;
-
-  /**
-   * Optional logger for logging debug/info/warn/error.
-   */
-  logger?: __Logger;
-
-  /**
-   * Unique service identifier.
-   * @internal
-   */
-  serviceId?: string;
-
-  /**
-   * The AWS region to which this client will send requests
-   */
-  region?: string | __Provider<string>;
-
-  /**
-   * Default credentials provider; Not available in browser runtime.
-   * @internal
-   */
-  credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
-
-  /**
-   * Fetch related hostname, signing name or signing region with given region.
-   * @internal
-   */
-  regionInfoProvider?: RegionInfoProvider;
-
-  /**
-   * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
-   * @internal
-   */
-  defaultUserAgentProvider?: Provider<__UserAgent>;
-}
-
-type ForecastqueryClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
-  ClientDefaults &
-  RegionInputConfig &
-  EndpointsInputConfig &
-  RetryInputConfig &
-  HostHeaderInputConfig &
-  AwsAuthInputConfig &
-  UserAgentInputConfig;
-/**
- * The configuration interface of ForecastqueryClient class constructor that set the region, credentials and other options.
- */
-export interface ForecastqueryClientConfig extends ForecastqueryClientConfigType {}
-
-type ForecastqueryClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
-  Required<ClientDefaults> &
-  RegionResolvedConfig &
-  EndpointsResolvedConfig &
-  RetryResolvedConfig &
-  HostHeaderResolvedConfig &
-  AwsAuthResolvedConfig &
-  UserAgentResolvedConfig;
-/**
- * The resolved configuration interface of ForecastqueryClient class. This is resolved and normalized from the {@link ForecastqueryClientConfig | constructor configuration interface}.
- */
-export interface ForecastqueryClientResolvedConfig extends ForecastqueryClientResolvedConfigType {}
-
-/**
- * <p>Provides APIs for creating and managing Amazon Forecast resources.</p>
- */
-export class ForecastqueryClient extends __Client<
-  __HttpHandlerOptions,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-  ForecastqueryClientResolvedConfig
-> {
-  /**
-   * The resolved configuration of ForecastqueryClient class. This is resolved and normalized from the {@link ForecastqueryClientConfig | constructor configuration interface}.
-   */
-  readonly config: ForecastqueryClientResolvedConfig;
-
-  constructor(configuration: ForecastqueryClientConfig) {
-    const _config_0 = __getRuntimeConfig(configuration);
-    const _config_1 = resolveRegionConfig(_config_0);
-    const _config_2 = resolveEndpointsConfig(_config_1);
-    const _config_3 = resolveRetryConfig(_config_2);
-    const _config_4 = resolveHostHeaderConfig(_config_3);
-    const _config_5 = resolveAwsAuthConfig(_config_4);
-    const _config_6 = resolveUserAgentConfig(_config_5);
-    super(_config_6);
-    this.config = _config_6;
-    this.middlewareStack.use(getRetryPlugin(this.config));
-    this.middlewareStack.use(getContentLengthPlugin(this.config));
-    this.middlewareStack.use(getHostHeaderPlugin(this.config));
-    this.middlewareStack.use(getLoggerPlugin(this.config));
-    this.middlewareStack.use(getAwsAuthPlugin(this.config));
-    this.middlewareStack.use(getUserAgentPlugin(this.config));
-  }
-
-  /**
-   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
-   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
-   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
-   */
-  destroy(): void {
-    super.destroy();
-  }
-}

package/src/commands/QueryForecastCommand.ts

@@ -1,106 +0,0 @@
-import { getSerdePlugin } from "@aws-sdk/middleware-serde";
-import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  FinalizeHandlerArguments,
-  Handler,
-  HandlerExecutionContext,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-  SerdeContext as __SerdeContext,
-} from "@aws-sdk/types";
-
-import { ForecastqueryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastqueryClient";
-import { QueryForecastRequest, QueryForecastResponse } from "../models/models_0";
-import {
-  deserializeAws_json1_1QueryForecastCommand,
-  serializeAws_json1_1QueryForecastCommand,
-} from "../protocols/Aws_json1_1";
-
-export interface QueryForecastCommandInput extends QueryForecastRequest {}
-export interface QueryForecastCommandOutput extends QueryForecastResponse, __MetadataBearer {}
-
-/**
- * <p>Retrieves a forecast for a single item, filtered by the supplied criteria.</p>
- *          <p>The criteria is a key-value pair. The key is either <code>item_id</code> (or the
- *       equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset,
- *       or one of the forecast dimensions specified as part of the <code>FeaturizationConfig</code>
- *       object.</p>
- *          <p>By default, <code>QueryForecast</code> returns the complete date range for the filtered
- *       forecast. You can request a specific date range.</p>
- *          <p>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</p>
- *          <note>
- *             <p>The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was
- *         used to create the predictor.</p>
- *          </note>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { ForecastqueryClient, QueryForecastCommand } from "@aws-sdk/client-forecastquery"; // ES Modules import
- * // const { ForecastqueryClient, QueryForecastCommand } = require("@aws-sdk/client-forecastquery"); // CommonJS import
- * const client = new ForecastqueryClient(config);
- * const command = new QueryForecastCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link QueryForecastCommandInput} for command's `input` shape.
- * @see {@link QueryForecastCommandOutput} for command's `response` shape.
- * @see {@link ForecastqueryClientResolvedConfig | config} for command's `input` shape.
- *
- */
-export class QueryForecastCommand extends $Command<
-  QueryForecastCommandInput,
-  QueryForecastCommandOutput,
-  ForecastqueryClientResolvedConfig
-> {
-  // Start section: command_properties
-  // End section: command_properties
-
-  constructor(readonly input: QueryForecastCommandInput) {
-    // Start section: command_constructor
-    super();
-    // End section: command_constructor
-  }
-
-  /**
-   * @internal
-   */
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: ForecastqueryClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<QueryForecastCommandInput, QueryForecastCommandOutput> {
-    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
-
-    const stack = clientStack.concat(this.middlewareStack);
-
-    const { logger } = configuration;
-    const clientName = "ForecastqueryClient";
-    const commandName = "QueryForecastCommand";
-    const handlerExecutionContext: HandlerExecutionContext = {
-      logger,
-      clientName,
-      commandName,
-      inputFilterSensitiveLog: QueryForecastRequest.filterSensitiveLog,
-      outputFilterSensitiveLog: QueryForecastResponse.filterSensitiveLog,
-    };
-    const { requestHandler } = configuration;
-    return stack.resolve(
-      (request: FinalizeHandlerArguments<any>) =>
-        requestHandler.handle(request.request as __HttpRequest, options || {}),
-      handlerExecutionContext
-    );
-  }
-
-  private serialize(input: QueryForecastCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
-    return serializeAws_json1_1QueryForecastCommand(input, context);
-  }
-
-  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<QueryForecastCommandOutput> {
-    return deserializeAws_json1_1QueryForecastCommand(output, context);
-  }
-
-  // Start section: command_body_extra
-  // End section: command_body_extra
-}

package/src/endpoints.ts

@@ -1,73 +0,0 @@
-import { getRegionInfo, PartitionHash, RegionHash } from "@aws-sdk/config-resolver";
-import { RegionInfoProvider } from "@aws-sdk/types";
-
-const regionHash: RegionHash = {
-  "fips-us-east-1": {
-    hostname: "forecastquery-fips.us-east-1.amazonaws.com",
-    signingRegion: "us-east-1",
-  },
-  "fips-us-east-2": {
-    hostname: "forecastquery-fips.us-east-2.amazonaws.com",
-    signingRegion: "us-east-2",
-  },
-  "fips-us-west-2": {
-    hostname: "forecastquery-fips.us-west-2.amazonaws.com",
-    signingRegion: "us-west-2",
-  },
-};
-
-const partitionHash: PartitionHash = {
-  aws: {
-    regions: [
-      "af-south-1",
-      "ap-east-1",
-      "ap-northeast-1",
-      "ap-northeast-2",
-      "ap-northeast-3",
-      "ap-south-1",
-      "ap-southeast-1",
-      "ap-southeast-2",
-      "ca-central-1",
-      "eu-central-1",
-      "eu-north-1",
-      "eu-south-1",
-      "eu-west-1",
-      "eu-west-2",
-      "eu-west-3",
-      "fips-us-east-1",
-      "fips-us-east-2",
-      "fips-us-west-2",
-      "me-south-1",
-      "sa-east-1",
-      "us-east-1",
-      "us-east-2",
-      "us-west-1",
-      "us-west-2",
-    ],
-    hostname: "forecastquery.{region}.amazonaws.com",
-  },
-  "aws-cn": {
-    regions: ["cn-north-1", "cn-northwest-1"],
-    hostname: "forecastquery.{region}.amazonaws.com.cn",
-  },
-  "aws-iso": {
-    regions: ["us-iso-east-1"],
-    hostname: "forecastquery.{region}.c2s.ic.gov",
-  },
-  "aws-iso-b": {
-    regions: ["us-isob-east-1"],
-    hostname: "forecastquery.{region}.sc2s.sgov.gov",
-  },
-  "aws-us-gov": {
-    regions: ["us-gov-east-1", "us-gov-west-1"],
-    hostname: "forecastquery.{region}.amazonaws.com",
-  },
-};
-
-export const defaultRegionInfoProvider: RegionInfoProvider = async (region: string, options?: any) =>
-  getRegionInfo(region, {
-    ...options,
-    signingService: "forecast",
-    regionHash,
-    partitionHash,
-  });

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from "./ForecastqueryClient";
-export * from "./Forecastquery";
-export * from "./commands/QueryForecastCommand";
-export * from "./models/index";

package/src/models/index.ts

@@ -1 +0,0 @@
-export * from "./models_0";

package/src/models/models_0.ts

@@ -1,213 +0,0 @@
-import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
-
-/**
- * <p>The value is invalid or is too long.</p>
- */
-export interface InvalidInputException extends __SmithyException, $MetadataBearer {
-  name: "InvalidInputException";
-  $fault: "client";
-  Message?: string;
-}
-
-export namespace InvalidInputException {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: InvalidInputException): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>The token is not valid. Tokens expire after 24 hours.</p>
- */
-export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
-  name: "InvalidNextTokenException";
-  $fault: "client";
-  Message?: string;
-}
-
-export namespace InvalidNextTokenException {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>The limit on the number of requests per second has been exceeded.</p>
- */
-export interface LimitExceededException extends __SmithyException, $MetadataBearer {
-  name: "LimitExceededException";
-  $fault: "client";
-  Message?: string;
-}
-
-export namespace LimitExceededException {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: LimitExceededException): any => ({
-    ...obj,
-  });
-}
-
-export interface QueryForecastRequest {
-  /**
-   * <p>The Amazon Resource Name (ARN) of the forecast to query.</p>
-   */
-  ForecastArn: string | undefined;
-
-  /**
-   * <p>The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss
-   *       (ISO 8601 format). For example, 2015-01-01T08:00:00.</p>
-   */
-  StartDate?: string;
-
-  /**
-   * <p>The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss
-   *       (ISO 8601 format). For example, 2015-01-01T20:00:00. </p>
-   */
-  EndDate?: string;
-
-  /**
-   * <p>The filtering criteria to apply when retrieving the forecast. For example, to get the
-   *       forecast for <code>client_21</code> in the electricity usage dataset, specify the
-   *       following:</p>
-   *          <p>
-   *             <code>{"item_id" : "client_21"}</code>
-   *          </p>
-   *
-   *
-   *          <p>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</p>
-   */
-  Filters: { [key: string]: string } | undefined;
-
-  /**
-   * <p>If the result of the previous request was truncated, the response includes a
-   *         <code>NextToken</code>. To retrieve the next set of results, use the token in the next
-   *       request. Tokens expire after 24 hours.</p>
-   */
-  NextToken?: string;
-}
-
-export namespace QueryForecastRequest {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: QueryForecastRequest): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>The forecast value for a specific date. Part of the <a>Forecast</a>
- *       object.</p>
- */
-export interface DataPoint {
-  /**
-   * <p>The timestamp of the specific forecast.</p>
-   */
-  Timestamp?: string;
-
-  /**
-   * <p>The forecast value.</p>
-   */
-  Value?: number;
-}
-
-export namespace DataPoint {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: DataPoint): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>Provides information about a forecast. Returned as part of the <a>QueryForecast</a> response.</p>
- */
-export interface Forecast {
-  /**
-   * <p>The forecast.</p>
-   *          <p>The <i>string</i> of the string-to-array map is one of the following
-   *       values:</p>
-   *          <ul>
-   *             <li>
-   *                <p>p10</p>
-   *             </li>
-   *             <li>
-   *                <p>p50</p>
-   *             </li>
-   *             <li>
-   *                <p>p90</p>
-   *             </li>
-   *          </ul>
-   */
-  Predictions?: { [key: string]: DataPoint[] };
-}
-
-export namespace Forecast {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: Forecast): any => ({
-    ...obj,
-  });
-}
-
-export interface QueryForecastResponse {
-  /**
-   * <p>The forecast.</p>
-   */
-  Forecast?: Forecast;
-}
-
-export namespace QueryForecastResponse {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: QueryForecastResponse): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>The specified resource is in use.</p>
- */
-export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
-  name: "ResourceInUseException";
-  $fault: "client";
-  Message?: string;
-}
-
-export namespace ResourceInUseException {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: ResourceInUseException): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>We can't find that resource. Check the information that you've provided and try
- *       again.</p>
- */
-export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
-  name: "ResourceNotFoundException";
-  $fault: "client";
-  Message?: string;
-}
-
-export namespace ResourceNotFoundException {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
-    ...obj,
-  });
-}