ExportTransitGatewayRoutes
Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.
The routes are saved to the specified bucket in a JSON file. For more information, see Export route tables to Amazon S3 in the Amazon Transit Gateways Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- DryRun
-
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.Type: Boolean
Required: No
- Filter.N
-
One or more filters. The possible values are:
-
attachment.transit-gateway-attachment-id
- The id of the transit gateway attachment. -
attachment.resource-id
- The resource id of the transit gateway attachment. -
route-search.exact-match
- The exact match of the specified filter. -
route-search.longest-prefix-match
- The longest prefix that matches the route. -
route-search.subnet-of-match
- The routes with a subnet that match the specified CIDR filter. -
route-search.supernet-of-match
- The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29. -
state
- The state of the route (active
|blackhole
). -
transit-gateway-route-destination-cidr-block
- The CIDR range. -
type
- The type of route (propagated
|static
).
Type: Array of Filter objects
Required: No
-
- S3Bucket
-
The name of the S3 bucket.
Type: String
Required: Yes
- TransitGatewayRouteTableId
-
The ID of the route table.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- s3Location
-
The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: