:doc:`EC2 <../../ec2>` / Client / search_transit_gateway_multicast_groups

***************************************
search_transit_gateway_multicast_groups
***************************************



.. py:method:: EC2.Client.search_transit_gateway_multicast_groups(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/SearchTransitGatewayMulticastGroups>`_  


  **Request Syntax**
  ::

    response = client.search_transit_gateway_multicast_groups(
        TransitGatewayMulticastDomainId='string',
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxResults=123,
        NextToken='string',
        DryRun=True|False
    )
    
  :type TransitGatewayMulticastDomainId: string
  :param TransitGatewayMulticastDomainId: **[REQUIRED]** 

    The ID of the transit gateway multicast domain.

    

  
  :type Filters: list
  :param Filters: 

    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``.
     
    * ``subnet-id`` - The ID of the subnet.
     
    * ``transit-gateway-attachment-id`` - The id of the transit gateway attachment.
    

    

  
    - *(dict) --* 

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

       

      If you specify multiple filters, the filters are joined with an ``AND``, and the request returns only results that match all of the specified filters.

       

      For more information, see `List and filter using the CLI and API <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.

      

    
      - **Name** *(string) --* 

        The name of the filter. Filter names are case-sensitive.

        

      
      - **Values** *(list) --* 

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an ``OR``, and the request returns all results that match any of the specified values.

        

      
        - *(string) --* 

        
    
    

  :type MaxResults: integer
  :param 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 NextToken: string
  :param NextToken: 

    The token for the next page of results.

    

  
  :type DryRun: boolean
  :param 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``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'MulticastGroups': [
              {
                  'GroupIpAddress': 'string',
                  'TransitGatewayAttachmentId': 'string',
                  'SubnetId': 'string',
                  'ResourceId': 'string',
                  'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function',
                  'ResourceOwnerId': 'string',
                  'NetworkInterfaceId': 'string',
                  'GroupMember': True|False,
                  'GroupSource': True|False,
                  'MemberType': 'static'|'igmp',
                  'SourceType': 'static'|'igmp'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **MulticastGroups** *(list) --* 

        Information about the transit gateway multicast group.

        
        

        - *(dict) --* 

          Describes the transit gateway multicast group resources.

          
          

          - **GroupIpAddress** *(string) --* 

            The IP address assigned to the transit gateway multicast group.

            
          

          - **TransitGatewayAttachmentId** *(string) --* 

            The ID of the transit gateway attachment.

            
          

          - **SubnetId** *(string) --* 

            The ID of the subnet.

            
          

          - **ResourceId** *(string) --* 

            The ID of the resource.

            
          

          - **ResourceType** *(string) --* 

            The type of resource, for example a VPC attachment.

            
          

          - **ResourceOwnerId** *(string) --* 

            The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.

            
          

          - **NetworkInterfaceId** *(string) --* 

            The ID of the transit gateway attachment.

            
          

          - **GroupMember** *(boolean) --* 

            Indicates that the resource is a transit gateway multicast group member.

            
          

          - **GroupSource** *(boolean) --* 

            Indicates that the resource is a transit gateway multicast group member.

            
          

          - **MemberType** *(string) --* 

            The member type (for example, ``static``).

            
          

          - **SourceType** *(string) --* 

            The source type.

            
      
    
      

      - **NextToken** *(string) --* 

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

        
  