EC2 / Client / get_transit_gateway_multicast_domain_associations

get_transit_gateway_multicast_domain_associations

EC2.Client.get_transit_gateway_multicast_domain_associations(**kwargs)

Gets information about the associations for the transit gateway multicast domain.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• TransitGatewayMulticastDomainId (string) –

  [REQUIRED]

  The ID of the transit gateway multicast domain.

• Filters (list) –

  One or more filters. The possible values are:

  • resource-id - The ID of the resource.

  • resource-type - The type of resource. The valid value is: vpc.

  • state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating.

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

    • 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

{
    'MulticastDomainAssociations': [
        {
            'TransitGatewayAttachmentId': 'string',
            'ResourceId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
            'ResourceOwnerId': 'string',
            'Subnet': {
                'SubnetId': 'string',
                'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • MulticastDomainAssociations (list) –

    Information about the multicast domain associations.

    • (dict) –

      Describes the resources associated with the transit gateway multicast domain.

      • TransitGatewayAttachmentId (string) –

        The ID of the transit gateway attachment.

      • 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 association resource.

      • Subnet (dict) –

        The subnet associated with the transit gateway multicast domain.

        • SubnetId (string) –

          The ID of the subnet.

        • State (string) –

          The state of the subnet association.

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