@aws-sdk/client-iotsitewise 3.848.0 → 3.855.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.
- package/README.md +80 -0
- package/dist-cjs/index.js +749 -35
- package/dist-es/IoTSiteWise.js +20 -0
- package/dist-es/commands/CreateComputationModelCommand.js +22 -0
- package/dist-es/commands/DeleteComputationModelCommand.js +22 -0
- package/dist-es/commands/DescribeComputationModelCommand.js +22 -0
- package/dist-es/commands/DescribeComputationModelExecutionSummaryCommand.js +22 -0
- package/dist-es/commands/DescribeExecutionCommand.js +22 -0
- package/dist-es/commands/ListComputationModelDataBindingUsagesCommand.js +22 -0
- package/dist-es/commands/ListComputationModelResolveToResourcesCommand.js +22 -0
- package/dist-es/commands/ListComputationModelsCommand.js +22 -0
- package/dist-es/commands/ListExecutionsCommand.js +22 -0
- package/dist-es/commands/UpdateComputationModelCommand.js +22 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/models/models_0.js +15 -27
- package/dist-es/models/models_1.js +31 -0
- package/dist-es/pagination/ListComputationModelDataBindingUsagesPaginator.js +4 -0
- package/dist-es/pagination/ListComputationModelResolveToResourcesPaginator.js +4 -0
- package/dist-es/pagination/ListComputationModelsPaginator.js +4 -0
- package/dist-es/pagination/ListExecutionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +482 -0
- package/dist-types/IoTSiteWise.d.ts +71 -0
- package/dist-types/IoTSiteWiseClient.d.ts +12 -2
- package/dist-types/commands/AssociateAssetsCommand.d.ts +1 -1
- package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +1 -1
- package/dist-types/commands/BatchPutAssetPropertyValueCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/CreateAssetCommand.d.ts +3 -3
- package/dist-types/commands/CreateAssetModelCommand.d.ts +1 -1
- package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +1 -1
- package/dist-types/commands/CreateBulkImportJobCommand.d.ts +14 -3
- package/dist-types/commands/CreateComputationModelCommand.d.ts +154 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +1 -1
- package/dist-types/commands/CreateDatasetCommand.d.ts +1 -1
- package/dist-types/commands/CreateGatewayCommand.d.ts +1 -1
- package/dist-types/commands/CreatePortalCommand.d.ts +1 -1
- package/dist-types/commands/CreateProjectCommand.d.ts +1 -1
- package/dist-types/commands/DeleteComputationModelCommand.d.ts +105 -0
- package/dist-types/commands/DescribeActionCommand.d.ts +5 -1
- package/dist-types/commands/DescribeAssetCommand.d.ts +4 -4
- package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +3 -3
- package/dist-types/commands/DescribeComputationModelCommand.d.ts +148 -0
- package/dist-types/commands/DescribeComputationModelExecutionSummaryCommand.d.ts +96 -0
- package/dist-types/commands/DescribeExecutionCommand.d.ts +109 -0
- package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +18 -5
- package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/ExecuteActionCommand.d.ts +6 -2
- package/dist-types/commands/InvokeAssistantCommand.d.ts +1 -1
- package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListActionsCommand.d.ts +8 -2
- package/dist-types/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetModelsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetPropertiesCommand.d.ts +2 -2
- package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetsCommand.d.ts +3 -4
- package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +2 -2
- package/dist-types/commands/ListComputationModelDataBindingUsagesCommand.d.ts +126 -0
- package/dist-types/commands/ListComputationModelResolveToResourcesCommand.d.ts +97 -0
- package/dist-types/commands/ListComputationModelsCommand.d.ts +112 -0
- package/dist-types/commands/ListExecutionsCommand.d.ts +114 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutStorageConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssetModelCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +1 -1
- package/dist-types/commands/UpdateComputationModelCommand.d.ts +149 -0
- package/dist-types/commands/UpdateDatasetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +21 -6
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +521 -596
- package/dist-types/models/models_1.d.ts +1095 -45
- package/dist-types/pagination/ListComputationModelDataBindingUsagesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListComputationModelResolveToResourcesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListComputationModelsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListExecutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
- package/dist-types/ts3.4/IoTSiteWise.d.ts +189 -0
- package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +60 -0
- package/dist-types/ts3.4/commands/CreateComputationModelCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/DeleteComputationModelCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeComputationModelCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/DescribeComputationModelExecutionSummaryCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAccessPoliciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetModelsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetRelationshipsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetsCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/ListComputationModelDataBindingUsagesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListComputationModelResolveToResourcesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListComputationModelsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateComputationModelCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +116 -131
- package/dist-types/ts3.4/models/models_1.d.ts +279 -1
- package/dist-types/ts3.4/pagination/ListComputationModelDataBindingUsagesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListComputationModelResolveToResourcesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListComputationModelsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListExecutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
- package/package.json +5 -5
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
|
|
4
|
+
import { DeleteComputationModelRequest, DeleteComputationModelResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteComputationModelCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteComputationModelCommandInput extends DeleteComputationModelRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteComputationModelCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteComputationModelCommandOutput extends DeleteComputationModelResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteComputationModelCommand_base: {
|
|
25
|
+
new (input: DeleteComputationModelCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteComputationModelCommandInput, DeleteComputationModelCommandOutput, IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteComputationModelCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteComputationModelCommandInput, DeleteComputationModelCommandOutput, IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a computation model. This action can't be undone.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { IoTSiteWiseClient, DeleteComputationModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
35
|
+
* // const { IoTSiteWiseClient, DeleteComputationModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
36
|
+
* const client = new IoTSiteWiseClient(config);
|
|
37
|
+
* const input = { // DeleteComputationModelRequest
|
|
38
|
+
* computationModelId: "STRING_VALUE", // required
|
|
39
|
+
* clientToken: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteComputationModelCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // DeleteComputationModelResponse
|
|
44
|
+
* // computationModelStatus: { // ComputationModelStatus
|
|
45
|
+
* // state: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED", // required
|
|
46
|
+
* // error: { // ErrorDetails
|
|
47
|
+
* // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
|
|
48
|
+
* // message: "STRING_VALUE", // required
|
|
49
|
+
* // details: [ // DetailedErrors
|
|
50
|
+
* // { // DetailedError
|
|
51
|
+
* // code: "INCOMPATIBLE_COMPUTE_LOCATION" || "INCOMPATIBLE_FORWARDING_CONFIGURATION", // required
|
|
52
|
+
* // message: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // },
|
|
56
|
+
* // },
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
61
|
+
* @param DeleteComputationModelCommandInput - {@link DeleteComputationModelCommandInput}
|
|
62
|
+
* @returns {@link DeleteComputationModelCommandOutput}
|
|
63
|
+
* @see {@link DeleteComputationModelCommandInput} for command's `input` shape.
|
|
64
|
+
* @see {@link DeleteComputationModelCommandOutput} for command's `response` shape.
|
|
65
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ConflictingOperationException} (client fault)
|
|
68
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
69
|
+
* than one operation on the same resource at the same time.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
72
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
75
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
76
|
+
* unsupported characters. Check your request and try again.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
79
|
+
* <p>The requested resource can't be found.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
83
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
84
|
+
* on.</p>
|
|
85
|
+
* <p>For more information, 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>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
89
|
+
*
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare class DeleteComputationModelCommand extends DeleteComputationModelCommand_base {
|
|
94
|
+
/** @internal type navigation helper, not in runtime. */
|
|
95
|
+
protected static __types: {
|
|
96
|
+
api: {
|
|
97
|
+
input: DeleteComputationModelRequest;
|
|
98
|
+
output: DeleteComputationModelResponse;
|
|
99
|
+
};
|
|
100
|
+
sdk: {
|
|
101
|
+
input: DeleteComputationModelCommandInput;
|
|
102
|
+
output: DeleteComputationModelCommandOutput;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -42,13 +42,17 @@ declare const DescribeActionCommand_base: {
|
|
|
42
42
|
* // { // DescribeActionResponse
|
|
43
43
|
* // actionId: "STRING_VALUE", // required
|
|
44
44
|
* // targetResource: { // TargetResource
|
|
45
|
-
* // assetId: "STRING_VALUE",
|
|
45
|
+
* // assetId: "STRING_VALUE",
|
|
46
|
+
* // computationModelId: "STRING_VALUE",
|
|
46
47
|
* // },
|
|
47
48
|
* // actionDefinitionId: "STRING_VALUE", // required
|
|
48
49
|
* // actionPayload: { // ActionPayload
|
|
49
50
|
* // stringValue: "STRING_VALUE", // required
|
|
50
51
|
* // },
|
|
51
52
|
* // executionTime: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // resolveTo: { // ResolveTo
|
|
54
|
+
* // assetId: "STRING_VALUE", // required
|
|
55
|
+
* // },
|
|
52
56
|
* // };
|
|
53
57
|
*
|
|
54
58
|
* ```
|
|
@@ -42,12 +42,14 @@ declare const DescribeAssetCommand_base: {
|
|
|
42
42
|
* const response = await client.send(command);
|
|
43
43
|
* // { // DescribeAssetResponse
|
|
44
44
|
* // assetId: "STRING_VALUE", // required
|
|
45
|
+
* // assetExternalId: "STRING_VALUE",
|
|
45
46
|
* // assetArn: "STRING_VALUE", // required
|
|
46
47
|
* // assetName: "STRING_VALUE", // required
|
|
47
48
|
* // assetModelId: "STRING_VALUE", // required
|
|
48
49
|
* // assetProperties: [ // AssetProperties // required
|
|
49
50
|
* // { // AssetProperty
|
|
50
51
|
* // id: "STRING_VALUE", // required
|
|
52
|
+
* // externalId: "STRING_VALUE",
|
|
51
53
|
* // name: "STRING_VALUE", // required
|
|
52
54
|
* // alias: "STRING_VALUE",
|
|
53
55
|
* // notification: { // PropertyNotification
|
|
@@ -63,14 +65,13 @@ declare const DescribeAssetCommand_base: {
|
|
|
63
65
|
* // name: "STRING_VALUE",
|
|
64
66
|
* // },
|
|
65
67
|
* // ],
|
|
66
|
-
* // externalId: "STRING_VALUE",
|
|
67
68
|
* // },
|
|
68
69
|
* // ],
|
|
69
70
|
* // assetHierarchies: [ // AssetHierarchies // required
|
|
70
71
|
* // { // AssetHierarchy
|
|
71
72
|
* // id: "STRING_VALUE",
|
|
72
|
-
* // name: "STRING_VALUE", // required
|
|
73
73
|
* // externalId: "STRING_VALUE",
|
|
74
|
+
* // name: "STRING_VALUE", // required
|
|
74
75
|
* // },
|
|
75
76
|
* // ],
|
|
76
77
|
* // assetCompositeModels: [ // AssetCompositeModels
|
|
@@ -81,6 +82,7 @@ declare const DescribeAssetCommand_base: {
|
|
|
81
82
|
* // properties: [ // required
|
|
82
83
|
* // {
|
|
83
84
|
* // id: "STRING_VALUE", // required
|
|
85
|
+
* // externalId: "STRING_VALUE",
|
|
84
86
|
* // name: "STRING_VALUE", // required
|
|
85
87
|
* // alias: "STRING_VALUE",
|
|
86
88
|
* // notification: {
|
|
@@ -96,7 +98,6 @@ declare const DescribeAssetCommand_base: {
|
|
|
96
98
|
* // name: "STRING_VALUE",
|
|
97
99
|
* // },
|
|
98
100
|
* // ],
|
|
99
|
-
* // externalId: "STRING_VALUE",
|
|
100
101
|
* // },
|
|
101
102
|
* // ],
|
|
102
103
|
* // id: "STRING_VALUE",
|
|
@@ -134,7 +135,6 @@ declare const DescribeAssetCommand_base: {
|
|
|
134
135
|
* // ],
|
|
135
136
|
* // },
|
|
136
137
|
* // ],
|
|
137
|
-
* // assetExternalId: "STRING_VALUE",
|
|
138
138
|
* // };
|
|
139
139
|
*
|
|
140
140
|
* ```
|
|
@@ -59,6 +59,7 @@ declare const DescribeAssetCompositeModelCommand_base: {
|
|
|
59
59
|
* // assetCompositeModelProperties: [ // AssetProperties // required
|
|
60
60
|
* // { // AssetProperty
|
|
61
61
|
* // id: "STRING_VALUE", // required
|
|
62
|
+
* // externalId: "STRING_VALUE",
|
|
62
63
|
* // name: "STRING_VALUE", // required
|
|
63
64
|
* // alias: "STRING_VALUE",
|
|
64
65
|
* // notification: { // PropertyNotification
|
|
@@ -74,7 +75,6 @@ declare const DescribeAssetCompositeModelCommand_base: {
|
|
|
74
75
|
* // name: "STRING_VALUE",
|
|
75
76
|
* // },
|
|
76
77
|
* // ],
|
|
77
|
-
* // externalId: "STRING_VALUE",
|
|
78
78
|
* // },
|
|
79
79
|
* // ],
|
|
80
80
|
* // assetCompositeModelSummaries: [ // AssetCompositeModelSummaries // required
|
|
@@ -49,10 +49,12 @@ declare const DescribeAssetPropertyCommand_base: {
|
|
|
49
49
|
* const response = await client.send(command);
|
|
50
50
|
* // { // DescribeAssetPropertyResponse
|
|
51
51
|
* // assetId: "STRING_VALUE", // required
|
|
52
|
+
* // assetExternalId: "STRING_VALUE",
|
|
52
53
|
* // assetName: "STRING_VALUE", // required
|
|
53
54
|
* // assetModelId: "STRING_VALUE", // required
|
|
54
55
|
* // assetProperty: { // Property
|
|
55
56
|
* // id: "STRING_VALUE", // required
|
|
57
|
+
* // externalId: "STRING_VALUE",
|
|
56
58
|
* // name: "STRING_VALUE", // required
|
|
57
59
|
* // alias: "STRING_VALUE",
|
|
58
60
|
* // notification: { // PropertyNotification
|
|
@@ -130,13 +132,13 @@ declare const DescribeAssetPropertyCommand_base: {
|
|
|
130
132
|
* // name: "STRING_VALUE",
|
|
131
133
|
* // },
|
|
132
134
|
* // ],
|
|
133
|
-
* // externalId: "STRING_VALUE",
|
|
134
135
|
* // },
|
|
135
136
|
* // compositeModel: { // CompositeModelProperty
|
|
136
137
|
* // name: "STRING_VALUE", // required
|
|
137
138
|
* // type: "STRING_VALUE", // required
|
|
138
139
|
* // assetProperty: {
|
|
139
140
|
* // id: "STRING_VALUE", // required
|
|
141
|
+
* // externalId: "STRING_VALUE",
|
|
140
142
|
* // name: "STRING_VALUE", // required
|
|
141
143
|
* // alias: "STRING_VALUE",
|
|
142
144
|
* // notification: {
|
|
@@ -214,12 +216,10 @@ declare const DescribeAssetPropertyCommand_base: {
|
|
|
214
216
|
* // name: "STRING_VALUE",
|
|
215
217
|
* // },
|
|
216
218
|
* // ],
|
|
217
|
-
* // externalId: "STRING_VALUE",
|
|
218
219
|
* // },
|
|
219
220
|
* // id: "STRING_VALUE",
|
|
220
221
|
* // externalId: "STRING_VALUE",
|
|
221
222
|
* // },
|
|
222
|
-
* // assetExternalId: "STRING_VALUE",
|
|
223
223
|
* // };
|
|
224
224
|
*
|
|
225
225
|
* ```
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
|
|
4
|
+
import { DescribeComputationModelRequest } from "../models/models_0";
|
|
5
|
+
import { DescribeComputationModelResponse } from "../models/models_1";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export type { __MetadataBearer };
|
|
10
|
+
export { $Command };
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*
|
|
14
|
+
* The input for {@link DescribeComputationModelCommand}.
|
|
15
|
+
*/
|
|
16
|
+
export interface DescribeComputationModelCommandInput extends DescribeComputationModelRequest {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*
|
|
21
|
+
* The output of {@link DescribeComputationModelCommand}.
|
|
22
|
+
*/
|
|
23
|
+
export interface DescribeComputationModelCommandOutput extends DescribeComputationModelResponse, __MetadataBearer {
|
|
24
|
+
}
|
|
25
|
+
declare const DescribeComputationModelCommand_base: {
|
|
26
|
+
new (input: DescribeComputationModelCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeComputationModelCommandInput, DescribeComputationModelCommandOutput, IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
new (input: DescribeComputationModelCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeComputationModelCommandInput, DescribeComputationModelCommandOutput, IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
28
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* <p>Retrieves information about a computation model.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { IoTSiteWiseClient, DescribeComputationModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
36
|
+
* // const { IoTSiteWiseClient, DescribeComputationModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
37
|
+
* const client = new IoTSiteWiseClient(config);
|
|
38
|
+
* const input = { // DescribeComputationModelRequest
|
|
39
|
+
* computationModelId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DescribeComputationModelCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // DescribeComputationModelResponse
|
|
44
|
+
* // computationModelId: "STRING_VALUE", // required
|
|
45
|
+
* // computationModelArn: "STRING_VALUE", // required
|
|
46
|
+
* // computationModelName: "STRING_VALUE", // required
|
|
47
|
+
* // computationModelDescription: "STRING_VALUE",
|
|
48
|
+
* // computationModelConfiguration: { // ComputationModelConfiguration
|
|
49
|
+
* // anomalyDetection: { // ComputationModelAnomalyDetectionConfiguration
|
|
50
|
+
* // inputProperties: "STRING_VALUE", // required
|
|
51
|
+
* // resultProperty: "STRING_VALUE", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // },
|
|
54
|
+
* // computationModelDataBinding: { // ComputationModelDataBinding // required
|
|
55
|
+
* // "<keys>": { // ComputationModelDataBindingValue
|
|
56
|
+
* // assetModelProperty: { // AssetModelPropertyBindingValue
|
|
57
|
+
* // assetModelId: "STRING_VALUE", // required
|
|
58
|
+
* // propertyId: "STRING_VALUE", // required
|
|
59
|
+
* // },
|
|
60
|
+
* // assetProperty: { // AssetPropertyBindingValue
|
|
61
|
+
* // assetId: "STRING_VALUE", // required
|
|
62
|
+
* // propertyId: "STRING_VALUE", // required
|
|
63
|
+
* // },
|
|
64
|
+
* // list: [ // BindingValueList
|
|
65
|
+
* // {
|
|
66
|
+
* // assetModelProperty: {
|
|
67
|
+
* // assetModelId: "STRING_VALUE", // required
|
|
68
|
+
* // propertyId: "STRING_VALUE", // required
|
|
69
|
+
* // },
|
|
70
|
+
* // assetProperty: {
|
|
71
|
+
* // assetId: "STRING_VALUE", // required
|
|
72
|
+
* // propertyId: "STRING_VALUE", // required
|
|
73
|
+
* // },
|
|
74
|
+
* // list: [
|
|
75
|
+
* // "<ComputationModelDataBindingValue>",
|
|
76
|
+
* // ],
|
|
77
|
+
* // },
|
|
78
|
+
* // ],
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
81
|
+
* // computationModelCreationDate: new Date("TIMESTAMP"), // required
|
|
82
|
+
* // computationModelLastUpdateDate: new Date("TIMESTAMP"), // required
|
|
83
|
+
* // computationModelStatus: { // ComputationModelStatus
|
|
84
|
+
* // state: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED", // required
|
|
85
|
+
* // error: { // ErrorDetails
|
|
86
|
+
* // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
|
|
87
|
+
* // message: "STRING_VALUE", // required
|
|
88
|
+
* // details: [ // DetailedErrors
|
|
89
|
+
* // { // DetailedError
|
|
90
|
+
* // code: "INCOMPATIBLE_COMPUTE_LOCATION" || "INCOMPATIBLE_FORWARDING_CONFIGURATION", // required
|
|
91
|
+
* // message: "STRING_VALUE", // required
|
|
92
|
+
* // },
|
|
93
|
+
* // ],
|
|
94
|
+
* // },
|
|
95
|
+
* // },
|
|
96
|
+
* // computationModelVersion: "STRING_VALUE", // required
|
|
97
|
+
* // actionDefinitions: [ // ActionDefinitions // required
|
|
98
|
+
* // { // ActionDefinition
|
|
99
|
+
* // actionDefinitionId: "STRING_VALUE", // required
|
|
100
|
+
* // actionName: "STRING_VALUE", // required
|
|
101
|
+
* // actionType: "STRING_VALUE", // required
|
|
102
|
+
* // },
|
|
103
|
+
* // ],
|
|
104
|
+
* // };
|
|
105
|
+
*
|
|
106
|
+
* ```
|
|
107
|
+
*
|
|
108
|
+
* @param DescribeComputationModelCommandInput - {@link DescribeComputationModelCommandInput}
|
|
109
|
+
* @returns {@link DescribeComputationModelCommandOutput}
|
|
110
|
+
* @see {@link DescribeComputationModelCommandInput} for command's `input` shape.
|
|
111
|
+
* @see {@link DescribeComputationModelCommandOutput} for command's `response` shape.
|
|
112
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
115
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
118
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
119
|
+
* unsupported characters. Check your request and try again.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
122
|
+
* <p>The requested resource can't be found.</p>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
125
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
126
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
127
|
+
* on.</p>
|
|
128
|
+
* <p>For more information, 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>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
131
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
132
|
+
*
|
|
133
|
+
*
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
export declare class DescribeComputationModelCommand extends DescribeComputationModelCommand_base {
|
|
137
|
+
/** @internal type navigation helper, not in runtime. */
|
|
138
|
+
protected static __types: {
|
|
139
|
+
api: {
|
|
140
|
+
input: DescribeComputationModelRequest;
|
|
141
|
+
output: DescribeComputationModelResponse;
|
|
142
|
+
};
|
|
143
|
+
sdk: {
|
|
144
|
+
input: DescribeComputationModelCommandInput;
|
|
145
|
+
output: DescribeComputationModelCommandOutput;
|
|
146
|
+
};
|
|
147
|
+
};
|
|
148
|
+
}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
|
|
4
|
+
import { DescribeComputationModelExecutionSummaryRequest, DescribeComputationModelExecutionSummaryResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeComputationModelExecutionSummaryCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeComputationModelExecutionSummaryCommandInput extends DescribeComputationModelExecutionSummaryRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeComputationModelExecutionSummaryCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeComputationModelExecutionSummaryCommandOutput extends DescribeComputationModelExecutionSummaryResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeComputationModelExecutionSummaryCommand_base: {
|
|
25
|
+
new (input: DescribeComputationModelExecutionSummaryCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeComputationModelExecutionSummaryCommandInput, DescribeComputationModelExecutionSummaryCommandOutput, IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeComputationModelExecutionSummaryCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeComputationModelExecutionSummaryCommandInput, DescribeComputationModelExecutionSummaryCommandOutput, IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves information about the execution summary of a computation model.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { IoTSiteWiseClient, DescribeComputationModelExecutionSummaryCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
35
|
+
* // const { IoTSiteWiseClient, DescribeComputationModelExecutionSummaryCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
36
|
+
* const client = new IoTSiteWiseClient(config);
|
|
37
|
+
* const input = { // DescribeComputationModelExecutionSummaryRequest
|
|
38
|
+
* computationModelId: "STRING_VALUE", // required
|
|
39
|
+
* resolveToResourceType: "ASSET",
|
|
40
|
+
* resolveToResourceId: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DescribeComputationModelExecutionSummaryCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // DescribeComputationModelExecutionSummaryResponse
|
|
45
|
+
* // computationModelId: "STRING_VALUE", // required
|
|
46
|
+
* // resolveTo: { // ResolveTo
|
|
47
|
+
* // assetId: "STRING_VALUE", // required
|
|
48
|
+
* // },
|
|
49
|
+
* // computationModelExecutionSummary: { // ComputationModelExecutionSummary // required
|
|
50
|
+
* // "<keys>": "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param DescribeComputationModelExecutionSummaryCommandInput - {@link DescribeComputationModelExecutionSummaryCommandInput}
|
|
57
|
+
* @returns {@link DescribeComputationModelExecutionSummaryCommandOutput}
|
|
58
|
+
* @see {@link DescribeComputationModelExecutionSummaryCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link DescribeComputationModelExecutionSummaryCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
63
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
66
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
67
|
+
* unsupported characters. Check your request and try again.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
+
* <p>The requested resource can't be found.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
74
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
75
|
+
* on.</p>
|
|
76
|
+
* <p>For more information, 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>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
80
|
+
*
|
|
81
|
+
*
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
export declare class DescribeComputationModelExecutionSummaryCommand extends DescribeComputationModelExecutionSummaryCommand_base {
|
|
85
|
+
/** @internal type navigation helper, not in runtime. */
|
|
86
|
+
protected static __types: {
|
|
87
|
+
api: {
|
|
88
|
+
input: DescribeComputationModelExecutionSummaryRequest;
|
|
89
|
+
output: DescribeComputationModelExecutionSummaryResponse;
|
|
90
|
+
};
|
|
91
|
+
sdk: {
|
|
92
|
+
input: DescribeComputationModelExecutionSummaryCommandInput;
|
|
93
|
+
output: DescribeComputationModelExecutionSummaryCommandOutput;
|
|
94
|
+
};
|
|
95
|
+
};
|
|
96
|
+
}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
|
|
4
|
+
import { DescribeExecutionRequest, DescribeExecutionResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeExecutionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeExecutionCommandInput extends DescribeExecutionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeExecutionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeExecutionCommandOutput extends DescribeExecutionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeExecutionCommand_base: {
|
|
25
|
+
new (input: DescribeExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeExecutionCommandInput, DescribeExecutionCommandOutput, IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeExecutionCommandInput, DescribeExecutionCommandOutput, IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves information about the execution.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { IoTSiteWiseClient, DescribeExecutionCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
35
|
+
* // const { IoTSiteWiseClient, DescribeExecutionCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
36
|
+
* const client = new IoTSiteWiseClient(config);
|
|
37
|
+
* const input = { // DescribeExecutionRequest
|
|
38
|
+
* executionId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeExecutionCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeExecutionResponse
|
|
43
|
+
* // executionId: "STRING_VALUE", // required
|
|
44
|
+
* // actionType: "STRING_VALUE",
|
|
45
|
+
* // targetResource: { // TargetResource
|
|
46
|
+
* // assetId: "STRING_VALUE",
|
|
47
|
+
* // computationModelId: "STRING_VALUE",
|
|
48
|
+
* // },
|
|
49
|
+
* // targetResourceVersion: "STRING_VALUE", // required
|
|
50
|
+
* // resolveTo: { // ResolveTo
|
|
51
|
+
* // assetId: "STRING_VALUE", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // executionStartTime: new Date("TIMESTAMP"), // required
|
|
54
|
+
* // executionEndTime: new Date("TIMESTAMP"),
|
|
55
|
+
* // executionStatus: { // ExecutionStatus
|
|
56
|
+
* // state: "RUNNING" || "COMPLETED" || "FAILED", // required
|
|
57
|
+
* // },
|
|
58
|
+
* // executionResult: { // ExecutionResult
|
|
59
|
+
* // "<keys>": "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // executionDetails: { // ExecutionDetails
|
|
62
|
+
* // "<keys>": "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // executionEntityVersion: "STRING_VALUE",
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
69
|
+
* @param DescribeExecutionCommandInput - {@link DescribeExecutionCommandInput}
|
|
70
|
+
* @returns {@link DescribeExecutionCommandOutput}
|
|
71
|
+
* @see {@link DescribeExecutionCommandInput} for command's `input` shape.
|
|
72
|
+
* @see {@link DescribeExecutionCommandOutput} for command's `response` shape.
|
|
73
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
76
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
79
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
80
|
+
* unsupported characters. Check your request and try again.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
83
|
+
* <p>The requested resource can't be found.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
86
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
87
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
88
|
+
* on.</p>
|
|
89
|
+
* <p>For more information, 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>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
93
|
+
*
|
|
94
|
+
*
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
export declare class DescribeExecutionCommand extends DescribeExecutionCommand_base {
|
|
98
|
+
/** @internal type navigation helper, not in runtime. */
|
|
99
|
+
protected static __types: {
|
|
100
|
+
api: {
|
|
101
|
+
input: DescribeExecutionRequest;
|
|
102
|
+
output: DescribeExecutionResponse;
|
|
103
|
+
};
|
|
104
|
+
sdk: {
|
|
105
|
+
input: DescribeExecutionCommandInput;
|
|
106
|
+
output: DescribeExecutionCommandOutput;
|
|
107
|
+
};
|
|
108
|
+
};
|
|
109
|
+
}
|
|
@@ -27,11 +27,24 @@ declare const DescribeGatewayCapabilityConfigurationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
30
|
+
* <p>Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.</p>
|
|
31
|
+
* <p>. The namespace follows the format <code>service:capability:version</code>, where:</p>
|
|
32
|
+
* <ul>
|
|
33
|
+
* <li>
|
|
34
|
+
* <p>
|
|
35
|
+
* <code>service</code> - The service providing the capability, or <code>iotsitewise</code>.</p>
|
|
36
|
+
* </li>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>
|
|
39
|
+
* <code>capability</code> - The specific capability type. Options include: <code>opcuacollector</code> for the OPC UA data source collector, or <code>publisher</code> for data publisher capability.</p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <code>version</code> - The version number of the capability. Option include <code>2</code> for Classic streams, V2 gateways, and <code>3</code> for MQTT-enabled, V3 gateways.</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* </ul>
|
|
46
|
+
* <p>After updating a capability configuration, the sync status becomes <code>OUT_OF_SYNC</code> until the gateway processes the configuration.Use <code>DescribeGatewayCapabilityConfiguration</code> to check the sync status and verify the configuration was applied.</p>
|
|
47
|
+
* <p>A gateway can have multiple capability configurations with different namespaces.</p>
|
|
35
48
|
* @example
|
|
36
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
50
|
* ```javascript
|
|
@@ -86,7 +86,7 @@ declare const DescribeStorageConfigurationCommand_base: {
|
|
|
86
86
|
* unsupported characters. Check your request and try again.</p>
|
|
87
87
|
*
|
|
88
88
|
* @throws {@link LimitExceededException} (client fault)
|
|
89
|
-
* <p>You've reached the
|
|
89
|
+
* <p>You've reached the quota for a resource. For example, this can occur if you're trying to
|
|
90
90
|
* associate more than the allowed number of child assets or attempting to create more than the
|
|
91
91
|
* allowed number of properties for an asset model.</p>
|
|
92
92
|
* <p>For more information, 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>
|