ec2_describe_transit_gateways {aws.ecx}

Describe Transit Gateways

Description

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.

Usage

ec2_describe_transit_gateways(
  TransitGatewayIds = NULL,
  Filter = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  DryRun = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

TransitGatewayIds

List. The IDs of the transit gateways.[optional]

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

MaxResults

Integer. The maximum number of results to return with a single call.[optional]

NextToken

Characters. The token for the next page of results[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

TransitGatewayIds

The IDs of the transit gateways.

Filter

One or more filters. The possible values are:

• options.propagation-default-route-table-id - The ID of the default propagation route table.

• options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.

• options.association-default-route-table-id - The ID of the default association route table.

• options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable \| disable).

• options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable \| disable).

• options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable \| disable).

• options.dns-support - Indicates whether DNS support is enabled (enable \| disable).

• options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable \| disable).

• owner-id - The ID of the AWS account that owns the transit gateway.

• state - The state of the transit gateway (available \| deleted \| deleting \| modifying \| pending).

• transit-gateway-id - The ID of the transit gateway.

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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