@aws-sdk/client-iottwinmaker 3.300.0 → 3.303.0

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

@@ -26,140 +26,90 @@ export interface UpdateEntityCommandOutput extends UpdateEntityResponse, __Metad
  * import { IoTTwinMakerClient, UpdateEntityCommand } from "@aws-sdk/client-iottwinmaker"; // ES Modules import
  * // const { IoTTwinMakerClient, UpdateEntityCommand } = require("@aws-sdk/client-iottwinmaker"); // CommonJS import
  * const client = new IoTTwinMakerClient(config);
- * const input = {
+ * const input = { // UpdateEntityRequest
  *   workspaceId: "STRING_VALUE", // required
  *   entityId: "STRING_VALUE", // required
  *   entityName: "STRING_VALUE",
  *   description: "STRING_VALUE",
- *   componentUpdates: {
- *     "<keys>": {
+ *   componentUpdates: { // ComponentUpdatesMapRequest
+ *     "<keys>": { // ComponentUpdateRequest
  *       updateType: "STRING_VALUE",
  *       description: "STRING_VALUE",
  *       componentTypeId: "STRING_VALUE",
- *       propertyUpdates: {
- *         "<keys>": {
- *           definition: {
- *             dataType: {
+ *       propertyUpdates: { // PropertyRequests
+ *         "<keys>": { // PropertyRequest
+ *           definition: { // PropertyDefinitionRequest
+ *             dataType: { // DataType
  *               type: "STRING_VALUE", // required
  *               nestedType: {
  *                 type: "STRING_VALUE", // required
- *                 nestedType: {
- *                   type: "<DataType>",
- *                   nestedType: "<DataType>",
- *                   allowedValues: [
- *                     {
- *                       booleanValue: true || false,
- *                       doubleValue: Number("double"),
- *                       integerValue: Number("int"),
- *                       longValue: Number("long"),
- *                       stringValue: "STRING_VALUE",
- *                       listValue: [
- *                         {
- *                           booleanValue: true || false,
- *                           doubleValue: Number("double"),
- *                           integerValue: Number("int"),
- *                           longValue: Number("long"),
- *                           stringValue: "STRING_VALUE",
- *                           listValue: [
- *                             "<DataValueList>",
- *                           ],
- *                           mapValue: {
- *                             "<keys>": {
- *                               booleanValue: "<DataValue>",
- *                               doubleValue: "<DataValue>",
- *                               integerValue: "<DataValue>",
- *                               longValue: "<DataValue>",
- *                               stringValue: "<DataValue>",
- *                               listValue: "<DataValue>",
- *                               mapValue: {
- *                                 "<keys>": {
- *                                   booleanValue: "<DataValue>",
- *                                   doubleValue: "<DataValue>",
- *                                   integerValue: "<DataValue>",
- *                                   longValue: "<DataValue>",
- *                                   stringValue: "<DataValue>",
- *                                   listValue: "<DataValue>",
- *                                   mapValue: "<DataValue>",
- *                                   relationshipValue: {
- *                                     targetEntityId: "STRING_VALUE",
- *                                     targetComponentName: "STRING_VALUE",
- *                                   },
- *                                   expression: "STRING_VALUE",
- *                                 },
- *                               },
- *                               relationshipValue: {
- *                                 targetEntityId: "STRING_VALUE",
- *                                 targetComponentName: "STRING_VALUE",
- *                               },
- *                               expression: "STRING_VALUE",
- *                             },
- *                           },
- *                           relationshipValue: "<DataValue>",
- *                           expression: "<DataValue>",
+ *                 nestedType: "<DataType>",
+ *                 allowedValues: [ // DataValueList
+ *                   { // DataValue
+ *                     booleanValue: true || false,
+ *                     doubleValue: Number("double"),
+ *                     integerValue: Number("int"),
+ *                     longValue: Number("long"),
+ *                     stringValue: "STRING_VALUE",
+ *                     listValue: [
+ *                       {
+ *                         booleanValue: true || false,
+ *                         doubleValue: Number("double"),
+ *                         integerValue: Number("int"),
+ *                         longValue: Number("long"),
+ *                         stringValue: "STRING_VALUE",
+ *                         listValue: "<DataValueList>",
+ *                         mapValue: { // DataValueMap
+ *                           "<keys>": "<DataValue>",
  *                         },
- *                       ],
- *                       mapValue: "<DataValue>",
- *                       relationshipValue: "<DataValue>",
- *                       expression: "<DataValue>",
+ *                         relationshipValue: { // RelationshipValue
+ *                           targetEntityId: "STRING_VALUE",
+ *                           targetComponentName: "STRING_VALUE",
+ *                         },
+ *                         expression: "STRING_VALUE",
+ *                       },
+ *                     ],
+ *                     mapValue: {
+ *                       "<keys>": "<DataValue>",
+ *                     },
+ *                     relationshipValue: {
+ *                       targetEntityId: "STRING_VALUE",
+ *                       targetComponentName: "STRING_VALUE",
  *                     },
- *                   ],
- *                   unitOfMeasure: "STRING_VALUE",
- *                   relationship: {
- *                     targetComponentTypeId: "STRING_VALUE",
- *                     relationshipType: "STRING_VALUE",
+ *                     expression: "STRING_VALUE",
  *                   },
- *                 },
- *                 allowedValues: [
- *                   "<DataValueList>",
  *                 ],
  *                 unitOfMeasure: "STRING_VALUE",
- *                 relationship: {
+ *                 relationship: { // Relationship
  *                   targetComponentTypeId: "STRING_VALUE",
  *                   relationshipType: "STRING_VALUE",
  *                 },
  *               },
- *               allowedValues: "<DataType>",
- *               unitOfMeasure: "<DataType>",
- *               relationship: "<DataType>",
+ *               allowedValues: "<DataValueList>",
+ *               unitOfMeasure: "STRING_VALUE",
+ *               relationship: {
+ *                 targetComponentTypeId: "STRING_VALUE",
+ *                 relationshipType: "STRING_VALUE",
+ *               },
  *             },
  *             isRequiredInEntity: true || false,
  *             isExternalId: true || false,
  *             isStoredExternally: true || false,
  *             isTimeSeries: true || false,
- *             defaultValue: {
- *               booleanValue: "<DataValue>",
- *               doubleValue: "<DataValue>",
- *               integerValue: "<DataValue>",
- *               longValue: "<DataValue>",
- *               stringValue: "<DataValue>",
- *               listValue: "<DataValue>",
- *               mapValue: "<DataValue>",
- *               relationshipValue: "<DataValue>",
- *               expression: "<DataValue>",
- *             },
- *             configuration: {
+ *             defaultValue: "<DataValue>",
+ *             configuration: { // Configuration
  *               "<keys>": "STRING_VALUE",
  *             },
  *             displayName: "STRING_VALUE",
  *           },
- *           value: {
- *             booleanValue: "<DataValue>",
- *             doubleValue: "<DataValue>",
- *             integerValue: "<DataValue>",
- *             longValue: "<DataValue>",
- *             stringValue: "<DataValue>",
- *             listValue: "<DataValue>",
- *             mapValue: "<DataValue>",
- *             relationshipValue: "<DataValue>",
- *             expression: "<DataValue>",
- *           },
+ *           value: "<DataValue>",
  *           updateType: "STRING_VALUE",
  *         },
  *       },
- *       propertyGroupUpdates: {
- *         "<keys>": {
+ *       propertyGroupUpdates: { // ComponentPropertyGroupRequests
+ *         "<keys>": { // ComponentPropertyGroupRequest
  *           groupType: "STRING_VALUE",
- *           propertyNames: [
+ *           propertyNames: [ // PropertyNames
  *             "STRING_VALUE",
  *           ],
  *           updateType: "STRING_VALUE",
@@ -167,7 +117,7 @@ export interface UpdateEntityCommandOutput extends UpdateEntityResponse, __Metad
  *       },
  *     },
  *   },
- *   parentEntityUpdate: {
+ *   parentEntityUpdate: { // ParentEntityUpdateRequest
  *     updateType: "STRING_VALUE", // required
  *     parentEntityId: "STRING_VALUE",
  *   },

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

@@ -26,9 +26,9 @@ export interface UpdatePricingPlanCommandOutput extends UpdatePricingPlanRespons
  * import { IoTTwinMakerClient, UpdatePricingPlanCommand } from "@aws-sdk/client-iottwinmaker"; // ES Modules import
  * // const { IoTTwinMakerClient, UpdatePricingPlanCommand } = require("@aws-sdk/client-iottwinmaker"); // CommonJS import
  * const client = new IoTTwinMakerClient(config);
- * const input = {
+ * const input = { // UpdatePricingPlanRequest
  *   pricingMode: "STRING_VALUE", // required
- *   bundleNames: [
+ *   bundleNames: [ // PricingBundles
  *     "STRING_VALUE",
  *   ],
  * };

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

@@ -26,15 +26,15 @@ export interface UpdateSceneCommandOutput extends UpdateSceneResponse, __Metadat
  * import { IoTTwinMakerClient, UpdateSceneCommand } from "@aws-sdk/client-iottwinmaker"; // ES Modules import
  * // const { IoTTwinMakerClient, UpdateSceneCommand } = require("@aws-sdk/client-iottwinmaker"); // CommonJS import
  * const client = new IoTTwinMakerClient(config);
- * const input = {
+ * const input = { // UpdateSceneRequest
  *   workspaceId: "STRING_VALUE", // required
  *   sceneId: "STRING_VALUE", // required
  *   contentLocation: "STRING_VALUE",
  *   description: "STRING_VALUE",
- *   capabilities: [
+ *   capabilities: [ // SceneCapabilities
  *     "STRING_VALUE",
  *   ],
- *   sceneMetadata: {
+ *   sceneMetadata: { // SceneMetadataMap
  *     "<keys>": "STRING_VALUE",
  *   },
  * };

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

@@ -26,7 +26,7 @@ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, _
  * import { IoTTwinMakerClient, UpdateWorkspaceCommand } from "@aws-sdk/client-iottwinmaker"; // ES Modules import
  * // const { IoTTwinMakerClient, UpdateWorkspaceCommand } = require("@aws-sdk/client-iottwinmaker"); // CommonJS import
  * const client = new IoTTwinMakerClient(config);
- * const input = {
+ * const input = { // UpdateWorkspaceRequest
  *   workspaceId: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
  *   role: "STRING_VALUE",

package/dist-types/models/models_0.d.ts

@@ -137,11 +137,16 @@ export interface DataConnector {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum Scope {
-    ENTITY = "ENTITY",
-    WORKSPACE = "WORKSPACE"
-}
+export declare const Scope: {
+    readonly ENTITY: "ENTITY";
+    readonly WORKSPACE: "WORKSPACE";
+};
+/**
+ * @public
+ */
+export type Scope = (typeof Scope)[keyof typeof Scope];
 /**
  * @public
  * <p>The function request body.</p>
@@ -176,23 +181,33 @@ export interface Relationship {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum Type {
-    BOOLEAN = "BOOLEAN",
-    DOUBLE = "DOUBLE",
-    INTEGER = "INTEGER",
-    LIST = "LIST",
-    LONG = "LONG",
-    MAP = "MAP",
-    RELATIONSHIP = "RELATIONSHIP",
-    STRING = "STRING"
-}
+export declare const Type: {
+    readonly BOOLEAN: "BOOLEAN";
+    readonly DOUBLE: "DOUBLE";
+    readonly INTEGER: "INTEGER";
+    readonly LIST: "LIST";
+    readonly LONG: "LONG";
+    readonly MAP: "MAP";
+    readonly RELATIONSHIP: "RELATIONSHIP";
+    readonly STRING: "STRING";
+};
 /**
  * @public
  */
-export declare enum GroupType {
-    TABULAR = "TABULAR"
-}
+export type Type = (typeof Type)[keyof typeof Type];
+/**
+ * @public
+ * @enum
+ */
+export declare const GroupType: {
+    readonly TABULAR: "TABULAR";
+};
+/**
+ * @public
+ */
+export type GroupType = (typeof GroupType)[keyof typeof GroupType];
 /**
  * @public
  * <p/>
@@ -209,14 +224,19 @@ export interface PropertyGroupRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum State {
-    ACTIVE = "ACTIVE",
-    CREATING = "CREATING",
-    DELETING = "DELETING",
-    ERROR = "ERROR",
-    UPDATING = "UPDATING"
-}
+export declare const State: {
+    readonly ACTIVE: "ACTIVE";
+    readonly CREATING: "CREATING";
+    readonly DELETING: "DELETING";
+    readonly ERROR: "ERROR";
+    readonly UPDATING: "UPDATING";
+};
+/**
+ * @public
+ */
+export type State = (typeof State)[keyof typeof State];
 /**
  * @public
  */
@@ -248,20 +268,30 @@ export declare class ServiceQuotaExceededException extends __BaseException {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum PropertyUpdateType {
-    CREATE = "CREATE",
-    DELETE = "DELETE",
-    UPDATE = "UPDATE"
-}
+export declare const PropertyUpdateType: {
+    readonly CREATE: "CREATE";
+    readonly DELETE: "DELETE";
+    readonly UPDATE: "UPDATE";
+};
 /**
  * @public
  */
-export declare enum PropertyGroupUpdateType {
-    CREATE = "CREATE",
-    DELETE = "DELETE",
-    UPDATE = "UPDATE"
-}
+export type PropertyUpdateType = (typeof PropertyUpdateType)[keyof typeof PropertyUpdateType];
+/**
+ * @public
+ * @enum
+ */
+export declare const PropertyGroupUpdateType: {
+    readonly CREATE: "CREATE";
+    readonly DELETE: "DELETE";
+    readonly UPDATE: "UPDATE";
+};
+/**
+ * @public
+ */
+export type PropertyGroupUpdateType = (typeof PropertyGroupUpdateType)[keyof typeof PropertyGroupUpdateType];
 /**
  * @public
  * <p>The component property group request.</p>
@@ -374,14 +404,19 @@ export interface CreateSyncJobRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum SyncJobState {
-    ACTIVE = "ACTIVE",
-    CREATING = "CREATING",
-    DELETING = "DELETING",
-    ERROR = "ERROR",
-    INITIALIZING = "INITIALIZING"
-}
+export declare const SyncJobState: {
+    readonly ACTIVE: "ACTIVE";
+    readonly CREATING: "CREATING";
+    readonly DELETING: "DELETING";
+    readonly ERROR: "ERROR";
+    readonly INITIALIZING: "INITIALIZING";
+};
+/**
+ * @public
+ */
+export type SyncJobState = (typeof SyncJobState)[keyof typeof SyncJobState];
 /**
  * @public
  */
@@ -567,12 +602,17 @@ export interface ExecuteQueryRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum ColumnType {
-    EDGE = "EDGE",
-    NODE = "NODE",
-    VALUE = "VALUE"
-}
+export declare const ColumnType: {
+    readonly EDGE: "EDGE";
+    readonly NODE: "NODE";
+    readonly VALUE: "VALUE";
+};
+/**
+ * @public
+ */
+export type ColumnType = (typeof ColumnType)[keyof typeof ColumnType];
 /**
  * @public
  * <p>A description of the column in the query results.</p>
@@ -683,14 +723,19 @@ export interface PropertyGroupResponse {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum ErrorCode {
-    INTERNAL_FAILURE = "INTERNAL_FAILURE",
-    SYNC_CREATING_ERROR = "SYNC_CREATING_ERROR",
-    SYNC_INITIALIZING_ERROR = "SYNC_INITIALIZING_ERROR",
-    SYNC_PROCESSING_ERROR = "SYNC_PROCESSING_ERROR",
-    VALIDATION_ERROR = "VALIDATION_ERROR"
-}
+export declare const ErrorCode: {
+    readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
+    readonly SYNC_CREATING_ERROR: "SYNC_CREATING_ERROR";
+    readonly SYNC_INITIALIZING_ERROR: "SYNC_INITIALIZING_ERROR";
+    readonly SYNC_PROCESSING_ERROR: "SYNC_PROCESSING_ERROR";
+    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
+};
+/**
+ * @public
+ */
+export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
 /**
  * @public
  * <p>The error details.</p>
@@ -759,13 +804,18 @@ export interface GetPricingPlanRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum PricingTier {
-    TIER_1 = "TIER_1",
-    TIER_2 = "TIER_2",
-    TIER_3 = "TIER_3",
-    TIER_4 = "TIER_4"
-}
+export declare const PricingTier: {
+    readonly TIER_1: "TIER_1";
+    readonly TIER_2: "TIER_2";
+    readonly TIER_3: "TIER_3";
+    readonly TIER_4: "TIER_4";
+};
+/**
+ * @public
+ */
+export type PricingTier = (typeof PricingTier)[keyof typeof PricingTier];
 /**
  * @public
  * <p>Information about the pricing bundle.</p>
@@ -782,22 +832,32 @@ export interface BundleInformation {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum PricingMode {
-    BASIC = "BASIC",
-    STANDARD = "STANDARD",
-    TIERED_BUNDLE = "TIERED_BUNDLE"
-}
+export declare const PricingMode: {
+    readonly BASIC: "BASIC";
+    readonly STANDARD: "STANDARD";
+    readonly TIERED_BUNDLE: "TIERED_BUNDLE";
+};
 /**
  * @public
  */
-export declare enum UpdateReason {
-    DEFAULT = "DEFAULT",
-    ENTITY_COUNT_UPDATE = "ENTITY_COUNT_UPDATE",
-    OVERWRITTEN = "OVERWRITTEN",
-    PRICING_MODE_UPDATE = "PRICING_MODE_UPDATE",
-    PRICING_TIER_UPDATE = "PRICING_TIER_UPDATE"
-}
+export type PricingMode = (typeof PricingMode)[keyof typeof PricingMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const UpdateReason: {
+    readonly DEFAULT: "DEFAULT";
+    readonly ENTITY_COUNT_UPDATE: "ENTITY_COUNT_UPDATE";
+    readonly OVERWRITTEN: "OVERWRITTEN";
+    readonly PRICING_MODE_UPDATE: "PRICING_MODE_UPDATE";
+    readonly PRICING_TIER_UPDATE: "PRICING_TIER_UPDATE";
+};
+/**
+ * @public
+ */
+export type UpdateReason = (typeof UpdateReason)[keyof typeof UpdateReason];
 /**
  * @public
  * <p>The pricing plan.</p>
@@ -867,11 +927,16 @@ export declare class ConnectorTimeoutException extends __BaseException {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum Order {
-    ASCENDING = "ASCENDING",
-    DESCENDING = "DESCENDING"
-}
+export declare const Order: {
+    readonly ASCENDING: "ASCENDING";
+    readonly DESCENDING: "DESCENDING";
+};
+/**
+ * @public
+ */
+export type Order = (typeof Order)[keyof typeof Order];
 /**
  * @public
  * <p>Filter criteria that orders the return output. It can be sorted in ascending or
@@ -889,10 +954,15 @@ export interface OrderBy {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum InterpolationType {
-    LINEAR = "LINEAR"
-}
+export declare const InterpolationType: {
+    readonly LINEAR: "LINEAR";
+};
+/**
+ * @public
+ */
+export type InterpolationType = (typeof InterpolationType)[keyof typeof InterpolationType];
 /**
  * @public
  * <p>An object that specifies how to interpolate data in a list.</p>
@@ -909,11 +979,16 @@ export interface InterpolationParameters {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum OrderByTime {
-    ASCENDING = "ASCENDING",
-    DESCENDING = "DESCENDING"
-}
+export declare const OrderByTime: {
+    readonly ASCENDING: "ASCENDING";
+    readonly DESCENDING: "DESCENDING";
+};
+/**
+ * @public
+ */
+export type OrderByTime = (typeof OrderByTime)[keyof typeof OrderByTime];
 /**
  * @public
  */
@@ -1466,21 +1541,31 @@ export interface ListSyncJobsResponse {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum SyncResourceType {
-    COMPONENT_TYPE = "COMPONENT_TYPE",
-    ENTITY = "ENTITY"
-}
+export declare const SyncResourceType: {
+    readonly COMPONENT_TYPE: "COMPONENT_TYPE";
+    readonly ENTITY: "ENTITY";
+};
 /**
  * @public
  */
-export declare enum SyncResourceState {
-    DELETED = "DELETED",
-    ERROR = "ERROR",
-    INITIALIZING = "INITIALIZING",
-    IN_SYNC = "IN_SYNC",
-    PROCESSING = "PROCESSING"
-}
+export type SyncResourceType = (typeof SyncResourceType)[keyof typeof SyncResourceType];
+/**
+ * @public
+ * @enum
+ */
+export declare const SyncResourceState: {
+    readonly DELETED: "DELETED";
+    readonly ERROR: "ERROR";
+    readonly INITIALIZING: "INITIALIZING";
+    readonly IN_SYNC: "IN_SYNC";
+    readonly PROCESSING: "PROCESSING";
+};
+/**
+ * @public
+ */
+export type SyncResourceState = (typeof SyncResourceState)[keyof typeof SyncResourceState];
 /**
  * @public
  * <p>The sync resource filter.</p>
@@ -1796,19 +1881,29 @@ export interface UpdateComponentTypeResponse {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum ComponentUpdateType {
-    CREATE = "CREATE",
-    DELETE = "DELETE",
-    UPDATE = "UPDATE"
-}
+export declare const ComponentUpdateType: {
+    readonly CREATE: "CREATE";
+    readonly DELETE: "DELETE";
+    readonly UPDATE: "UPDATE";
+};
 /**
  * @public
  */
-export declare enum ParentEntityUpdateType {
-    DELETE = "DELETE",
-    UPDATE = "UPDATE"
-}
+export type ComponentUpdateType = (typeof ComponentUpdateType)[keyof typeof ComponentUpdateType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ParentEntityUpdateType: {
+    readonly DELETE: "DELETE";
+    readonly UPDATE: "UPDATE";
+};
+/**
+ * @public
+ */
+export type ParentEntityUpdateType = (typeof ParentEntityUpdateType)[keyof typeof ParentEntityUpdateType];
 /**
  * @public
  * <p>The parent entity update request.</p>