ec2_describe_vpc_peering_connections {aws.ecx}

Describe Vpc Peering Connections

Description

Describes one or more of your VPC peering connections.

Usage

ec2_describe_vpc_peering_connections(
  Filter = NULL,
  DryRun = NULL,
  VpcPeeringConnectionId = NULL,
  NextToken = NULL,
  MaxResults = 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

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]

DryRun

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

VpcPeeringConnectionId

List. One or more VPC peering connection IDs. Default: Describes all your VPC peering connections. [optional]

NextToken

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

MaxResults

Integer. The maximum number of results to return with a single call.[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

Filter

One or more filters.

• accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.

• accepter-vpc-info.owner-id - The AWS account ID of the owner of the accepter VPC.

• accepter-vpc-info.vpc-id - The ID of the accepter VPC.

• expiration-time - The expiration date and time for the VPC peering connection.

• requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester\'s VPC.

• requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

• requester-vpc-info.vpc-id - The ID of the requester VPC.

• status-code - The status of the VPC peering connection (pending-acceptance \| failed \| expired \| provisioning \| active \| deleting \| deleted \| rejected).

• status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

• tag:\ - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-peering-connection-id - The ID of the VPC peering connection.

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.

VpcPeeringConnectionId

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

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.