@aws-sdk/client-iotsitewise 3.34.0 → 3.35.0

package/dist-types/IoTSiteWiseClient.d.ts

@@ -0,0 +1,193 @@
+import { EndpointsInputConfig, EndpointsResolvedConfig, RegionInputConfig, RegionResolvedConfig } from "@aws-sdk/config-resolver";
+import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
+import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry";
+import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
+import { 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, 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 { AssociateAssetsCommandInput, AssociateAssetsCommandOutput } from "./commands/AssociateAssetsCommand";
+import { BatchAssociateProjectAssetsCommandInput, BatchAssociateProjectAssetsCommandOutput } from "./commands/BatchAssociateProjectAssetsCommand";
+import { BatchDisassociateProjectAssetsCommandInput, BatchDisassociateProjectAssetsCommandOutput } from "./commands/BatchDisassociateProjectAssetsCommand";
+import { BatchPutAssetPropertyValueCommandInput, BatchPutAssetPropertyValueCommandOutput } from "./commands/BatchPutAssetPropertyValueCommand";
+import { CreateAccessPolicyCommandInput, CreateAccessPolicyCommandOutput } from "./commands/CreateAccessPolicyCommand";
+import { CreateAssetCommandInput, CreateAssetCommandOutput } from "./commands/CreateAssetCommand";
+import { CreateAssetModelCommandInput, CreateAssetModelCommandOutput } from "./commands/CreateAssetModelCommand";
+import { CreateDashboardCommandInput, CreateDashboardCommandOutput } from "./commands/CreateDashboardCommand";
+import { CreateGatewayCommandInput, CreateGatewayCommandOutput } from "./commands/CreateGatewayCommand";
+import { CreatePortalCommandInput, CreatePortalCommandOutput } from "./commands/CreatePortalCommand";
+import { CreateProjectCommandInput, CreateProjectCommandOutput } from "./commands/CreateProjectCommand";
+import { DeleteAccessPolicyCommandInput, DeleteAccessPolicyCommandOutput } from "./commands/DeleteAccessPolicyCommand";
+import { DeleteAssetCommandInput, DeleteAssetCommandOutput } from "./commands/DeleteAssetCommand";
+import { DeleteAssetModelCommandInput, DeleteAssetModelCommandOutput } from "./commands/DeleteAssetModelCommand";
+import { DeleteDashboardCommandInput, DeleteDashboardCommandOutput } from "./commands/DeleteDashboardCommand";
+import { DeleteGatewayCommandInput, DeleteGatewayCommandOutput } from "./commands/DeleteGatewayCommand";
+import { DeletePortalCommandInput, DeletePortalCommandOutput } from "./commands/DeletePortalCommand";
+import { DeleteProjectCommandInput, DeleteProjectCommandOutput } from "./commands/DeleteProjectCommand";
+import { DescribeAccessPolicyCommandInput, DescribeAccessPolicyCommandOutput } from "./commands/DescribeAccessPolicyCommand";
+import { DescribeAssetCommandInput, DescribeAssetCommandOutput } from "./commands/DescribeAssetCommand";
+import { DescribeAssetModelCommandInput, DescribeAssetModelCommandOutput } from "./commands/DescribeAssetModelCommand";
+import { DescribeAssetPropertyCommandInput, DescribeAssetPropertyCommandOutput } from "./commands/DescribeAssetPropertyCommand";
+import { DescribeDashboardCommandInput, DescribeDashboardCommandOutput } from "./commands/DescribeDashboardCommand";
+import { DescribeDefaultEncryptionConfigurationCommandInput, DescribeDefaultEncryptionConfigurationCommandOutput } from "./commands/DescribeDefaultEncryptionConfigurationCommand";
+import { DescribeGatewayCapabilityConfigurationCommandInput, DescribeGatewayCapabilityConfigurationCommandOutput } from "./commands/DescribeGatewayCapabilityConfigurationCommand";
+import { DescribeGatewayCommandInput, DescribeGatewayCommandOutput } from "./commands/DescribeGatewayCommand";
+import { DescribeLoggingOptionsCommandInput, DescribeLoggingOptionsCommandOutput } from "./commands/DescribeLoggingOptionsCommand";
+import { DescribePortalCommandInput, DescribePortalCommandOutput } from "./commands/DescribePortalCommand";
+import { DescribeProjectCommandInput, DescribeProjectCommandOutput } from "./commands/DescribeProjectCommand";
+import { DescribeStorageConfigurationCommandInput, DescribeStorageConfigurationCommandOutput } from "./commands/DescribeStorageConfigurationCommand";
+import { DisassociateAssetsCommandInput, DisassociateAssetsCommandOutput } from "./commands/DisassociateAssetsCommand";
+import { GetAssetPropertyAggregatesCommandInput, GetAssetPropertyAggregatesCommandOutput } from "./commands/GetAssetPropertyAggregatesCommand";
+import { GetAssetPropertyValueCommandInput, GetAssetPropertyValueCommandOutput } from "./commands/GetAssetPropertyValueCommand";
+import { GetAssetPropertyValueHistoryCommandInput, GetAssetPropertyValueHistoryCommandOutput } from "./commands/GetAssetPropertyValueHistoryCommand";
+import { GetInterpolatedAssetPropertyValuesCommandInput, GetInterpolatedAssetPropertyValuesCommandOutput } from "./commands/GetInterpolatedAssetPropertyValuesCommand";
+import { ListAccessPoliciesCommandInput, ListAccessPoliciesCommandOutput } from "./commands/ListAccessPoliciesCommand";
+import { ListAssetModelsCommandInput, ListAssetModelsCommandOutput } from "./commands/ListAssetModelsCommand";
+import { ListAssetRelationshipsCommandInput, ListAssetRelationshipsCommandOutput } from "./commands/ListAssetRelationshipsCommand";
+import { ListAssetsCommandInput, ListAssetsCommandOutput } from "./commands/ListAssetsCommand";
+import { ListAssociatedAssetsCommandInput, ListAssociatedAssetsCommandOutput } from "./commands/ListAssociatedAssetsCommand";
+import { ListDashboardsCommandInput, ListDashboardsCommandOutput } from "./commands/ListDashboardsCommand";
+import { ListGatewaysCommandInput, ListGatewaysCommandOutput } from "./commands/ListGatewaysCommand";
+import { ListPortalsCommandInput, ListPortalsCommandOutput } from "./commands/ListPortalsCommand";
+import { ListProjectAssetsCommandInput, ListProjectAssetsCommandOutput } from "./commands/ListProjectAssetsCommand";
+import { ListProjectsCommandInput, ListProjectsCommandOutput } from "./commands/ListProjectsCommand";
+import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
+import { PutDefaultEncryptionConfigurationCommandInput, PutDefaultEncryptionConfigurationCommandOutput } from "./commands/PutDefaultEncryptionConfigurationCommand";
+import { PutLoggingOptionsCommandInput, PutLoggingOptionsCommandOutput } from "./commands/PutLoggingOptionsCommand";
+import { PutStorageConfigurationCommandInput, PutStorageConfigurationCommandOutput } from "./commands/PutStorageConfigurationCommand";
+import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
+import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
+import { UpdateAccessPolicyCommandInput, UpdateAccessPolicyCommandOutput } from "./commands/UpdateAccessPolicyCommand";
+import { UpdateAssetCommandInput, UpdateAssetCommandOutput } from "./commands/UpdateAssetCommand";
+import { UpdateAssetModelCommandInput, UpdateAssetModelCommandOutput } from "./commands/UpdateAssetModelCommand";
+import { UpdateAssetPropertyCommandInput, UpdateAssetPropertyCommandOutput } from "./commands/UpdateAssetPropertyCommand";
+import { UpdateDashboardCommandInput, UpdateDashboardCommandOutput } from "./commands/UpdateDashboardCommand";
+import { UpdateGatewayCapabilityConfigurationCommandInput, UpdateGatewayCapabilityConfigurationCommandOutput } from "./commands/UpdateGatewayCapabilityConfigurationCommand";
+import { UpdateGatewayCommandInput, UpdateGatewayCommandOutput } from "./commands/UpdateGatewayCommand";
+import { UpdatePortalCommandInput, UpdatePortalCommandOutput } from "./commands/UpdatePortalCommand";
+import { UpdateProjectCommandInput, UpdateProjectCommandOutput } from "./commands/UpdateProjectCommand";
+export declare type ServiceInputTypes = AssociateAssetsCommandInput | BatchAssociateProjectAssetsCommandInput | BatchDisassociateProjectAssetsCommandInput | BatchPutAssetPropertyValueCommandInput | CreateAccessPolicyCommandInput | CreateAssetCommandInput | CreateAssetModelCommandInput | CreateDashboardCommandInput | CreateGatewayCommandInput | CreatePortalCommandInput | CreateProjectCommandInput | DeleteAccessPolicyCommandInput | DeleteAssetCommandInput | DeleteAssetModelCommandInput | DeleteDashboardCommandInput | DeleteGatewayCommandInput | DeletePortalCommandInput | DeleteProjectCommandInput | DescribeAccessPolicyCommandInput | DescribeAssetCommandInput | DescribeAssetModelCommandInput | DescribeAssetPropertyCommandInput | DescribeDashboardCommandInput | DescribeDefaultEncryptionConfigurationCommandInput | DescribeGatewayCapabilityConfigurationCommandInput | DescribeGatewayCommandInput | DescribeLoggingOptionsCommandInput | DescribePortalCommandInput | DescribeProjectCommandInput | DescribeStorageConfigurationCommandInput | DisassociateAssetsCommandInput | GetAssetPropertyAggregatesCommandInput | GetAssetPropertyValueCommandInput | GetAssetPropertyValueHistoryCommandInput | GetInterpolatedAssetPropertyValuesCommandInput | ListAccessPoliciesCommandInput | ListAssetModelsCommandInput | ListAssetRelationshipsCommandInput | ListAssetsCommandInput | ListAssociatedAssetsCommandInput | ListDashboardsCommandInput | ListGatewaysCommandInput | ListPortalsCommandInput | ListProjectAssetsCommandInput | ListProjectsCommandInput | ListTagsForResourceCommandInput | PutDefaultEncryptionConfigurationCommandInput | PutLoggingOptionsCommandInput | PutStorageConfigurationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccessPolicyCommandInput | UpdateAssetCommandInput | UpdateAssetModelCommandInput | UpdateAssetPropertyCommandInput | UpdateDashboardCommandInput | UpdateGatewayCapabilityConfigurationCommandInput | UpdateGatewayCommandInput | UpdatePortalCommandInput | UpdateProjectCommandInput;
+export declare type ServiceOutputTypes = AssociateAssetsCommandOutput | BatchAssociateProjectAssetsCommandOutput | BatchDisassociateProjectAssetsCommandOutput | BatchPutAssetPropertyValueCommandOutput | CreateAccessPolicyCommandOutput | CreateAssetCommandOutput | CreateAssetModelCommandOutput | CreateDashboardCommandOutput | CreateGatewayCommandOutput | CreatePortalCommandOutput | CreateProjectCommandOutput | DeleteAccessPolicyCommandOutput | DeleteAssetCommandOutput | DeleteAssetModelCommandOutput | DeleteDashboardCommandOutput | DeleteGatewayCommandOutput | DeletePortalCommandOutput | DeleteProjectCommandOutput | DescribeAccessPolicyCommandOutput | DescribeAssetCommandOutput | DescribeAssetModelCommandOutput | DescribeAssetPropertyCommandOutput | DescribeDashboardCommandOutput | DescribeDefaultEncryptionConfigurationCommandOutput | DescribeGatewayCapabilityConfigurationCommandOutput | DescribeGatewayCommandOutput | DescribeLoggingOptionsCommandOutput | DescribePortalCommandOutput | DescribeProjectCommandOutput | DescribeStorageConfigurationCommandOutput | DisassociateAssetsCommandOutput | GetAssetPropertyAggregatesCommandOutput | GetAssetPropertyValueCommandOutput | GetAssetPropertyValueHistoryCommandOutput | GetInterpolatedAssetPropertyValuesCommandOutput | ListAccessPoliciesCommandOutput | ListAssetModelsCommandOutput | ListAssetRelationshipsCommandOutput | ListAssetsCommandOutput | ListAssociatedAssetsCommandOutput | ListDashboardsCommandOutput | ListGatewaysCommandOutput | ListPortalsCommandOutput | ListProjectAssetsCommandOutput | ListProjectsCommandOutput | ListTagsForResourceCommandOutput | PutDefaultEncryptionConfigurationCommandOutput | PutLoggingOptionsCommandOutput | PutStorageConfigurationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccessPolicyCommandOutput | UpdateAssetCommandOutput | UpdateAssetModelCommandOutput | UpdateAssetPropertyCommandOutput | UpdateDashboardCommandOutput | UpdateGatewayCapabilityConfigurationCommandOutput | UpdateGatewayCommandOutput | UpdatePortalCommandOutput | UpdateProjectCommandOutput;
+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>;
+}
+declare type IoTSiteWiseClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
+/**
+ * The configuration interface of IoTSiteWiseClient class constructor that set the region, credentials and other options.
+ */
+export interface IoTSiteWiseClientConfig extends IoTSiteWiseClientConfigType {
+}
+declare type IoTSiteWiseClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
+/**
+ * The resolved configuration interface of IoTSiteWiseClient class. This is resolved and normalized from the {@link IoTSiteWiseClientConfig | constructor configuration interface}.
+ */
+export interface IoTSiteWiseClientResolvedConfig extends IoTSiteWiseClientResolvedConfigType {
+}
+/**
+ * <p>Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects <a href="https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications">Industrial Internet of Things (IIoT)</a> devices to the power of the Amazon Web Services Cloud. For more information, see the
+ *       <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/">IoT SiteWise User Guide</a>. For information about IoT SiteWise quotas, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
+ */
+export declare class IoTSiteWiseClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IoTSiteWiseClientResolvedConfig> {
+    /**
+     * The resolved configuration of IoTSiteWiseClient class. This is resolved and normalized from the {@link IoTSiteWiseClientConfig | constructor configuration interface}.
+     */
+    readonly config: IoTSiteWiseClientResolvedConfig;
+    constructor(configuration: IoTSiteWiseClientConfig);
+    /**
+     * 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;
+}
+export {};

package/dist-types/commands/AssociateAssetsCommand.d.ts

@@ -0,0 +1,37 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { AssociateAssetsRequest } from "../models/models_0";
+export interface AssociateAssetsCommandInput extends AssociateAssetsRequest {
+}
+export interface AssociateAssetsCommandOutput extends __MetadataBearer {
+}
+/**
+ * <p>Associates a child asset with the given parent asset through a hierarchy defined in the
+ *       parent asset's model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html">Associating assets</a> in the
+ *         <i>IoT SiteWise User Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, AssociateAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, AssociateAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const command = new AssociateAssetsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link AssociateAssetsCommandInput} for command's `input` shape.
+ * @see {@link AssociateAssetsCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class AssociateAssetsCommand extends $Command<AssociateAssetsCommandInput, AssociateAssetsCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: AssociateAssetsCommandInput;
+    constructor(input: AssociateAssetsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateAssetsCommandInput, AssociateAssetsCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts

@@ -0,0 +1,35 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { BatchAssociateProjectAssetsRequest, BatchAssociateProjectAssetsResponse } from "../models/models_0";
+export interface BatchAssociateProjectAssetsCommandInput extends BatchAssociateProjectAssetsRequest {
+}
+export interface BatchAssociateProjectAssetsCommandOutput extends BatchAssociateProjectAssetsResponse, __MetadataBearer {
+}
+/**
+ * <p>Associates a group (batch) of assets with an IoT SiteWise Monitor project.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, BatchAssociateProjectAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, BatchAssociateProjectAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const command = new BatchAssociateProjectAssetsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link BatchAssociateProjectAssetsCommandInput} for command's `input` shape.
+ * @see {@link BatchAssociateProjectAssetsCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class BatchAssociateProjectAssetsCommand extends $Command<BatchAssociateProjectAssetsCommandInput, BatchAssociateProjectAssetsCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: BatchAssociateProjectAssetsCommandInput;
+    constructor(input: BatchAssociateProjectAssetsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchAssociateProjectAssetsCommandInput, BatchAssociateProjectAssetsCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/BatchDisassociateProjectAssetsCommand.d.ts

@@ -0,0 +1,35 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { BatchDisassociateProjectAssetsRequest, BatchDisassociateProjectAssetsResponse } from "../models/models_0";
+export interface BatchDisassociateProjectAssetsCommandInput extends BatchDisassociateProjectAssetsRequest {
+}
+export interface BatchDisassociateProjectAssetsCommandOutput extends BatchDisassociateProjectAssetsResponse, __MetadataBearer {
+}
+/**
+ * <p>Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, BatchDisassociateProjectAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, BatchDisassociateProjectAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const command = new BatchDisassociateProjectAssetsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link BatchDisassociateProjectAssetsCommandInput} for command's `input` shape.
+ * @see {@link BatchDisassociateProjectAssetsCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class BatchDisassociateProjectAssetsCommand extends $Command<BatchDisassociateProjectAssetsCommandInput, BatchDisassociateProjectAssetsCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: BatchDisassociateProjectAssetsCommandInput;
+    constructor(input: BatchDisassociateProjectAssetsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDisassociateProjectAssetsCommandInput, BatchDisassociateProjectAssetsCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/BatchPutAssetPropertyValueCommand.d.ts

@@ -0,0 +1,59 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { BatchPutAssetPropertyValueRequest, BatchPutAssetPropertyValueResponse } from "../models/models_0";
+export interface BatchPutAssetPropertyValueCommandInput extends BatchPutAssetPropertyValueRequest {
+}
+export interface BatchPutAssetPropertyValueCommandOutput extends BatchPutAssetPropertyValueResponse, __MetadataBearer {
+}
+/**
+ * <p>Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value
+ *       (TQV) data point. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html">Ingesting data using the API</a> in the
+ *         <i>IoT SiteWise User Guide</i>.</p>
+ *          <p>To identify an asset property, you must specify one of the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The <code>assetId</code> and <code>propertyId</code> of an asset property.</p>
+ *             </li>
+ *             <li>
+ *                <p>A <code>propertyAlias</code>, which is a data stream alias (for example,
+ *           <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
+ *             </li>
+ *          </ul>
+ *          <important>
+ *             <p>With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more
+ *         than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps
+ *         outside of the inclusive range of [-7 days, +10 minutes] and returns a
+ *           <code>TimestampOutOfRangeException</code> error.</p>
+ *             <p>For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer
+ *         TQV has a different quality. For example, if you store a TQV <code>{T1, GOOD, V1}</code>,
+ *         then storing <code>{T1, GOOD, V2}</code> replaces the existing TQV.</p>
+ *          </important>
+ *          <p>IoT SiteWise authorizes access to each <code>BatchPutAssetPropertyValue</code> entry individually.
+ *       For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action">BatchPutAssetPropertyValue authorization</a> in the
+ *       <i>IoT SiteWise User Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, BatchPutAssetPropertyValueCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, BatchPutAssetPropertyValueCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const command = new BatchPutAssetPropertyValueCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link BatchPutAssetPropertyValueCommandInput} for command's `input` shape.
+ * @see {@link BatchPutAssetPropertyValueCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class BatchPutAssetPropertyValueCommand extends $Command<BatchPutAssetPropertyValueCommandInput, BatchPutAssetPropertyValueCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: BatchPutAssetPropertyValueCommandInput;
+    constructor(input: BatchPutAssetPropertyValueCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchPutAssetPropertyValueCommandInput, BatchPutAssetPropertyValueCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/CreateAccessPolicyCommand.d.ts

@@ -0,0 +1,36 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { CreateAccessPolicyRequest, CreateAccessPolicyResponse } from "../models/models_0";
+export interface CreateAccessPolicyCommandInput extends CreateAccessPolicyRequest {
+}
+export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyResponse, __MetadataBearer {
+}
+/**
+ * <p>Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or
+ *       IAM user) access to the specified IoT SiteWise Monitor portal or project resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, CreateAccessPolicyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, CreateAccessPolicyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const command = new CreateAccessPolicyCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CreateAccessPolicyCommandInput} for command's `input` shape.
+ * @see {@link CreateAccessPolicyCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class CreateAccessPolicyCommand extends $Command<CreateAccessPolicyCommandInput, CreateAccessPolicyCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: CreateAccessPolicyCommandInput;
+    constructor(input: CreateAccessPolicyCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAccessPolicyCommandInput, CreateAccessPolicyCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/CreateAssetCommand.d.ts

@@ -0,0 +1,36 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { CreateAssetRequest, CreateAssetResponse } from "../models/models_0";
+export interface CreateAssetCommandInput extends CreateAssetRequest {
+}
+export interface CreateAssetCommandOutput extends CreateAssetResponse, __MetadataBearer {
+}
+/**
+ * <p>Creates an asset from an existing asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html">Creating assets</a> in the
+ *         <i>IoT SiteWise User Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, CreateAssetCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, CreateAssetCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const command = new CreateAssetCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CreateAssetCommandInput} for command's `input` shape.
+ * @see {@link CreateAssetCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class CreateAssetCommand extends $Command<CreateAssetCommandInput, CreateAssetCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: CreateAssetCommandInput;
+    constructor(input: CreateAssetCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAssetCommandInput, CreateAssetCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/CreateAssetModelCommand.d.ts

@@ -0,0 +1,39 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { CreateAssetModelRequest, CreateAssetModelResponse } from "../models/models_0";
+export interface CreateAssetModelCommandInput extends CreateAssetModelRequest {
+}
+export interface CreateAssetModelCommandOutput extends CreateAssetModelResponse, __MetadataBearer {
+}
+/**
+ * <p>Creates an asset model from specified property and hierarchy definitions. You create
+ *       assets from asset models. With asset models, you can easily create assets of the same type
+ *       that have standardized definitions. Each asset created from a model inherits the asset model's
+ *       property and hierarchy definitions. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html">Defining asset models</a> in the
+ *         <i>IoT SiteWise User Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, CreateAssetModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, CreateAssetModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const command = new CreateAssetModelCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CreateAssetModelCommandInput} for command's `input` shape.
+ * @see {@link CreateAssetModelCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class CreateAssetModelCommand extends $Command<CreateAssetModelCommandInput, CreateAssetModelCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: CreateAssetModelCommandInput;
+    constructor(input: CreateAssetModelCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAssetModelCommandInput, CreateAssetModelCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/CreateDashboardCommand.d.ts

@@ -0,0 +1,35 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { CreateDashboardRequest, CreateDashboardResponse } from "../models/models_0";
+export interface CreateDashboardCommandInput extends CreateDashboardRequest {
+}
+export interface CreateDashboardCommandOutput extends CreateDashboardResponse, __MetadataBearer {
+}
+/**
+ * <p>Creates a dashboard in an IoT SiteWise Monitor project.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, CreateDashboardCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, CreateDashboardCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const command = new CreateDashboardCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CreateDashboardCommandInput} for command's `input` shape.
+ * @see {@link CreateDashboardCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class CreateDashboardCommand extends $Command<CreateDashboardCommandInput, CreateDashboardCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: CreateDashboardCommandInput;
+    constructor(input: CreateDashboardCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDashboardCommandInput, CreateDashboardCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/CreateGatewayCommand.d.ts

@@ -0,0 +1,37 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { CreateGatewayRequest, CreateGatewayResponse } from "../models/models_0";
+export interface CreateGatewayCommandInput extends CreateGatewayRequest {
+}
+export interface CreateGatewayCommandOutput extends CreateGatewayResponse, __MetadataBearer {
+}
+/**
+ * <p>Creates a gateway, which is a virtual or edge device that delivers industrial data streams
+ *       from local servers to IoT SiteWise. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html">Ingesting data using a gateway</a> in the
+ *         <i>IoT SiteWise User Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, CreateGatewayCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, CreateGatewayCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const command = new CreateGatewayCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CreateGatewayCommandInput} for command's `input` shape.
+ * @see {@link CreateGatewayCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class CreateGatewayCommand extends $Command<CreateGatewayCommandInput, CreateGatewayCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: CreateGatewayCommandInput;
+    constructor(input: CreateGatewayCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGatewayCommandInput, CreateGatewayCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/CreatePortalCommand.d.ts

@@ -0,0 +1,41 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { CreatePortalRequest, CreatePortalResponse } from "../models/models_0";
+export interface CreatePortalCommandInput extends CreatePortalRequest {
+}
+export interface CreatePortalCommandOutput extends CreatePortalResponse, __MetadataBearer {
+}
+/**
+ * <p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services SSO or IAM
+ *       to authenticate portal users and manage user permissions.</p>
+ *          <note>
+ *             <p>Before you can sign in to a new portal, you must add at least one identity to that
+ *         portal. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins">Adding or removing portal
+ *           administrators</a> in the <i>IoT SiteWise User Guide</i>.</p>
+ *          </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, CreatePortalCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, CreatePortalCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const command = new CreatePortalCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CreatePortalCommandInput} for command's `input` shape.
+ * @see {@link CreatePortalCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class CreatePortalCommand extends $Command<CreatePortalCommandInput, CreatePortalCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: CreatePortalCommandInput;
+    constructor(input: CreatePortalCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePortalCommandInput, CreatePortalCommandOutput>;
+    private serialize;
+    private deserialize;
+}