feat(client-ec2): SearchTransitGatewayRoutes API response now includes a NextToken field, enabling pagination when retrieving large sets of transit gateway routes. Pass the returned NextToken value in subsequent requests to retrieve the next page of results.

Author: awstools

clients/client-ec2/src/EC2.ts

@@ -3913,6 +3913,7 @@ import { paginateListImagesInRecycleBin } from "./pagination/ListImagesInRecycle
 import { paginateListSnapshotsInRecycleBin } from "./pagination/ListSnapshotsInRecycleBinPaginator";
 import { paginateSearchLocalGatewayRoutes } from "./pagination/SearchLocalGatewayRoutesPaginator";
 import { paginateSearchTransitGatewayMulticastGroups } from "./pagination/SearchTransitGatewayMulticastGroupsPaginator";
+import { paginateSearchTransitGatewayRoutes } from "./pagination/SearchTransitGatewayRoutesPaginator";
 import { waitUntilBundleTaskComplete } from "./waiters/waitForBundleTaskComplete";
 import { waitUntilConversionTaskCancelled } from "./waiters/waitForConversionTaskCancelled";
 import { waitUntilConversionTaskCompleted } from "./waiters/waitForConversionTaskCompleted";
@@ -4870,6 +4871,7 @@ const paginators = {
   paginateListSnapshotsInRecycleBin,
   paginateSearchLocalGatewayRoutes,
   paginateSearchTransitGatewayMulticastGroups,
+  paginateSearchTransitGatewayRoutes,
 };
 const waiters = {
   waitUntilBundleTaskComplete,
@@ -19666,6 +19668,17 @@ export interface EC2 {
     paginationConfig?: Omit<PaginationConfiguration, "client">
   ): Paginator<SearchTransitGatewayMulticastGroupsCommandOutput>;
 
+  /**
+   * @see {@link SearchTransitGatewayRoutesCommand}
+   * @param args - command input.
+   * @param paginationConfig - optional pagination config.
+   * @returns AsyncIterable of {@link SearchTransitGatewayRoutesCommandOutput}.
+   */
+  paginateSearchTransitGatewayRoutes(
+    args: SearchTransitGatewayRoutesCommandInput,
+    paginationConfig?: Omit<PaginationConfiguration, "client">
+  ): Paginator<SearchTransitGatewayRoutesCommandOutput>;
+
   /**
    * @see {@link DescribeBundleTasksCommand}
    * @param args - command input.

clients/client-ec2/src/commands/SearchTransitGatewayRoutesCommand.ts

@@ -48,6 +48,7 @@ export interface SearchTransitGatewayRoutesCommandOutput extends SearchTransitGa
  *   ],
  *   MaxResults: Number("int"),
  *   DryRun: true || false,
+ *   NextToken: "STRING_VALUE",
  * };
  * const command = new SearchTransitGatewayRoutesCommand(input);
  * const response = await client.send(command);
@@ -69,6 +70,7 @@ export interface SearchTransitGatewayRoutesCommandOutput extends SearchTransitGa
  * //     },
  * //   ],
  * //   AdditionalRoutesAvailable: true || false,
+ * //   NextToken: "STRING_VALUE",
  * // };
  *
  * ```

clients/client-ec2/src/models/models_7.ts

@@ -6248,6 +6248,12 @@ export interface SearchTransitGatewayRoutesRequest {
    * @public
    */
   DryRun?: boolean | undefined;
+
+  /**
+   * <p>The token for the next page of results.</p>
+   * @public
+   */
+  NextToken?: string | undefined;
 }
 
 /**
@@ -6265,6 +6271,12 @@ export interface SearchTransitGatewayRoutesResult {
    * @public
    */
   AdditionalRoutesAvailable?: boolean | undefined;
+
+  /**
+   * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
+   * @public
+   */
+  NextToken?: string | undefined;
 }
 
 /**

clients/client-ec2/src/pagination/SearchTransitGatewayRoutesPaginator.ts

@@ -0,0 +1,24 @@
+// smithy-typescript generated code
+import { createPaginator } from "@smithy/core";
+import type { Paginator } from "@smithy/types";
+
+import {
+  SearchTransitGatewayRoutesCommand,
+  SearchTransitGatewayRoutesCommandInput,
+  SearchTransitGatewayRoutesCommandOutput,
+} from "../commands/SearchTransitGatewayRoutesCommand";
+import { EC2Client } from "../EC2Client";
+import { EC2PaginationConfiguration } from "./Interfaces";
+
+/**
+ * @public
+ */
+export const paginateSearchTransitGatewayRoutes: (
+  config: EC2PaginationConfiguration,
+  input: SearchTransitGatewayRoutesCommandInput,
+  ...rest: any[]
+) => Paginator<SearchTransitGatewayRoutesCommandOutput> = createPaginator<
+  EC2PaginationConfiguration,
+  SearchTransitGatewayRoutesCommandInput,
+  SearchTransitGatewayRoutesCommandOutput
+>(EC2Client, SearchTransitGatewayRoutesCommand, "NextToken", "NextToken", "MaxResults");

clients/client-ec2/src/pagination/index.ts

@@ -163,3 +163,4 @@ export * from "./ListImagesInRecycleBinPaginator";
 export * from "./ListSnapshotsInRecycleBinPaginator";
 export * from "./SearchLocalGatewayRoutesPaginator";
 export * from "./SearchTransitGatewayMulticastGroupsPaginator";
+export * from "./SearchTransitGatewayRoutesPaginator";

clients/client-ec2/src/schemas/schemas_0.ts

@@ -22684,15 +22684,16 @@ export var SearchTransitGatewayMulticastGroupsResult$: StaticStructureSchema = [
 ];
 export var SearchTransitGatewayRoutesRequest$: StaticStructureSchema = [3, n0, _STGRR,
   0,
-  [_TGRTI, _Fi, _MR, _DR],
-  [0, [() => FilterList, { [_xN]: _Fil }], 1, 2], 2
+  [_TGRTI, _Fi, _MR, _DR, _NTe],
+  [0, [() => FilterList, { [_xN]: _Fil }], 1, 2, 0], 2
 ];
 export var SearchTransitGatewayRoutesResult$: StaticStructureSchema = [3, n0, _STGRRe,
   0,
-  [_Rou, _ARAd],
+  [_Rou, _ARAd, _NTe],
   [[() => TransitGatewayRouteList, { [_eQN]: `RouteSet`
   , [_xN]: _rSou }], [2, { [_eQN]: `AdditionalRoutesAvailable`
-  , [_xN]: _aRAd }]]
+  , [_xN]: _aRAd }], [0, { [_eQN]: `NextToken`
+  , [_xN]: _nTe }]]
 ];
 export var SecurityGroup$: StaticStructureSchema = [3, n0, _SGe,
   0,

clients/client-ec2/test/index-objects.spec.mjs

@@ -3646,6 +3646,7 @@ import {
   paginateListSnapshotsInRecycleBin,
   paginateSearchLocalGatewayRoutes,
   paginateSearchTransitGatewayMulticastGroups,
+  paginateSearchTransitGatewayRoutes,
   PartitionLoadFrequency,
   PathComponent$,
   PathFilter$,
@@ -9000,4 +9001,5 @@ assert(typeof paginateListImagesInRecycleBin === "function");
 assert(typeof paginateListSnapshotsInRecycleBin === "function");
 assert(typeof paginateSearchLocalGatewayRoutes === "function");
 assert(typeof paginateSearchTransitGatewayMulticastGroups === "function");
+assert(typeof paginateSearchTransitGatewayRoutes === "function");
 console.log(`EC2 index test passed.`);

clients/client-ec2/test/index-types.ts

@@ -5245,4 +5245,5 @@ export type {
   paginateListSnapshotsInRecycleBin,
   paginateSearchLocalGatewayRoutes,
   paginateSearchTransitGatewayMulticastGroups,
+  paginateSearchTransitGatewayRoutes,
 } from "../dist-types/index.d";

codegen/sdk-codegen/aws-models/ec2.json

@@ -115506,7 +115506,13 @@
         "target": "com.amazonaws.ec2#SearchTransitGatewayRoutesResult"
       },
       "traits": {
-        "smithy.api#documentation": "<p>Searches for routes in the specified transit gateway route table.</p>"
+        "smithy.api#documentation": "<p>Searches for routes in the specified transit gateway route table.</p>",
+        "smithy.api#paginated": {
+          "inputToken": "NextToken",
+          "outputToken": "NextToken",
+          "items": "Routes",
+          "pageSize": "MaxResults"
+        }
       }
     },
     "com.amazonaws.ec2#SearchTransitGatewayRoutesRequest": {
@@ -115540,6 +115546,12 @@
           "traits": {
             "smithy.api#documentation": "<p>Checks whether you have the required permissions for the action, without actually making the request, \n   and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. \n   Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
           }
+        },
+        "NextToken": {
+          "target": "com.amazonaws.ec2#String",
+          "traits": {
+            "smithy.api#documentation": "<p>The token for the next page of results.</p>"
+          }
         }
       },
       "traits": {
@@ -115564,6 +115576,14 @@
             "smithy.api#documentation": "<p>Indicates whether there are additional routes available.</p>",
             "smithy.api#xmlName": "additionalRoutesAvailable"
           }
+        },
+        "NextToken": {
+          "target": "com.amazonaws.ec2#String",
+          "traits": {
+            "aws.protocols#ec2QueryName": "NextToken",
+            "smithy.api#documentation": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>",
+            "smithy.api#xmlName": "nextToken"
+          }
         }
       },
       "traits": {