Skip to content

EC2  >  Operations  >  export_transit_gateway_routes

export_transit_gateway_routes

Operation

export_transit_gateway_routes async

export_transit_gateway_routes(request: ExportTransitGatewayRoutesInput | ExportTransitGatewayRoutesInputDict, /, *, plugins: list[Plugin] | None = None) -> ExportTransitGatewayRoutesOutput
export_transit_gateway_routes(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ExportTransitGatewayRoutesInputDict]) -> ExportTransitGatewayRoutesOutput

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 Web Services Transit Gateways Guide.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ExportTransitGatewayRoutesOutput

An instance of ExportTransitGatewayRoutesOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ExportTransitGatewayRoutesInput dataclass

Bases: _SerdeShape

Dataclass for ExportTransitGatewayRoutesInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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 is UnauthorizedOperation.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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).

s3_bucket class-attribute instance-attribute
s3_bucket: str | None = ...

The name of the S3 bucket.

transit_gateway_route_table_id class-attribute instance-attribute
transit_gateway_route_table_id: str | None = ...

The ID of the route table.

Dictionaries

ExportTransitGatewayRoutesInputDict

Bases: TypedDict

Dictionary form of ExportTransitGatewayRoutesInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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 is UnauthorizedOperation.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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).

s3_bucket instance-attribute
s3_bucket: Required[str]

The name of the S3 bucket.

transit_gateway_route_table_id instance-attribute
transit_gateway_route_table_id: Required[str]

The ID of the route table.

Output

ExportTransitGatewayRoutesOutput dataclass

Bases: _SerdeShape

Dataclass for ExportTransitGatewayRoutesOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

s3_location class-attribute instance-attribute
s3_location: str | None = ...

The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.