@aws-sdk/client-iottwinmaker 3.296.0 → 3.298.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 (127) hide show
  1. package/README.md +7 -5
  2. package/dist-cjs/commands/BatchPutPropertyValuesCommand.js +2 -3
  3. package/dist-cjs/commands/CreateComponentTypeCommand.js +2 -3
  4. package/dist-cjs/commands/CreateEntityCommand.js +2 -3
  5. package/dist-cjs/commands/CreateSceneCommand.js +2 -3
  6. package/dist-cjs/commands/CreateSyncJobCommand.js +2 -3
  7. package/dist-cjs/commands/CreateWorkspaceCommand.js +2 -3
  8. package/dist-cjs/commands/DeleteComponentTypeCommand.js +2 -3
  9. package/dist-cjs/commands/DeleteEntityCommand.js +2 -3
  10. package/dist-cjs/commands/DeleteSceneCommand.js +2 -3
  11. package/dist-cjs/commands/DeleteSyncJobCommand.js +2 -3
  12. package/dist-cjs/commands/DeleteWorkspaceCommand.js +2 -3
  13. package/dist-cjs/commands/ExecuteQueryCommand.js +2 -3
  14. package/dist-cjs/commands/GetComponentTypeCommand.js +2 -3
  15. package/dist-cjs/commands/GetEntityCommand.js +2 -3
  16. package/dist-cjs/commands/GetPricingPlanCommand.js +2 -3
  17. package/dist-cjs/commands/GetPropertyValueCommand.js +2 -3
  18. package/dist-cjs/commands/GetPropertyValueHistoryCommand.js +2 -3
  19. package/dist-cjs/commands/GetSceneCommand.js +2 -3
  20. package/dist-cjs/commands/GetSyncJobCommand.js +2 -3
  21. package/dist-cjs/commands/GetWorkspaceCommand.js +2 -3
  22. package/dist-cjs/commands/ListComponentTypesCommand.js +2 -3
  23. package/dist-cjs/commands/ListEntitiesCommand.js +2 -3
  24. package/dist-cjs/commands/ListScenesCommand.js +2 -3
  25. package/dist-cjs/commands/ListSyncJobsCommand.js +2 -3
  26. package/dist-cjs/commands/ListSyncResourcesCommand.js +2 -3
  27. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  28. package/dist-cjs/commands/ListWorkspacesCommand.js +2 -3
  29. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  30. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  31. package/dist-cjs/commands/UpdateComponentTypeCommand.js +2 -3
  32. package/dist-cjs/commands/UpdateEntityCommand.js +2 -3
  33. package/dist-cjs/commands/UpdatePricingPlanCommand.js +2 -3
  34. package/dist-cjs/commands/UpdateSceneCommand.js +2 -3
  35. package/dist-cjs/commands/UpdateWorkspaceCommand.js +2 -3
  36. package/dist-cjs/endpoint/ruleset.js +3 -3
  37. package/dist-cjs/models/models_0.js +1 -493
  38. package/dist-cjs/protocols/Aws_restJson1.js +39 -0
  39. package/dist-es/commands/BatchPutPropertyValuesCommand.js +2 -3
  40. package/dist-es/commands/CreateComponentTypeCommand.js +2 -3
  41. package/dist-es/commands/CreateEntityCommand.js +2 -3
  42. package/dist-es/commands/CreateSceneCommand.js +2 -3
  43. package/dist-es/commands/CreateSyncJobCommand.js +2 -3
  44. package/dist-es/commands/CreateWorkspaceCommand.js +2 -3
  45. package/dist-es/commands/DeleteComponentTypeCommand.js +2 -3
  46. package/dist-es/commands/DeleteEntityCommand.js +2 -3
  47. package/dist-es/commands/DeleteSceneCommand.js +2 -3
  48. package/dist-es/commands/DeleteSyncJobCommand.js +2 -3
  49. package/dist-es/commands/DeleteWorkspaceCommand.js +2 -3
  50. package/dist-es/commands/ExecuteQueryCommand.js +2 -3
  51. package/dist-es/commands/GetComponentTypeCommand.js +2 -3
  52. package/dist-es/commands/GetEntityCommand.js +2 -3
  53. package/dist-es/commands/GetPricingPlanCommand.js +2 -3
  54. package/dist-es/commands/GetPropertyValueCommand.js +2 -3
  55. package/dist-es/commands/GetPropertyValueHistoryCommand.js +2 -3
  56. package/dist-es/commands/GetSceneCommand.js +2 -3
  57. package/dist-es/commands/GetSyncJobCommand.js +2 -3
  58. package/dist-es/commands/GetWorkspaceCommand.js +2 -3
  59. package/dist-es/commands/ListComponentTypesCommand.js +2 -3
  60. package/dist-es/commands/ListEntitiesCommand.js +2 -3
  61. package/dist-es/commands/ListScenesCommand.js +2 -3
  62. package/dist-es/commands/ListSyncJobsCommand.js +2 -3
  63. package/dist-es/commands/ListSyncResourcesCommand.js +2 -3
  64. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  65. package/dist-es/commands/ListWorkspacesCommand.js +2 -3
  66. package/dist-es/commands/TagResourceCommand.js +2 -3
  67. package/dist-es/commands/UntagResourceCommand.js +2 -3
  68. package/dist-es/commands/UpdateComponentTypeCommand.js +2 -3
  69. package/dist-es/commands/UpdateEntityCommand.js +2 -3
  70. package/dist-es/commands/UpdatePricingPlanCommand.js +2 -3
  71. package/dist-es/commands/UpdateSceneCommand.js +2 -3
  72. package/dist-es/commands/UpdateWorkspaceCommand.js +2 -3
  73. package/dist-es/endpoint/ruleset.js +3 -3
  74. package/dist-es/models/models_0.js +0 -374
  75. package/dist-es/protocols/Aws_restJson1.js +39 -0
  76. package/dist-types/IoTTwinMaker.d.ts +51 -10
  77. package/dist-types/IoTTwinMakerClient.d.ts +31 -9
  78. package/dist-types/commands/BatchPutPropertyValuesCommand.d.ts +16 -0
  79. package/dist-types/commands/CreateComponentTypeCommand.d.ts +16 -0
  80. package/dist-types/commands/CreateEntityCommand.d.ts +16 -0
  81. package/dist-types/commands/CreateSceneCommand.d.ts +16 -0
  82. package/dist-types/commands/CreateSyncJobCommand.d.ts +16 -0
  83. package/dist-types/commands/CreateWorkspaceCommand.d.ts +16 -0
  84. package/dist-types/commands/DeleteComponentTypeCommand.d.ts +16 -0
  85. package/dist-types/commands/DeleteEntityCommand.d.ts +16 -0
  86. package/dist-types/commands/DeleteSceneCommand.d.ts +16 -0
  87. package/dist-types/commands/DeleteSyncJobCommand.d.ts +16 -0
  88. package/dist-types/commands/DeleteWorkspaceCommand.d.ts +16 -0
  89. package/dist-types/commands/ExecuteQueryCommand.d.ts +18 -1
  90. package/dist-types/commands/GetComponentTypeCommand.d.ts +16 -0
  91. package/dist-types/commands/GetEntityCommand.d.ts +16 -0
  92. package/dist-types/commands/GetPricingPlanCommand.d.ts +16 -0
  93. package/dist-types/commands/GetPropertyValueCommand.d.ts +18 -1
  94. package/dist-types/commands/GetPropertyValueHistoryCommand.d.ts +21 -3
  95. package/dist-types/commands/GetSceneCommand.d.ts +16 -0
  96. package/dist-types/commands/GetSyncJobCommand.d.ts +16 -0
  97. package/dist-types/commands/GetWorkspaceCommand.d.ts +16 -0
  98. package/dist-types/commands/ListComponentTypesCommand.d.ts +16 -0
  99. package/dist-types/commands/ListEntitiesCommand.d.ts +16 -0
  100. package/dist-types/commands/ListScenesCommand.d.ts +16 -0
  101. package/dist-types/commands/ListSyncJobsCommand.d.ts +16 -0
  102. package/dist-types/commands/ListSyncResourcesCommand.d.ts +16 -0
  103. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  104. package/dist-types/commands/ListWorkspacesCommand.d.ts +16 -0
  105. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  106. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  107. package/dist-types/commands/UpdateComponentTypeCommand.d.ts +16 -0
  108. package/dist-types/commands/UpdateEntityCommand.d.ts +16 -0
  109. package/dist-types/commands/UpdatePricingPlanCommand.d.ts +16 -0
  110. package/dist-types/commands/UpdateSceneCommand.d.ts +16 -0
  111. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +16 -0
  112. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  113. package/dist-types/models/IoTTwinMakerServiceException.d.ts +2 -0
  114. package/dist-types/models/models_0.d.ts +463 -546
  115. package/dist-types/pagination/ExecuteQueryPaginator.d.ts +3 -0
  116. package/dist-types/pagination/GetPropertyValueHistoryPaginator.d.ts +3 -0
  117. package/dist-types/pagination/GetPropertyValuePaginator.d.ts +3 -0
  118. package/dist-types/pagination/Interfaces.d.ts +3 -0
  119. package/dist-types/pagination/ListComponentTypesPaginator.d.ts +3 -0
  120. package/dist-types/pagination/ListEntitiesPaginator.d.ts +3 -0
  121. package/dist-types/pagination/ListScenesPaginator.d.ts +3 -0
  122. package/dist-types/pagination/ListSyncJobsPaginator.d.ts +3 -0
  123. package/dist-types/pagination/ListSyncResourcesPaginator.d.ts +3 -0
  124. package/dist-types/pagination/ListWorkspacesPaginator.d.ts +3 -0
  125. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  126. package/dist-types/ts3.4/models/models_0.d.ts +4 -330
  127. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { CreateWorkspaceRequest, CreateWorkspaceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateWorkspaceCommand}.
8
10
  */
9
11
  export interface CreateWorkspaceCommandInput extends CreateWorkspaceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateWorkspaceCommand}.
13
17
  */
14
18
  export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a workplace.</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 CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateWorkspaceCommandInput - {@link CreateWorkspaceCommandInput}
34
+ * @returns {@link CreateWorkspaceCommandOutput}
28
35
  * @see {@link CreateWorkspaceCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateWorkspaceCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _
52
59
  export declare class CreateWorkspaceCommand extends $Command<CreateWorkspaceCommandInput, CreateWorkspaceCommandOutput, IoTTwinMakerClientResolvedConfig> {
53
60
  readonly input: CreateWorkspaceCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreateWorkspaceCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateWorkspaceCommandInput, CreateWorkspaceCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { DeleteComponentTypeRequest, DeleteComponentTypeResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteComponentTypeCommand}.
8
10
  */
9
11
  export interface DeleteComponentTypeCommandInput extends DeleteComponentTypeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteComponentTypeCommand}.
13
17
  */
14
18
  export interface DeleteComponentTypeCommandOutput extends DeleteComponentTypeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a component type.</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 DeleteComponentTypeCommandOutput extends DeleteComponentTypeRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteComponentTypeCommandInput - {@link DeleteComponentTypeCommandInput}
34
+ * @returns {@link DeleteComponentTypeCommandOutput}
28
35
  * @see {@link DeleteComponentTypeCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteComponentTypeCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteComponentTypeCommandOutput extends DeleteComponentTypeRes
49
56
  export declare class DeleteComponentTypeCommand extends $Command<DeleteComponentTypeCommandInput, DeleteComponentTypeCommandOutput, IoTTwinMakerClientResolvedConfig> {
50
57
  readonly input: DeleteComponentTypeCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteComponentTypeCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteComponentTypeCommandInput, DeleteComponentTypeCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { DeleteEntityRequest, DeleteEntityResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteEntityCommand}.
8
10
  */
9
11
  export interface DeleteEntityCommandInput extends DeleteEntityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteEntityCommand}.
13
17
  */
14
18
  export interface DeleteEntityCommandOutput extends DeleteEntityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an entity.</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 DeleteEntityCommandOutput extends DeleteEntityResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteEntityCommandInput - {@link DeleteEntityCommandInput}
34
+ * @returns {@link DeleteEntityCommandOutput}
28
35
  * @see {@link DeleteEntityCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteEntityCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteEntityCommandOutput extends DeleteEntityResponse, __Metad
49
56
  export declare class DeleteEntityCommand extends $Command<DeleteEntityCommandInput, DeleteEntityCommandOutput, IoTTwinMakerClientResolvedConfig> {
50
57
  readonly input: DeleteEntityCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteEntityCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteEntityCommandInput, DeleteEntityCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { DeleteSceneRequest, DeleteSceneResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSceneCommand}.
8
10
  */
9
11
  export interface DeleteSceneCommandInput extends DeleteSceneRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSceneCommand}.
13
17
  */
14
18
  export interface DeleteSceneCommandOutput extends DeleteSceneResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a scene.</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 DeleteSceneCommandOutput extends DeleteSceneResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteSceneCommandInput - {@link DeleteSceneCommandInput}
34
+ * @returns {@link DeleteSceneCommandOutput}
28
35
  * @see {@link DeleteSceneCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteSceneCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteSceneCommandOutput extends DeleteSceneResponse, __Metadat
49
56
  export declare class DeleteSceneCommand extends $Command<DeleteSceneCommandInput, DeleteSceneCommandOutput, IoTTwinMakerClientResolvedConfig> {
50
57
  readonly input: DeleteSceneCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteSceneCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSceneCommandInput, DeleteSceneCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { DeleteSyncJobRequest, DeleteSyncJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSyncJobCommand}.
8
10
  */
9
11
  export interface DeleteSyncJobCommandInput extends DeleteSyncJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSyncJobCommand}.
13
17
  */
14
18
  export interface DeleteSyncJobCommandOutput extends DeleteSyncJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete the SyncJob.</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 DeleteSyncJobCommandOutput extends DeleteSyncJobResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteSyncJobCommandInput - {@link DeleteSyncJobCommandInput}
34
+ * @returns {@link DeleteSyncJobCommandOutput}
28
35
  * @see {@link DeleteSyncJobCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteSyncJobCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteSyncJobCommandOutput extends DeleteSyncJobResponse, __Met
52
59
  export declare class DeleteSyncJobCommand extends $Command<DeleteSyncJobCommandInput, DeleteSyncJobCommandOutput, IoTTwinMakerClientResolvedConfig> {
53
60
  readonly input: DeleteSyncJobCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteSyncJobCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSyncJobCommandInput, DeleteSyncJobCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { DeleteWorkspaceRequest, DeleteWorkspaceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteWorkspaceCommand}.
8
10
  */
9
11
  export interface DeleteWorkspaceCommandInput extends DeleteWorkspaceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteWorkspaceCommand}.
13
17
  */
14
18
  export interface DeleteWorkspaceCommandOutput extends DeleteWorkspaceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a workspace.</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 DeleteWorkspaceCommandOutput extends DeleteWorkspaceResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteWorkspaceCommandInput - {@link DeleteWorkspaceCommandInput}
34
+ * @returns {@link DeleteWorkspaceCommandOutput}
28
35
  * @see {@link DeleteWorkspaceCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteWorkspaceCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteWorkspaceCommandOutput extends DeleteWorkspaceResponse, _
49
56
  export declare class DeleteWorkspaceCommand extends $Command<DeleteWorkspaceCommandInput, DeleteWorkspaceCommandOutput, IoTTwinMakerClientResolvedConfig> {
50
57
  readonly input: DeleteWorkspaceCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteWorkspaceCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWorkspaceCommandInput, DeleteWorkspaceCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,17 +4,23 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { ExecuteQueryRequest, ExecuteQueryResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ExecuteQueryCommand}.
8
10
  */
9
11
  export interface ExecuteQueryCommandInput extends ExecuteQueryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ExecuteQueryCommand}.
13
17
  */
14
18
  export interface ExecuteQueryCommandOutput extends ExecuteQueryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
17
- * <p>Run queries to access information from your knowledge graph of entities within individual workspaces.</p>
21
+ * @public
22
+ * <p>Run queries to access information from your knowledge graph of entities within
23
+ * individual workspaces.</p>
18
24
  * @example
19
25
  * Use a bare-bones client and the command you need to make an API call.
20
26
  * ```javascript
@@ -25,6 +31,8 @@ export interface ExecuteQueryCommandOutput extends ExecuteQueryResponse, __Metad
25
31
  * const response = await client.send(command);
26
32
  * ```
27
33
  *
34
+ * @param ExecuteQueryCommandInput - {@link ExecuteQueryCommandInput}
35
+ * @returns {@link ExecuteQueryCommandOutput}
28
36
  * @see {@link ExecuteQueryCommandInput} for command's `input` shape.
29
37
  * @see {@link ExecuteQueryCommandOutput} for command's `response` shape.
30
38
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -52,11 +60,20 @@ export interface ExecuteQueryCommandOutput extends ExecuteQueryResponse, __Metad
52
60
  export declare class ExecuteQueryCommand extends $Command<ExecuteQueryCommandInput, ExecuteQueryCommandOutput, IoTTwinMakerClientResolvedConfig> {
53
61
  readonly input: ExecuteQueryCommandInput;
54
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
55
66
  constructor(input: ExecuteQueryCommandInput);
56
67
  /**
57
68
  * @internal
58
69
  */
59
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteQueryCommandInput, ExecuteQueryCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
60
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
61
78
  private deserialize;
62
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { GetComponentTypeRequest, GetComponentTypeResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetComponentTypeCommand}.
8
10
  */
9
11
  export interface GetComponentTypeCommandInput extends GetComponentTypeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetComponentTypeCommand}.
13
17
  */
14
18
  export interface GetComponentTypeCommandOutput extends GetComponentTypeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about a component type.</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 GetComponentTypeCommandOutput extends GetComponentTypeResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetComponentTypeCommandInput - {@link GetComponentTypeCommandInput}
34
+ * @returns {@link GetComponentTypeCommandOutput}
28
35
  * @see {@link GetComponentTypeCommandInput} for command's `input` shape.
29
36
  * @see {@link GetComponentTypeCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetComponentTypeCommandOutput extends GetComponentTypeResponse,
49
56
  export declare class GetComponentTypeCommand extends $Command<GetComponentTypeCommandInput, GetComponentTypeCommandOutput, IoTTwinMakerClientResolvedConfig> {
50
57
  readonly input: GetComponentTypeCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetComponentTypeCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetComponentTypeCommandInput, GetComponentTypeCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { GetEntityRequest, GetEntityResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetEntityCommand}.
8
10
  */
9
11
  export interface GetEntityCommandInput extends GetEntityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetEntityCommand}.
13
17
  */
14
18
  export interface GetEntityCommandOutput extends GetEntityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about an entity.</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 GetEntityCommandOutput extends GetEntityResponse, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetEntityCommandInput - {@link GetEntityCommandInput}
34
+ * @returns {@link GetEntityCommandOutput}
28
35
  * @see {@link GetEntityCommandInput} for command's `input` shape.
29
36
  * @see {@link GetEntityCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetEntityCommandOutput extends GetEntityResponse, __MetadataBea
49
56
  export declare class GetEntityCommand extends $Command<GetEntityCommandInput, GetEntityCommandOutput, IoTTwinMakerClientResolvedConfig> {
50
57
  readonly input: GetEntityCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetEntityCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEntityCommandInput, GetEntityCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { GetPricingPlanRequest, GetPricingPlanResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPricingPlanCommand}.
8
10
  */
9
11
  export interface GetPricingPlanCommandInput extends GetPricingPlanRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPricingPlanCommand}.
13
17
  */
14
18
  export interface GetPricingPlanCommandOutput extends GetPricingPlanResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the pricing plan.</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 GetPricingPlanCommandOutput extends GetPricingPlanResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetPricingPlanCommandInput - {@link GetPricingPlanCommandInput}
34
+ * @returns {@link GetPricingPlanCommandOutput}
28
35
  * @see {@link GetPricingPlanCommandInput} for command's `input` shape.
29
36
  * @see {@link GetPricingPlanCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetPricingPlanCommandOutput extends GetPricingPlanResponse, __M
46
53
  export declare class GetPricingPlanCommand extends $Command<GetPricingPlanCommandInput, GetPricingPlanCommandOutput, IoTTwinMakerClientResolvedConfig> {
47
54
  readonly input: GetPricingPlanCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetPricingPlanCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPricingPlanCommandInput, GetPricingPlanCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,18 +4,24 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { GetPropertyValueRequest, GetPropertyValueResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPropertyValueCommand}.
8
10
  */
9
11
  export interface GetPropertyValueCommandInput extends GetPropertyValueRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPropertyValueCommand}.
13
17
  */
14
18
  export interface GetPropertyValueCommandOutput extends GetPropertyValueResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the property values for a component, component type, entity, or workspace.</p>
18
- * <p>You must specify a value for either <code>componentName</code>, <code>componentTypeId</code>, <code>entityId</code>, or <code>workspaceId</code>.</p>
23
+ * <p>You must specify a value for either <code>componentName</code>,
24
+ * <code>componentTypeId</code>, <code>entityId</code>, or <code>workspaceId</code>.</p>
19
25
  * @example
20
26
  * Use a bare-bones client and the command you need to make an API call.
21
27
  * ```javascript
@@ -26,6 +32,8 @@ export interface GetPropertyValueCommandOutput extends GetPropertyValueResponse,
26
32
  * const response = await client.send(command);
27
33
  * ```
28
34
  *
35
+ * @param GetPropertyValueCommandInput - {@link GetPropertyValueCommandInput}
36
+ * @returns {@link GetPropertyValueCommandOutput}
29
37
  * @see {@link GetPropertyValueCommandInput} for command's `input` shape.
30
38
  * @see {@link GetPropertyValueCommandOutput} for command's `response` shape.
31
39
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -56,11 +64,20 @@ export interface GetPropertyValueCommandOutput extends GetPropertyValueResponse,
56
64
  export declare class GetPropertyValueCommand extends $Command<GetPropertyValueCommandInput, GetPropertyValueCommandOutput, IoTTwinMakerClientResolvedConfig> {
57
65
  readonly input: GetPropertyValueCommandInput;
58
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
59
70
  constructor(input: GetPropertyValueCommandInput);
60
71
  /**
61
72
  * @internal
62
73
  */
63
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPropertyValueCommandInput, GetPropertyValueCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
64
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
65
82
  private deserialize;
66
83
  }
@@ -4,19 +4,26 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
5
5
  import { GetPropertyValueHistoryRequest, GetPropertyValueHistoryResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPropertyValueHistoryCommand}.
8
10
  */
9
11
  export interface GetPropertyValueHistoryCommandInput extends GetPropertyValueHistoryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPropertyValueHistoryCommand}.
13
17
  */
14
18
  export interface GetPropertyValueHistoryCommandOutput extends GetPropertyValueHistoryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
17
- * <p>Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.</p>
18
- * <p>You must specify a value for <code>workspaceId</code>. For entity-specific queries, specify values for <code>componentName</code> and
19
- * <code>entityId</code>. For cross-entity quries, specify a value for <code>componentTypeId</code>.</p>
21
+ * @public
22
+ * <p>Retrieves information about the history of a time series property value for a component,
23
+ * component type, entity, or workspace.</p>
24
+ * <p>You must specify a value for <code>workspaceId</code>. For entity-specific queries,
25
+ * specify values for <code>componentName</code> and <code>entityId</code>. For cross-entity
26
+ * quries, specify a value for <code>componentTypeId</code>.</p>
20
27
  * @example
21
28
  * Use a bare-bones client and the command you need to make an API call.
22
29
  * ```javascript
@@ -27,6 +34,8 @@ export interface GetPropertyValueHistoryCommandOutput extends GetPropertyValueHi
27
34
  * const response = await client.send(command);
28
35
  * ```
29
36
  *
37
+ * @param GetPropertyValueHistoryCommandInput - {@link GetPropertyValueHistoryCommandInput}
38
+ * @returns {@link GetPropertyValueHistoryCommandOutput}
30
39
  * @see {@link GetPropertyValueHistoryCommandInput} for command's `input` shape.
31
40
  * @see {@link GetPropertyValueHistoryCommandOutput} for command's `response` shape.
32
41
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -57,11 +66,20 @@ export interface GetPropertyValueHistoryCommandOutput extends GetPropertyValueHi
57
66
  export declare class GetPropertyValueHistoryCommand extends $Command<GetPropertyValueHistoryCommandInput, GetPropertyValueHistoryCommandOutput, IoTTwinMakerClientResolvedConfig> {
58
67
  readonly input: GetPropertyValueHistoryCommandInput;
59
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
60
72
  constructor(input: GetPropertyValueHistoryCommandInput);
61
73
  /**
62
74
  * @internal
63
75
  */
64
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPropertyValueHistoryCommandInput, GetPropertyValueHistoryCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
65
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
66
84
  private deserialize;
67
85
  }