EC2 / Client / describe_transit_gateway_multicast_domains

describe_transit_gateway_multicast_domains

EC2.Client.describe_transit_gateway_multicast_domains(**kwargs)

Describes one or more transit gateway multicast domains.

See also: AWS API Documentation

Request Syntax

response = client.describe_transit_gateway_multicast_domains(
    TransitGatewayMulticastDomainIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

Parameters:

• TransitGatewayMulticastDomainIds (list) –

  The ID of the transit gateway multicast domain.

  • (string) –

• Filters (list) –

  One or more filters. The possible values are:

  • state - The state of the transit gateway multicast domain. Valid values are pending | 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.

  • (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.

    • 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) –

• MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• NextToken (string) – The token for the next page of results.

• DryRun (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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayMulticastDomains': [
        {
            'TransitGatewayMulticastDomainId': 'string',
            'TransitGatewayId': 'string',
            'TransitGatewayMulticastDomainArn': 'string',
            'OwnerId': 'string',
            'Options': {
                'Igmpv2Support': 'enable'|'disable',
                'StaticSourcesSupport': 'enable'|'disable',
                'AutoAcceptSharedAssociations': 'enable'|'disable'
            },
            'State': 'pending'|'available'|'deleting'|'deleted',
            'CreationTime': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • TransitGatewayMulticastDomains (list) –

    Information about the transit gateway multicast domains.

    • (dict) –

      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 (dict) –

        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 (datetime) –

        The time the transit gateway multicast domain was created.

      • Tags (list) –

        The tags for the transit gateway multicast domain.

        • (dict) –

          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 is null when there are no more results to return.