# SearchTransitGatewayMulticastGroups
<a name="API_SearchTransitGatewayMulticastGroups"></a>

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

## Request Parameters
<a name="API_SearchTransitGatewayMulticastGroups_RequestParameters"></a>

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **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`.  
Type: Boolean  
Required: No

 **Filter.N**   
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` \$1 `false`.
+  `is-group-source` - The resource is a group source. Valid values are `true` \$1 `false`.
+  `member-type` - The member type. Valid values are `igmp` \$1 `static`.
+  `resource-id` - The ID of the resource.
+  `resource-type` - The type of resource. Valid values are `vpc` \$1 `vpn` \$1 `direct-connect-gateway` \$1 `tgw-peering`.
+  `source-type` - The source type. Valid values are `igmp` \$1 `static`.
+  `subnet-id` - The ID of the subnet.
+  `transit-gateway-attachment-id` - The id of the transit gateway attachment.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 **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.  
Type: Integer  
Valid Range: Minimum value of 5. Maximum value of 1000.  
Required: No

 **NextToken**   
The token for the next page of results.  
Type: String  
Required: No

 **TransitGatewayMulticastDomainId**   
The ID of the transit gateway multicast domain.  
Type: String  
Required: Yes

## Response Elements
<a name="API_SearchTransitGatewayMulticastGroups_ResponseElements"></a>

The following elements are returned by the service.

 **multicastGroups**   
Information about the transit gateway multicast group.  
Type: Array of [TransitGatewayMulticastGroup](API_TransitGatewayMulticastGroup.md) objects

 **nextToken**   
The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

## Errors
<a name="API_SearchTransitGatewayMulticastGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples
<a name="API_SearchTransitGatewayMulticastGroups_Examples"></a>

### Example 1
<a name="API_SearchTransitGatewayMulticastGroups_Example_1"></a>

This example returns the group membership information for the specified multicast domain.

#### Sample Request
<a name="API_SearchTransitGatewayMulticastGroups_Example_1_Request"></a>

```
https://ec2.amazonaws.com/?Action=SearchTransitGatewayMulticastGroups
&TransitGatewayMulticastDomainId=tgw-mcast-domain-0c4905cef79d6e597
&AUTHPARAMS
```

#### Sample Response
<a name="API_SearchTransitGatewayMulticastGroups_Example_1_Response"></a>

```
<SearchTransitGatewayMulticastGroupsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>19af1e8f-f80b-479d-9cf4-c7d19EXAMPLE</requestId>
    <multicastGroups>
        <item>
            <groupIpAddress>224.0.1.0</groupIpAddress>
            <groupMember>true</groupMember>
            <groupSource>false</groupSource>
            <memberType>static</memberType>
            <networkInterfaceId>eni-07f290fc3cEXAMPLE</networkInterfaceId>
            <subnetId>subnet-000de86e3bEXAMPLE</subnetId>
            <transitGatewayAttachmentId>tgw-attach-028c1dd0f8EXAMPLE</transitGatewayAttachmentId>
        </item>
        <item>
            <groupIpAddress>224.0.1.0</groupIpAddress>
            <groupMember>false</groupMember>
            <groupSource>true</groupSource>
            <networkInterfaceId>eni-0e246d32695012e81</networkInterfaceId>
            <sourceType>static</sourceType>
            <subnetId>subnet-000de86e3bEXAMPLE</subnetId>
            <transitGatewayAttachmentId>tgw-attach-028c1dd0f8EXAMPLE</transitGatewayAttachmentId>
        </item>
    </multicastGroups>
</SearchTransitGatewayMulticastGroupsResponse>
```

## See Also
<a name="API_SearchTransitGatewayMulticastGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SearchTransitGatewayMulticastGroups)