feat(client-iotfleetwise): This release adds an optional listResponse…

…Scope request parameter in certain list API requests to limit the response to metadata only.
aws · Feb 26, 2025 · 618b5ed · 618b5ed
1 parent 7ac960d
commit 618b5ed
Show file tree

Hide file tree

Showing 8 changed files with 122 additions and 16 deletions.
diff --git a/clients/client-iotfleetwise/src/commands/ListCampaignsCommand.ts b/clients/client-iotfleetwise/src/commands/ListCampaignsCommand.ts
@@ -42,6 +42,7 @@ export interface ListCampaignsCommandOutput extends ListCampaignsResponse, __Met
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
  *   status: "STRING_VALUE",
+ *   listResponseScope: "METADATA_ONLY",
  * };
  * const command = new ListCampaignsCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-iotfleetwise/src/commands/ListDecoderManifestsCommand.ts b/clients/client-iotfleetwise/src/commands/ListDecoderManifestsCommand.ts
@@ -42,6 +42,7 @@ export interface ListDecoderManifestsCommandOutput extends ListDecoderManifestsR
  *   modelManifestArn: "STRING_VALUE",
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
+ *   listResponseScope: "METADATA_ONLY",
  * };
  * const command = new ListDecoderManifestsCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-iotfleetwise/src/commands/ListFleetsCommand.ts b/clients/client-iotfleetwise/src/commands/ListFleetsCommand.ts
@@ -41,6 +41,7 @@ export interface ListFleetsCommandOutput extends ListFleetsResponse, __MetadataB
  * const input = { // ListFleetsRequest
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
+ *   listResponseScope: "METADATA_ONLY",
  * };
  * const command = new ListFleetsCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-iotfleetwise/src/commands/ListModelManifestsCommand.ts b/clients/client-iotfleetwise/src/commands/ListModelManifestsCommand.ts
@@ -42,6 +42,7 @@ export interface ListModelManifestsCommandOutput extends ListModelManifestsRespo
  *   signalCatalogArn: "STRING_VALUE",
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
+ *   listResponseScope: "METADATA_ONLY",
  * };
  * const command = new ListModelManifestsCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-iotfleetwise/src/commands/ListStateTemplatesCommand.ts b/clients/client-iotfleetwise/src/commands/ListStateTemplatesCommand.ts
@@ -41,6 +41,7 @@ export interface ListStateTemplatesCommandOutput extends ListStateTemplatesRespo
  * const input = { // ListStateTemplatesRequest
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
+ *   listResponseScope: "METADATA_ONLY",
  * };
  * const command = new ListStateTemplatesCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-iotfleetwise/src/commands/ListVehiclesCommand.ts b/clients/client-iotfleetwise/src/commands/ListVehiclesCommand.ts
@@ -48,6 +48,7 @@ export interface ListVehiclesCommandOutput extends ListVehiclesResponse, __Metad
  *   ],
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
+ *   listResponseScope: "METADATA_ONLY",
  * };
  * const command = new ListVehiclesCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-iotfleetwise/src/models/models_0.ts b/clients/client-iotfleetwise/src/models/models_0.ts
@@ -585,7 +585,7 @@ export namespace StateTemplateUpdateStrategy {
  */
 export interface StateTemplateAssociation {
   /**
-   * <p>A unique, service-generated identifier.</p>
+   * <p>The unique ID of the state template.</p>
    * @public
    */
   identifier: string | undefined;
@@ -2047,6 +2047,19 @@ export interface GetCampaignResponse {
   signalsToFetch?: SignalFetchInformation[] | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const ListResponseScope = {
+  METADATA_ONLY: "METADATA_ONLY",
+} as const;
+
+/**
+ * @public
+ */
+export type ListResponseScope = (typeof ListResponseScope)[keyof typeof ListResponseScope];
+
 /**
  * @public
  */
@@ -2072,6 +2085,12 @@ export interface ListCampaignsRequest {
    * @public
    */
   status?: string | undefined;
+
+  /**
+   * <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>
+   * @public
+   */
+  listResponseScope?: ListResponseScope | undefined;
 }
 
 /**
@@ -3919,6 +3938,12 @@ export interface ListDecoderManifestsRequest {
    * @public
    */
   maxResults?: number | undefined;
+
+  /**
+   * <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>
+   * @public
+   */
+  listResponseScope?: ListResponseScope | undefined;
 }
 
 /**
@@ -4131,7 +4156,7 @@ export interface DeleteSignalCatalogResponse {
  */
 export interface DeleteStateTemplateRequest {
   /**
-   * <p>A unique, service-generated identifier.</p>
+   * <p>The unique ID of the state template.</p>
    * @public
    */
   identifier: string | undefined;
@@ -4350,6 +4375,12 @@ export interface ListFleetsRequest {
    * @public
    */
   maxResults?: number | undefined;
+
+  /**
+   * <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>
+   * @public
+   */
+  listResponseScope?: ListResponseScope | undefined;
 }
 
 /**
@@ -4916,7 +4947,7 @@ export interface GetSignalCatalogResponse {
  */
 export interface GetStateTemplateRequest {
   /**
-   * <p>A unique, service-generated identifier.</p>
+   * <p>The unique ID of the state template.</p>
    * @public
    */
   identifier: string | undefined;
@@ -5320,6 +5351,12 @@ export interface ListModelManifestsRequest {
    * @public
    */
   maxResults?: number | undefined;
+
+  /**
+   * <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>
+   * @public
+   */
+  listResponseScope?: ListResponseScope | undefined;
 }
 
 /**
@@ -5786,6 +5823,12 @@ export interface ListStateTemplatesRequest {
    * @public
    */
   maxResults?: number | undefined;
+
+  /**
+   * <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>
+   * @public
+   */
+  listResponseScope?: ListResponseScope | undefined;
 }
 
 /**
@@ -5861,7 +5904,7 @@ export interface ListStateTemplatesResponse {
  */
 export interface UpdateStateTemplateRequest {
   /**
-   * <p>A unique, service-generated identifier.</p>
+   * <p>The unique ID of the state template.</p>
    * @public
    */
   identifier: string | undefined;
@@ -6026,6 +6069,12 @@ export interface ListVehiclesRequest {
    * @public
    */
   maxResults?: number | undefined;
+
+  /**
+   * <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>
+   * @public
+   */
+  listResponseScope?: ListResponseScope | undefined;
 }
 
 /**
@@ -6604,9 +6653,7 @@ export const CreateCampaignRequestFilterSensitiveLog = (obj: CreateCampaignReque
   ...(obj.dataPartitions && {
     dataPartitions: obj.dataPartitions.map((item) => DataPartitionFilterSensitiveLog(item)),
   }),
-  ...(obj.signalsToFetch && {
-    signalsToFetch: obj.signalsToFetch.map((item) => SignalFetchInformationFilterSensitiveLog(item)),
-  }),
+  ...(obj.signalsToFetch && { signalsToFetch: SENSITIVE_STRING }),
 });
 
 /**
@@ -6621,9 +6668,7 @@ export const GetCampaignResponseFilterSensitiveLog = (obj: GetCampaignResponse):
   ...(obj.dataPartitions && {
     dataPartitions: obj.dataPartitions.map((item) => DataPartitionFilterSensitiveLog(item)),
   }),
-  ...(obj.signalsToFetch && {
-    signalsToFetch: obj.signalsToFetch.map((item) => SignalFetchInformationFilterSensitiveLog(item)),
-  }),
+  ...(obj.signalsToFetch && { signalsToFetch: SENSITIVE_STRING }),
 });
 
 /**

diff --git a/codegen/sdk-codegen/aws-models/iotfleetwise.json b/codegen/sdk-codegen/aws-models/iotfleetwise.json
@@ -1896,7 +1896,7 @@
       "traits": {
         "smithy.api#length": {
           "min": 1,
-          "max": 1
+          "max": 3
         }
       }
     },
@@ -2528,7 +2528,7 @@
         "identifier": {
           "target": "com.amazonaws.iotfleetwise#ResourceIdentifier",
           "traits": {
-            "smithy.api#documentation": "<p>A unique, service-generated identifier.</p>",
+            "smithy.api#documentation": "<p>The unique ID of the state template.</p>",
             "smithy.api#httpLabel": {},
             "smithy.api#required": {}
           }
@@ -3700,7 +3700,7 @@
         "identifier": {
           "target": "com.amazonaws.iotfleetwise#ResourceIdentifier",
           "traits": {
-            "smithy.api#documentation": "<p>A unique, service-generated identifier.</p>",
+            "smithy.api#documentation": "<p>The unique ID of the state template.</p>",
             "smithy.api#httpLabel": {},
             "smithy.api#required": {}
           }
@@ -5175,6 +5175,13 @@
             "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>",
             "smithy.api#httpQuery": "status"
           }
+        },
+        "listResponseScope": {
+          "target": "com.amazonaws.iotfleetwise#ListResponseScope",
+          "traits": {
+            "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>",
+            "smithy.api#httpQuery": "listResponseScope"
+          }
         }
       }
     },
@@ -5426,6 +5433,13 @@
             "smithy.api#documentation": "<p>The maximum number of items to return, between 1 and 100, inclusive.</p>",
             "smithy.api#httpQuery": "maxResults"
           }
+        },
+        "listResponseScope": {
+          "target": "com.amazonaws.iotfleetwise#ListResponseScope",
+          "traits": {
+            "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>",
+            "smithy.api#httpQuery": "listResponseScope"
+          }
         }
       }
     },
@@ -5588,6 +5602,13 @@
             "smithy.api#documentation": "<p>The maximum number of items to return, between 1 and 100, inclusive.</p>",
             "smithy.api#httpQuery": "maxResults"
           }
+        },
+        "listResponseScope": {
+          "target": "com.amazonaws.iotfleetwise#ListResponseScope",
+          "traits": {
+            "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>",
+            "smithy.api#httpQuery": "listResponseScope"
+          }
         }
       }
     },
@@ -5757,6 +5778,13 @@
             "smithy.api#documentation": "<p>The maximum number of items to return, between 1 and 100, inclusive.</p>",
             "smithy.api#httpQuery": "maxResults"
           }
+        },
+        "listResponseScope": {
+          "target": "com.amazonaws.iotfleetwise#ListResponseScope",
+          "traits": {
+            "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>",
+            "smithy.api#httpQuery": "listResponseScope"
+          }
         }
       }
     },
@@ -5777,6 +5805,17 @@
         }
       }
     },
+    "com.amazonaws.iotfleetwise#ListResponseScope": {
+      "type": "enum",
+      "members": {
+        "METADATA_ONLY": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "METADATA_ONLY"
+          }
+        }
+      }
+    },
     "com.amazonaws.iotfleetwise#ListSignalCatalogNodes": {
       "type": "operation",
       "input": {
@@ -6000,6 +6039,13 @@
             "smithy.api#documentation": "<p>The maximum number of items to return, between 1 and 100, inclusive.</p>",
             "smithy.api#httpQuery": "maxResults"
           }
+        },
+        "listResponseScope": {
+          "target": "com.amazonaws.iotfleetwise#ListResponseScope",
+          "traits": {
+            "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>",
+            "smithy.api#httpQuery": "listResponseScope"
+          }
         }
       },
       "traits": {
@@ -6245,6 +6291,13 @@
             "smithy.api#documentation": "<p>The maximum number of items to return, between 1 and 100, inclusive.</p>",
             "smithy.api#httpQuery": "maxResults"
           }
+        },
+        "listResponseScope": {
+          "target": "com.amazonaws.iotfleetwise#ListResponseScope",
+          "traits": {
+            "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>",
+            "smithy.api#httpQuery": "listResponseScope"
+          }
         }
       }
     },
@@ -8085,10 +8138,12 @@
         "target": "com.amazonaws.iotfleetwise#SignalFetchInformation"
       },
       "traits": {
+        "aws.api#data": "content",
         "smithy.api#length": {
           "min": 1,
           "max": 2
-        }
+        },
+        "smithy.api#sensitive": {}
       }
     },
     "com.amazonaws.iotfleetwise#SignalInformation": {
@@ -8202,7 +8257,7 @@
         "identifier": {
           "target": "com.amazonaws.iotfleetwise#ResourceIdentifier",
           "traits": {
-            "smithy.api#documentation": "<p>A unique, service-generated identifier.</p>",
+            "smithy.api#documentation": "<p>The unique ID of the state template.</p>",
             "smithy.api#required": {}
           }
         },
@@ -9672,7 +9727,7 @@
         "identifier": {
           "target": "com.amazonaws.iotfleetwise#ResourceIdentifier",
           "traits": {
-            "smithy.api#documentation": "<p>A unique, service-generated identifier.</p>",
+            "smithy.api#documentation": "<p>The unique ID of the state template.</p>",
             "smithy.api#httpLabel": {},
             "smithy.api#required": {}
           }