Skip to content

Commit fa8249d

Browse files
author
awstools
committed
feat(client-iotsitewise): AWS IoT SiteWise now supports MQTT-enabled, V3 gateways. Configure data destinations for real-time ingestion into AWS IoT SiteWise or buffered ingestion using Amazon S3 storage. You can also use path filters for precise data collection from specific MQTT topics.
1 parent bede5ab commit fa8249d

File tree

8 files changed

+133
-18
lines changed

8 files changed

+133
-18
lines changed

‎clients/client-iotsitewise/src/commands/CreateGatewayCommand.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,13 @@ export interface CreateGatewayCommandOutput extends CreateGatewayResponse, __Met
4545
* },
4646
* greengrassV2: { // GreengrassV2
4747
* coreDeviceThingName: "STRING_VALUE", // required
48+
* coreDeviceOperatingSystem: "LINUX_AARCH64" || "LINUX_AMD64" || "WINDOWS_AMD64",
4849
* },
4950
* siemensIE: { // SiemensIE
5051
* iotCoreThingName: "STRING_VALUE", // required
5152
* },
5253
* },
54+
* gatewayVersion: "STRING_VALUE",
5355
* tags: { // TagMap
5456
* "<keys>": "STRING_VALUE",
5557
* },

‎clients/client-iotsitewise/src/commands/DescribeGatewayCommand.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,13 @@ export interface DescribeGatewayCommandOutput extends DescribeGatewayResponse, _
5050
* // },
5151
* // greengrassV2: { // GreengrassV2
5252
* // coreDeviceThingName: "STRING_VALUE", // required
53+
* // coreDeviceOperatingSystem: "LINUX_AARCH64" || "LINUX_AMD64" || "WINDOWS_AMD64",
5354
* // },
5455
* // siemensIE: { // SiemensIE
5556
* // iotCoreThingName: "STRING_VALUE", // required
5657
* // },
5758
* // },
59+
* // gatewayVersion: "STRING_VALUE",
5860
* // gatewayCapabilitySummaries: [ // GatewayCapabilitySummaries // required
5961
* // { // GatewayCapabilitySummary
6062
* // capabilityNamespace: "STRING_VALUE", // required

‎clients/client-iotsitewise/src/commands/ListAssetsCommand.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
88
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
9-
import { ListAssetsRequest, ListAssetsResponse } from "../models/models_0";
9+
import { ListAssetsRequest } from "../models/models_0";
10+
import { ListAssetsResponse } from "../models/models_1";
1011
import { de_ListAssetsCommand, se_ListAssetsCommand } from "../protocols/Aws_restJson1";
1112

1213
/**

‎clients/client-iotsitewise/src/commands/ListGatewaysCommand.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,13 @@ export interface ListGatewaysCommandOutput extends ListGatewaysResponse, __Metad
5252
* // },
5353
* // greengrassV2: { // GreengrassV2
5454
* // coreDeviceThingName: "STRING_VALUE", // required
55+
* // coreDeviceOperatingSystem: "LINUX_AARCH64" || "LINUX_AMD64" || "WINDOWS_AMD64",
5556
* // },
5657
* // siemensIE: { // SiemensIE
5758
* // iotCoreThingName: "STRING_VALUE", // required
5859
* // },
5960
* // },
61+
* // gatewayVersion: "STRING_VALUE",
6062
* // gatewayCapabilitySummaries: [ // GatewayCapabilitySummaries
6163
* // { // GatewayCapabilitySummary
6264
* // capabilityNamespace: "STRING_VALUE", // required

‎clients/client-iotsitewise/src/models/models_0.ts‎

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4307,6 +4307,21 @@ export interface Greengrass {
43074307
groupArn: string | undefined;
43084308
}
43094309

4310+
/**
4311+
* @public
4312+
* @enum
4313+
*/
4314+
export const CoreDeviceOperatingSystem = {
4315+
LINUX_AARCH64: "LINUX_AARCH64",
4316+
LINUX_AMD64: "LINUX_AMD64",
4317+
WINDOWS_AMD64: "WINDOWS_AMD64",
4318+
} as const;
4319+
4320+
/**
4321+
* @public
4322+
*/
4323+
export type CoreDeviceOperatingSystem = (typeof CoreDeviceOperatingSystem)[keyof typeof CoreDeviceOperatingSystem];
4324+
43104325
/**
43114326
* <p>Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2,
43124327
* you must deploy the IoT SiteWise Edge component to your gateway device. Your <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html">Greengrass
@@ -4321,6 +4336,12 @@ export interface GreengrassV2 {
43214336
* @public
43224337
*/
43234338
coreDeviceThingName: string | undefined;
4339+
4340+
/**
4341+
* <p>The operating system of the core device in IoT Greengrass V2.</p>
4342+
* @public
4343+
*/
4344+
coreDeviceOperatingSystem?: CoreDeviceOperatingSystem | undefined;
43244345
}
43254346

43264347
/**
@@ -4376,6 +4397,18 @@ export interface CreateGatewayRequest {
43764397
*/
43774398
gatewayPlatform: GatewayPlatform | undefined;
43784399

4400+
/**
4401+
* <p>The version of the gateway to create. Specify <code>3</code> to create an MQTT-enabled, V3
4402+
* gateway and <code>2</code> To create a Classic streams, V2 gateway. If the version isn't
4403+
* specified, a Classic streams, V2 gateway is created by default.</p>
4404+
* <p> We recommend creating an MQTT-enabled, V3 gateway for self-hosted gateways. SiteWise Edge
4405+
* gateways on Siemens Industrial Edge should use gateway version <code>2</code>. For more information on
4406+
* gateway versions, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gw-self-host-gg2.html"> Self-host a SiteWise Edge
4407+
* gateway with IoT Greengrass V2</a>.</p>
4408+
* @public
4409+
*/
4410+
gatewayVersion?: string | undefined;
4411+
43794412
/**
43804413
* <p>A list of key-value pairs that contain metadata for the gateway. For more information, see
43814414
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
@@ -6246,6 +6279,13 @@ export interface DescribeGatewayResponse {
62466279
*/
62476280
gatewayPlatform?: GatewayPlatform | undefined;
62486281

6282+
/**
6283+
* <p>The version of the gateway. A value of <code>3</code> indicates an MQTT-enabled, V3
6284+
* gateway, while <code>2</code> indicates a Classic streams, V2 gateway.</p>
6285+
* @public
6286+
*/
6287+
gatewayVersion?: string | undefined;
6288+
62496289
/**
62506290
* <p>A list of gateway capability summaries that each contain a namespace and status. Each
62516291
* gateway capability defines data sources for the gateway. To retrieve a capability
@@ -8478,23 +8518,6 @@ export interface ListAssetsRequest {
84788518
filter?: ListAssetsFilter | undefined;
84798519
}
84808520

8481-
/**
8482-
* @public
8483-
*/
8484-
export interface ListAssetsResponse {
8485-
/**
8486-
* <p>A list that summarizes each asset.</p>
8487-
* @public
8488-
*/
8489-
assetSummaries: AssetSummary[] | undefined;
8490-
8491-
/**
8492-
* <p>The token for the next set of results, or null if there are no additional results.</p>
8493-
* @public
8494-
*/
8495-
nextToken?: string | undefined;
8496-
}
8497-
84988521
/**
84998522
* @internal
85008523
*/

‎clients/client-iotsitewise/src/models/models_1.ts‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import {
1212
AssetModelStatus,
1313
AssetModelVersionType,
1414
AssetStatus,
15+
AssetSummary,
1516
AssociatedAssetsSummary,
1617
CapabilitySyncStatus,
1718
ColumnInfo,
@@ -41,6 +42,23 @@ import {
4142
WarmTierState,
4243
} from "./models_0";
4344

45+
/**
46+
* @public
47+
*/
48+
export interface ListAssetsResponse {
49+
/**
50+
* <p>A list that summarizes each asset.</p>
51+
* @public
52+
*/
53+
assetSummaries: AssetSummary[] | undefined;
54+
55+
/**
56+
* <p>The token for the next set of results, or null if there are no additional results.</p>
57+
* @public
58+
*/
59+
nextToken?: string | undefined;
60+
}
61+
4462
/**
4563
* @public
4664
* @enum
@@ -513,6 +531,13 @@ export interface GatewaySummary {
513531
*/
514532
gatewayPlatform?: GatewayPlatform | undefined;
515533

534+
/**
535+
* <p>The version of the gateway. A value of <code>3</code> indicates an MQTT-enabled, V3
536+
* gateway, while <code>2</code> indicates a Classic streams, V2 gateway.</p>
537+
* @public
538+
*/
539+
gatewayVersion?: string | undefined;
540+
516541
/**
517542
* <p>A list of gateway capability summaries that each contain a namespace and status. Each
518543
* gateway capability defines data sources for the gateway. To retrieve a capability

‎clients/client-iotsitewise/src/protocols/Aws_restJson1.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -875,6 +875,7 @@ export const se_CreateGatewayCommand = async (
875875
take(input, {
876876
gatewayName: [],
877877
gatewayPlatform: (_) => _json(_),
878+
gatewayVersion: [],
878879
tags: (_) => _json(_),
879880
})
880881
);
@@ -4011,6 +4012,7 @@ export const de_DescribeGatewayCommand = async (
40114012
gatewayId: __expectString,
40124013
gatewayName: __expectString,
40134014
gatewayPlatform: _json,
4015+
gatewayVersion: __expectString,
40144016
lastUpdateDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
40154017
});
40164018
Object.assign(contents, doc);
@@ -6560,6 +6562,7 @@ const de_GatewaySummary = (output: any, context: __SerdeContext): GatewaySummary
65606562
gatewayId: __expectString,
65616563
gatewayName: __expectString,
65626564
gatewayPlatform: _json,
6565+
gatewayVersion: __expectString,
65636566
lastUpdateDate: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
65646567
}) as any;
65656568
};

‎codegen/sdk-codegen/aws-models/iotsitewise.json‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4773,6 +4773,29 @@
47734773
"smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
47744774
}
47754775
},
4776+
"com.amazonaws.iotsitewise#CoreDeviceOperatingSystem": {
4777+
"type": "enum",
4778+
"members": {
4779+
"LINUX_AARCH64": {
4780+
"target": "smithy.api#Unit",
4781+
"traits": {
4782+
"smithy.api#enumValue": "LINUX_AARCH64"
4783+
}
4784+
},
4785+
"LINUX_AMD64": {
4786+
"target": "smithy.api#Unit",
4787+
"traits": {
4788+
"smithy.api#enumValue": "LINUX_AMD64"
4789+
}
4790+
},
4791+
"WINDOWS_AMD64": {
4792+
"target": "smithy.api#Unit",
4793+
"traits": {
4794+
"smithy.api#enumValue": "WINDOWS_AMD64"
4795+
}
4796+
}
4797+
}
4798+
},
47764799
"com.amazonaws.iotsitewise#CoreDeviceThingName": {
47774800
"type": "string",
47784801
"traits": {
@@ -5726,6 +5749,12 @@
57265749
"smithy.api#required": {}
57275750
}
57285751
},
5752+
"gatewayVersion": {
5753+
"target": "com.amazonaws.iotsitewise#GatewayVersion",
5754+
"traits": {
5755+
"smithy.api#documentation": "<p>The version of the gateway to create. Specify <code>3</code> to create an MQTT-enabled, V3\n gateway and <code>2</code> To create a Classic streams, V2 gateway. If the version isn't\n specified, a Classic streams, V2 gateway is created by default.</p>\n <p> We recommend creating an MQTT-enabled, V3 gateway for self-hosted gateways. SiteWise Edge\n gateways on Siemens Industrial Edge should use gateway version <code>2</code>. For more information on\n gateway versions, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gw-self-host-gg2.html\"> Self-host a SiteWise Edge\n gateway with IoT Greengrass V2</a>.</p>"
5756+
}
5757+
},
57295758
"tags": {
57305759
"target": "com.amazonaws.iotsitewise#TagMap",
57315760
"traits": {
@@ -8709,6 +8738,12 @@
87098738
"smithy.api#documentation": "<p>The gateway's platform.</p>"
87108739
}
87118740
},
8741+
"gatewayVersion": {
8742+
"target": "com.amazonaws.iotsitewise#GatewayVersion",
8743+
"traits": {
8744+
"smithy.api#documentation": "<p>The version of the gateway. A value of <code>3</code> indicates an MQTT-enabled, V3\n gateway, while <code>2</code> indicates a Classic streams, V2 gateway.</p>"
8745+
}
8746+
},
87128747
"gatewayCapabilitySummaries": {
87138748
"target": "com.amazonaws.iotsitewise#GatewayCapabilitySummaries",
87148749
"traits": {
@@ -10124,6 +10159,12 @@
1012410159
"gatewayPlatform": {
1012510160
"target": "com.amazonaws.iotsitewise#GatewayPlatform"
1012610161
},
10162+
"gatewayVersion": {
10163+
"target": "com.amazonaws.iotsitewise#GatewayVersion",
10164+
"traits": {
10165+
"smithy.api#documentation": "<p>The version of the gateway. A value of <code>3</code> indicates an MQTT-enabled, V3\n gateway, while <code>2</code> indicates a Classic streams, V2 gateway.</p>"
10166+
}
10167+
},
1012710168
"gatewayCapabilitySummaries": {
1012810169
"target": "com.amazonaws.iotsitewise#GatewayCapabilitySummaries",
1012910170
"traits": {
@@ -10149,6 +10190,16 @@
1014910190
"smithy.api#documentation": "<p>Contains a summary of a gateway.</p>"
1015010191
}
1015110192
},
10193+
"com.amazonaws.iotsitewise#GatewayVersion": {
10194+
"type": "string",
10195+
"traits": {
10196+
"smithy.api#length": {
10197+
"min": 1,
10198+
"max": 1024
10199+
},
10200+
"smithy.api#pattern": "^[0-9]+$"
10201+
}
10202+
},
1015210203
"com.amazonaws.iotsitewise#GetAssetPropertyAggregates": {
1015310204
"type": "operation",
1015410205
"input": {
@@ -10725,6 +10776,12 @@
1072510776
"smithy.api#documentation": "<p>The name of the IoT thing for your IoT Greengrass V2 core device.</p>",
1072610777
"smithy.api#required": {}
1072710778
}
10779+
},
10780+
"coreDeviceOperatingSystem": {
10781+
"target": "com.amazonaws.iotsitewise#CoreDeviceOperatingSystem",
10782+
"traits": {
10783+
"smithy.api#documentation": "<p>The operating system of the core device in IoT Greengrass V2.</p>"
10784+
}
1072810785
}
1072910786
},
1073010787
"traits": {

0 commit comments

Comments
 (0)