ec2_get_transit_gateway_prefix_list_references {aws.ecx}

Get Transit Gateway Prefix List References

Description

Gets information about the prefix list references in a specified transit gateway route table.

Usage

ec2_get_transit_gateway_prefix_list_references(
  TransitGatewayRouteTableId,
  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

TransitGatewayRouteTableId

Character. The ID of the transit gateway route table.

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

TransitGatewayRouteTableId

The ID of the transit gateway route table.

Filter

One or more filters. The possible values are:

• attachment.resource-id - The ID of the resource for the attachment.

• attachment.resource-type - The type of resource for the attachment. Valid values are vpc \| vpn \| direct-connect-gateway \| peering.

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

• is-blackhole - Whether traffic matching the route is blocked (true \| false).

• prefix-list-id - The ID of the prefix list.

• prefix-list-owner-id - The ID of the owner of the prefix list.

• state - The state of the prefix list reference (pending \| available \| modifying \| deleting).

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.