Skip to content

Commit 618b5ed

Browse files
author
awstools
committed
feat(client-iotfleetwise): This release adds an optional listResponseScope request parameter in certain list API requests to limit the response to metadata only.
1 parent 7ac960d commit 618b5ed

File tree

8 files changed

+122
-16
lines changed

8 files changed

+122
-16
lines changed

‎clients/client-iotfleetwise/src/commands/ListCampaignsCommand.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ export interface ListCampaignsCommandOutput extends ListCampaignsResponse, __Met
4242
* nextToken: "STRING_VALUE",
4343
* maxResults: Number("int"),
4444
* status: "STRING_VALUE",
45+
* listResponseScope: "METADATA_ONLY",
4546
* };
4647
* const command = new ListCampaignsCommand(input);
4748
* const response = await client.send(command);

‎clients/client-iotfleetwise/src/commands/ListDecoderManifestsCommand.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ export interface ListDecoderManifestsCommandOutput extends ListDecoderManifestsR
4242
* modelManifestArn: "STRING_VALUE",
4343
* nextToken: "STRING_VALUE",
4444
* maxResults: Number("int"),
45+
* listResponseScope: "METADATA_ONLY",
4546
* };
4647
* const command = new ListDecoderManifestsCommand(input);
4748
* const response = await client.send(command);

‎clients/client-iotfleetwise/src/commands/ListFleetsCommand.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ export interface ListFleetsCommandOutput extends ListFleetsResponse, __MetadataB
4141
* const input = { // ListFleetsRequest
4242
* nextToken: "STRING_VALUE",
4343
* maxResults: Number("int"),
44+
* listResponseScope: "METADATA_ONLY",
4445
* };
4546
* const command = new ListFleetsCommand(input);
4647
* const response = await client.send(command);

‎clients/client-iotfleetwise/src/commands/ListModelManifestsCommand.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ export interface ListModelManifestsCommandOutput extends ListModelManifestsRespo
4242
* signalCatalogArn: "STRING_VALUE",
4343
* nextToken: "STRING_VALUE",
4444
* maxResults: Number("int"),
45+
* listResponseScope: "METADATA_ONLY",
4546
* };
4647
* const command = new ListModelManifestsCommand(input);
4748
* const response = await client.send(command);

‎clients/client-iotfleetwise/src/commands/ListStateTemplatesCommand.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ export interface ListStateTemplatesCommandOutput extends ListStateTemplatesRespo
4141
* const input = { // ListStateTemplatesRequest
4242
* nextToken: "STRING_VALUE",
4343
* maxResults: Number("int"),
44+
* listResponseScope: "METADATA_ONLY",
4445
* };
4546
* const command = new ListStateTemplatesCommand(input);
4647
* const response = await client.send(command);

‎clients/client-iotfleetwise/src/commands/ListVehiclesCommand.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ export interface ListVehiclesCommandOutput extends ListVehiclesResponse, __Metad
4848
* ],
4949
* nextToken: "STRING_VALUE",
5050
* maxResults: Number("int"),
51+
* listResponseScope: "METADATA_ONLY",
5152
* };
5253
* const command = new ListVehiclesCommand(input);
5354
* const response = await client.send(command);

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

Lines changed: 55 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,7 @@ export namespace StateTemplateUpdateStrategy {
585585
*/
586586
export interface StateTemplateAssociation {
587587
/**
588-
* <p>A unique, service-generated identifier.</p>
588+
* <p>The unique ID of the state template.</p>
589589
* @public
590590
*/
591591
identifier: string | undefined;
@@ -2047,6 +2047,19 @@ export interface GetCampaignResponse {
20472047
signalsToFetch?: SignalFetchInformation[] | undefined;
20482048
}
20492049

2050+
/**
2051+
* @public
2052+
* @enum
2053+
*/
2054+
export const ListResponseScope = {
2055+
METADATA_ONLY: "METADATA_ONLY",
2056+
} as const;
2057+
2058+
/**
2059+
* @public
2060+
*/
2061+
export type ListResponseScope = (typeof ListResponseScope)[keyof typeof ListResponseScope];
2062+
20502063
/**
20512064
* @public
20522065
*/
@@ -2072,6 +2085,12 @@ export interface ListCampaignsRequest {
20722085
* @public
20732086
*/
20742087
status?: string | undefined;
2088+
2089+
/**
2090+
* <p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time.</p>
2091+
* @public
2092+
*/
2093+
listResponseScope?: ListResponseScope | undefined;
20752094
}
20762095

20772096
/**
@@ -3919,6 +3938,12 @@ export interface ListDecoderManifestsRequest {
39193938
* @public
39203939
*/
39213940
maxResults?: number | undefined;
3941+
3942+
/**
3943+
* <p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: decoder manifest name, Amazon Resource Name (ARN), creation time, and last modification time.</p>
3944+
* @public
3945+
*/
3946+
listResponseScope?: ListResponseScope | undefined;
39223947
}
39233948

39243949
/**
@@ -4131,7 +4156,7 @@ export interface DeleteSignalCatalogResponse {
41314156
*/
41324157
export interface DeleteStateTemplateRequest {
41334158
/**
4134-
* <p>A unique, service-generated identifier.</p>
4159+
* <p>The unique ID of the state template.</p>
41354160
* @public
41364161
*/
41374162
identifier: string | undefined;
@@ -4350,6 +4375,12 @@ export interface ListFleetsRequest {
43504375
* @public
43514376
*/
43524377
maxResults?: number | undefined;
4378+
4379+
/**
4380+
* <p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: fleet ID, Amazon Resource Name (ARN), creation time, and last modification time.</p>
4381+
* @public
4382+
*/
4383+
listResponseScope?: ListResponseScope | undefined;
43534384
}
43544385

43554386
/**
@@ -4916,7 +4947,7 @@ export interface GetSignalCatalogResponse {
49164947
*/
49174948
export interface GetStateTemplateRequest {
49184949
/**
4919-
* <p>A unique, service-generated identifier.</p>
4950+
* <p>The unique ID of the state template.</p>
49204951
* @public
49214952
*/
49224953
identifier: string | undefined;
@@ -5320,6 +5351,12 @@ export interface ListModelManifestsRequest {
53205351
* @public
53215352
*/
53225353
maxResults?: number | undefined;
5354+
5355+
/**
5356+
* <p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: model manifest name, Amazon Resource Name (ARN), creation time, and last modification time.</p>
5357+
* @public
5358+
*/
5359+
listResponseScope?: ListResponseScope | undefined;
53235360
}
53245361

53255362
/**
@@ -5786,6 +5823,12 @@ export interface ListStateTemplatesRequest {
57865823
* @public
57875824
*/
57885825
maxResults?: number | undefined;
5826+
5827+
/**
5828+
* <p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time.</p>
5829+
* @public
5830+
*/
5831+
listResponseScope?: ListResponseScope | undefined;
57895832
}
57905833

57915834
/**
@@ -5861,7 +5904,7 @@ export interface ListStateTemplatesResponse {
58615904
*/
58625905
export interface UpdateStateTemplateRequest {
58635906
/**
5864-
* <p>A unique, service-generated identifier.</p>
5907+
* <p>The unique ID of the state template.</p>
58655908
* @public
58665909
*/
58675910
identifier: string | undefined;
@@ -6026,6 +6069,12 @@ export interface ListVehiclesRequest {
60266069
* @public
60276070
*/
60286071
maxResults?: number | undefined;
6072+
6073+
/**
6074+
* <p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: vehicle name, Amazon Resource Name (ARN), creation time, and last modification time.</p>
6075+
* @public
6076+
*/
6077+
listResponseScope?: ListResponseScope | undefined;
60296078
}
60306079

60316080
/**
@@ -6604,9 +6653,7 @@ export const CreateCampaignRequestFilterSensitiveLog = (obj: CreateCampaignReque
66046653
...(obj.dataPartitions && {
66056654
dataPartitions: obj.dataPartitions.map((item) => DataPartitionFilterSensitiveLog(item)),
66066655
}),
6607-
...(obj.signalsToFetch && {
6608-
signalsToFetch: obj.signalsToFetch.map((item) => SignalFetchInformationFilterSensitiveLog(item)),
6609-
}),
6656+
...(obj.signalsToFetch && { signalsToFetch: SENSITIVE_STRING }),
66106657
});
66116658

66126659
/**
@@ -6621,9 +6668,7 @@ export const GetCampaignResponseFilterSensitiveLog = (obj: GetCampaignResponse):
66216668
...(obj.dataPartitions && {
66226669
dataPartitions: obj.dataPartitions.map((item) => DataPartitionFilterSensitiveLog(item)),
66236670
}),
6624-
...(obj.signalsToFetch && {
6625-
signalsToFetch: obj.signalsToFetch.map((item) => SignalFetchInformationFilterSensitiveLog(item)),
6626-
}),
6671+
...(obj.signalsToFetch && { signalsToFetch: SENSITIVE_STRING }),
66276672
});
66286673

66296674
/**

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

Lines changed: 61 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1896,7 +1896,7 @@
18961896
"traits": {
18971897
"smithy.api#length": {
18981898
"min": 1,
1899-
"max": 1
1899+
"max": 3
19001900
}
19011901
}
19021902
},
@@ -2528,7 +2528,7 @@
25282528
"identifier": {
25292529
"target": "com.amazonaws.iotfleetwise#ResourceIdentifier",
25302530
"traits": {
2531-
"smithy.api#documentation": "<p>A unique, service-generated identifier.</p>",
2531+
"smithy.api#documentation": "<p>The unique ID of the state template.</p>",
25322532
"smithy.api#httpLabel": {},
25332533
"smithy.api#required": {}
25342534
}
@@ -3700,7 +3700,7 @@
37003700
"identifier": {
37013701
"target": "com.amazonaws.iotfleetwise#ResourceIdentifier",
37023702
"traits": {
3703-
"smithy.api#documentation": "<p>A unique, service-generated identifier.</p>",
3703+
"smithy.api#documentation": "<p>The unique ID of the state template.</p>",
37043704
"smithy.api#httpLabel": {},
37053705
"smithy.api#required": {}
37063706
}
@@ -5175,6 +5175,13 @@
51755175
"smithy.api#documentation": "<p>An optional parameter to filter the results by the status of each created campaign in\n your account. The status can be one of: <code>CREATING</code>,\n <code>WAITING_FOR_APPROVAL</code>, <code>RUNNING</code>, or\n <code>SUSPENDED</code>.</p>",
51765176
"smithy.api#httpQuery": "status"
51775177
}
5178+
},
5179+
"listResponseScope": {
5180+
"target": "com.amazonaws.iotfleetwise#ListResponseScope",
5181+
"traits": {
5182+
"smithy.api#documentation": "<p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: campaign name, Amazon Resource Name (ARN), creation time, and last modification time.</p>",
5183+
"smithy.api#httpQuery": "listResponseScope"
5184+
}
51785185
}
51795186
}
51805187
},
@@ -5426,6 +5433,13 @@
54265433
"smithy.api#documentation": "<p>The maximum number of items to return, between 1 and 100, inclusive.</p>",
54275434
"smithy.api#httpQuery": "maxResults"
54285435
}
5436+
},
5437+
"listResponseScope": {
5438+
"target": "com.amazonaws.iotfleetwise#ListResponseScope",
5439+
"traits": {
5440+
"smithy.api#documentation": "<p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: decoder manifest name, Amazon Resource Name (ARN), creation time, and last modification time.</p>",
5441+
"smithy.api#httpQuery": "listResponseScope"
5442+
}
54295443
}
54305444
}
54315445
},
@@ -5588,6 +5602,13 @@
55885602
"smithy.api#documentation": "<p>The maximum number of items to return, between 1 and 100, inclusive.</p>",
55895603
"smithy.api#httpQuery": "maxResults"
55905604
}
5605+
},
5606+
"listResponseScope": {
5607+
"target": "com.amazonaws.iotfleetwise#ListResponseScope",
5608+
"traits": {
5609+
"smithy.api#documentation": "<p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: fleet ID, Amazon Resource Name (ARN), creation time, and last modification time.</p>",
5610+
"smithy.api#httpQuery": "listResponseScope"
5611+
}
55915612
}
55925613
}
55935614
},
@@ -5757,6 +5778,13 @@
57575778
"smithy.api#documentation": "<p>The maximum number of items to return, between 1 and 100, inclusive.</p>",
57585779
"smithy.api#httpQuery": "maxResults"
57595780
}
5781+
},
5782+
"listResponseScope": {
5783+
"target": "com.amazonaws.iotfleetwise#ListResponseScope",
5784+
"traits": {
5785+
"smithy.api#documentation": "<p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: model manifest name, Amazon Resource Name (ARN), creation time, and last modification time.</p>",
5786+
"smithy.api#httpQuery": "listResponseScope"
5787+
}
57605788
}
57615789
}
57625790
},
@@ -5777,6 +5805,17 @@
57775805
}
57785806
}
57795807
},
5808+
"com.amazonaws.iotfleetwise#ListResponseScope": {
5809+
"type": "enum",
5810+
"members": {
5811+
"METADATA_ONLY": {
5812+
"target": "smithy.api#Unit",
5813+
"traits": {
5814+
"smithy.api#enumValue": "METADATA_ONLY"
5815+
}
5816+
}
5817+
}
5818+
},
57805819
"com.amazonaws.iotfleetwise#ListSignalCatalogNodes": {
57815820
"type": "operation",
57825821
"input": {
@@ -6000,6 +6039,13 @@
60006039
"smithy.api#documentation": "<p>The maximum number of items to return, between 1 and 100, inclusive.</p>",
60016040
"smithy.api#httpQuery": "maxResults"
60026041
}
6042+
},
6043+
"listResponseScope": {
6044+
"target": "com.amazonaws.iotfleetwise#ListResponseScope",
6045+
"traits": {
6046+
"smithy.api#documentation": "<p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: state template ID, Amazon Resource Name (ARN), creation time, and last modification time.</p>",
6047+
"smithy.api#httpQuery": "listResponseScope"
6048+
}
60036049
}
60046050
},
60056051
"traits": {
@@ -6245,6 +6291,13 @@
62456291
"smithy.api#documentation": "<p>The maximum number of items to return, between 1 and 100, inclusive.</p>",
62466292
"smithy.api#httpQuery": "maxResults"
62476293
}
6294+
},
6295+
"listResponseScope": {
6296+
"target": "com.amazonaws.iotfleetwise#ListResponseScope",
6297+
"traits": {
6298+
"smithy.api#documentation": "<p>When you set the <code>listResponseScope</code> parameter to <code>METADATA_ONLY</code>, the list response includes: vehicle name, Amazon Resource Name (ARN), creation time, and last modification time.</p>",
6299+
"smithy.api#httpQuery": "listResponseScope"
6300+
}
62486301
}
62496302
}
62506303
},
@@ -8085,10 +8138,12 @@
80858138
"target": "com.amazonaws.iotfleetwise#SignalFetchInformation"
80868139
},
80878140
"traits": {
8141+
"aws.api#data": "content",
80888142
"smithy.api#length": {
80898143
"min": 1,
80908144
"max": 2
8091-
}
8145+
},
8146+
"smithy.api#sensitive": {}
80928147
}
80938148
},
80948149
"com.amazonaws.iotfleetwise#SignalInformation": {
@@ -8202,7 +8257,7 @@
82028257
"identifier": {
82038258
"target": "com.amazonaws.iotfleetwise#ResourceIdentifier",
82048259
"traits": {
8205-
"smithy.api#documentation": "<p>A unique, service-generated identifier.</p>",
8260+
"smithy.api#documentation": "<p>The unique ID of the state template.</p>",
82068261
"smithy.api#required": {}
82078262
}
82088263
},
@@ -9672,7 +9727,7 @@
96729727
"identifier": {
96739728
"target": "com.amazonaws.iotfleetwise#ResourceIdentifier",
96749729
"traits": {
9675-
"smithy.api#documentation": "<p>A unique, service-generated identifier.</p>",
9730+
"smithy.api#documentation": "<p>The unique ID of the state template.</p>",
96769731
"smithy.api#httpLabel": {},
96779732
"smithy.api#required": {}
96789733
}

0 commit comments

Comments
 (0)