DescribeTransitGatewayMulticastDomains
Describes one or more transit gateway multicast domains.
Request Parameters
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.
- 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 isUnauthorizedOperation
.Type: Boolean
Required: No
- Filter.N
-
One or more filters. The possible values are:
-
state
- The state of the transit gateway multicast domain. Valid values arepending
|available
|deleting
|deleted
. -
transit-gateway-id
- The ID of the transit gateway. -
transit-gateway-multicast-domain-id
- The ID of the transit gateway multicast domain.
Type: Array of Filter 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
- TransitGatewayMulticastDomainIds.N
-
The ID of the transit gateway multicast domain.
Type: Array of strings
Required: No
Response Elements
The following elements are returned by the service.
- 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
- transitGatewayMulticastDomains
-
Information about the transit gateway multicast domains.
Type: Array of TransitGatewayMulticastDomain objects
Errors
For information about the errors that are common to all actions, see Common client error codes.
Examples
Example 1
This example describes your multicast domains.
Sample Request
https://ec2.amazonaws.com/?Action=DescribeTransitGatewayMulticastDomains
&AUTHPARAMS
Sample Response
<DescribeTransitGatewayMulticastDomainsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>e19ec53b-f3f5-4eae-97c3-a9605EXAMPLE</requestId>
<transitGatewayMulticastDomains>
<item>
<creationTime>2019-11-19T22:05:50.000Z</creationTime>
<state>available</state>
<tagSet/>
<transitGatewayId>tgw-06150e5ae0EXAMPLE</transitGatewayId>
<transitGatewayMulticastDomainId>tgw-mcast-domain-0c4905cef7EXAMPLE</transitGatewayMulticastDomainId>
</item>
</transitGatewayMulticastDomains>
</DescribeTransitGatewayMulticastDomainsResponse>
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: