ec2_search_transit_gateway_multicast_groups {aws.ecx}

Search Transit Gateway Multicast Groups

Description

Searches one or more transit gateway multicast groups and returns the group membership information.

Usage

ec2_search_transit_gateway_multicast_groups(
  TransitGatewayMulticastDomainId = 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

TransitGatewayMulticastDomainId

Character. The ID of the transit gateway multicast domain.[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

TransitGatewayMulticastDomainId

The ID of the transit gateway multicast domain.

Filter

One or more filters. The possible values are:

• group-ip-address - The IP address of the transit gateway multicast group.

• is-group-member - The resource is a group member. Valid values are true \| false.

• is-group-source - The resource is a group source. Valid values are true \| false.

• member-type - The member type. Valid values are igmp \| static.

• resource-id - The ID of the resource.

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

• source-type - The source type. Valid values are igmp \| static.

• state - The state of the subnet association. Valid values are associated \| associated \| disassociated \| disassociating.

• subnet-id - The ID of the subnet.

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

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.