AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Describes one or more transit gateway multicast domains.
See also: AWS API Documentation
describe-transit-gateway-multicast-domains
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: TransitGatewayMulticastDomains
describe-transit-gateway-multicast-domains
[--transit-gateway-multicast-domain-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--transit-gateway-multicast-domain-ids
(list)
The ID of the transit gateway multicast domain.
(string)
Syntax:
"string" "string" ...
--filters
(list)
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.(structure)
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 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)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--dry-run
| --no-dry-run
(boolean)
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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command's output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command's output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To describe your transit gateway multicast domains
The following describe-transit-gateway-multicast-domains
example displays details for all of your transit gateway multicast domains.
aws ec2 describe-transit-gateway-multicast-domains
Output:
{
"TransitGatewayMulticastDomains": [
{
"TransitGatewayMulticastDomainId": "tgw-mcast-domain-000fb24d04EXAMPLE",
"TransitGatewayId": "tgw-0bf0bffefaEXAMPLE",
"TransitGatewayMulticastDomainArn": "arn:aws:ec2:us-east-1:123456789012:transit-gateway-multicast-domain/tgw-mcast-domain-000fb24d04EXAMPLE",
"OwnerId": "123456789012",
"Options": {
"Igmpv2Support": "disable",
"StaticSourcesSupport": "enable",
"AutoAcceptSharedAssociations": "disable"
},
"State": "available",
"CreationTime": "2019-12-10T18:32:50+00:00",
"Tags": [
{
"Key": "Name",
"Value": "mc1"
}
]
}
]
}
For more information, see Managing multicast domains in the Transit Gateways Guide.
TransitGatewayMulticastDomains -> (list)
Information about the transit gateway multicast domains.
(structure)
Describes the transit gateway multicast domain.
TransitGatewayMulticastDomainId -> (string)
The ID of the transit gateway multicast domain.TransitGatewayId -> (string)
The ID of the transit gateway.TransitGatewayMulticastDomainArn -> (string)
The Amazon Resource Name (ARN) of the transit gateway multicast domain.OwnerId -> (string)
The ID of the Amazon Web Services account that owns the transit gateway multicast domain.Options -> (structure)
The options for the transit gateway multicast domain.
Igmpv2Support -> (string)
Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.StaticSourcesSupport -> (string)
Indicates whether support for statically configuring transit gateway multicast group sources is turned on.AutoAcceptSharedAssociations -> (string)
Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.State -> (string)
The state of the transit gateway multicast domain.CreationTime -> (timestamp)
The time the transit gateway multicast domain was created.Tags -> (list)
The tags for the transit gateway multicast domain.
(structure)
Describes a tag.
Key -> (string)
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with
aws:
.Value -> (string)
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
NextToken -> (string)
The token to use to retrieve the next page of results. This value isnull
when there are no more results to return.