Amazonka.EC2.SearchTransitGatewayMulticastGroups

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

This operation returns paginated results.

Creating a Request

data SearchTransitGatewayMulticastGroups

See: newSearchTransitGatewayMulticastGroups smart constructor.

Constructors

SearchTransitGatewayMulticastGroups'

Fields

• dryRun :: Maybe Bool

  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.

• filters :: Maybe [Filter]

  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.
• maxResults :: Maybe Natural

  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 :: Maybe Text

  The token for the next page of results.

• transitGatewayMulticastDomainId :: Maybe Text

  The ID of the transit gateway multicast domain.

Instances

ToHeaders SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

toHeaders :: SearchTransitGatewayMulticastGroups -> [Header]

ToPath SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

toPath :: SearchTransitGatewayMulticastGroups -> ByteString

ToQuery SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

toQuery :: SearchTransitGatewayMulticastGroups -> QueryString

AWSPager SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

page :: SearchTransitGatewayMulticastGroups -> AWSResponse SearchTransitGatewayMulticastGroups -> Maybe SearchTransitGatewayMulticastGroups

AWSRequest SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Associated Types

type AWSResponse SearchTransitGatewayMulticastGroups

Methods

request :: (Service -> Service) -> SearchTransitGatewayMulticastGroups -> Request SearchTransitGatewayMulticastGroups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchTransitGatewayMulticastGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchTransitGatewayMulticastGroups)))

Generic SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Associated Types

type Rep SearchTransitGatewayMulticastGroups :: Type -> Type

Methods

from :: SearchTransitGatewayMulticastGroups -> Rep SearchTransitGatewayMulticastGroups x

to :: Rep SearchTransitGatewayMulticastGroups x -> SearchTransitGatewayMulticastGroups

Read SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

readsPrec :: Int -> ReadS SearchTransitGatewayMulticastGroups

readList :: ReadS [SearchTransitGatewayMulticastGroups]

readPrec :: ReadPrec SearchTransitGatewayMulticastGroups

readListPrec :: ReadPrec [SearchTransitGatewayMulticastGroups]

Show SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

showsPrec :: Int -> SearchTransitGatewayMulticastGroups -> ShowS

show :: SearchTransitGatewayMulticastGroups -> String

showList :: [SearchTransitGatewayMulticastGroups] -> ShowS

NFData SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

rnf :: SearchTransitGatewayMulticastGroups -> ()

Eq SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

(==) :: SearchTransitGatewayMulticastGroups -> SearchTransitGatewayMulticastGroups -> Bool

(/=) :: SearchTransitGatewayMulticastGroups -> SearchTransitGatewayMulticastGroups -> Bool

Hashable SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

hashWithSalt :: Int -> SearchTransitGatewayMulticastGroups -> Int

hash :: SearchTransitGatewayMulticastGroups -> Int

type AWSResponse SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

type AWSResponse SearchTransitGatewayMulticastGroups = SearchTransitGatewayMulticastGroupsResponse

type Rep SearchTransitGatewayMulticastGroups

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

type Rep SearchTransitGatewayMulticastGroups = D1 ('MetaData "SearchTransitGatewayMulticastGroups" "Amazonka.EC2.SearchTransitGatewayMulticastGroups" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "SearchTransitGatewayMulticastGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "transitGatewayMulticastDomainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newSearchTransitGatewayMulticastGroups :: SearchTransitGatewayMulticastGroups

Create a value of SearchTransitGatewayMulticastGroups with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:SearchTransitGatewayMulticastGroups', searchTransitGatewayMulticastGroups_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.

$sel:filters:SearchTransitGatewayMulticastGroups', searchTransitGatewayMulticastGroups_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.

$sel:maxResults:SearchTransitGatewayMulticastGroups', searchTransitGatewayMulticastGroups_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.

SearchTransitGatewayMulticastGroups, searchTransitGatewayMulticastGroups_nextToken - The token for the next page of results.

SearchTransitGatewayMulticastGroups, searchTransitGatewayMulticastGroups_transitGatewayMulticastDomainId - The ID of the transit gateway multicast domain.

Request Lenses

searchTransitGatewayMulticastGroups_dryRun :: Lens' SearchTransitGatewayMulticastGroups (Maybe Bool)

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.

searchTransitGatewayMulticastGroups_filters :: Lens' SearchTransitGatewayMulticastGroups (Maybe [Filter])

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.

searchTransitGatewayMulticastGroups_maxResults :: Lens' SearchTransitGatewayMulticastGroups (Maybe Natural)

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

searchTransitGatewayMulticastGroups_nextToken :: Lens' SearchTransitGatewayMulticastGroups (Maybe Text)

The token for the next page of results.

searchTransitGatewayMulticastGroups_transitGatewayMulticastDomainId :: Lens' SearchTransitGatewayMulticastGroups (Maybe Text)

The ID of the transit gateway multicast domain.

Destructuring the Response

data SearchTransitGatewayMulticastGroupsResponse

See: newSearchTransitGatewayMulticastGroupsResponse smart constructor.

Constructors

SearchTransitGatewayMulticastGroupsResponse'

Fields

• multicastGroups :: Maybe [TransitGatewayMulticastGroup]

  Information about the transit gateway multicast group.

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic SearchTransitGatewayMulticastGroupsResponse

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Associated Types

type Rep SearchTransitGatewayMulticastGroupsResponse :: Type -> Type

Methods

from :: SearchTransitGatewayMulticastGroupsResponse -> Rep SearchTransitGatewayMulticastGroupsResponse x

to :: Rep SearchTransitGatewayMulticastGroupsResponse x -> SearchTransitGatewayMulticastGroupsResponse

Read SearchTransitGatewayMulticastGroupsResponse

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

readsPrec :: Int -> ReadS SearchTransitGatewayMulticastGroupsResponse

readList :: ReadS [SearchTransitGatewayMulticastGroupsResponse]

readPrec :: ReadPrec SearchTransitGatewayMulticastGroupsResponse

readListPrec :: ReadPrec [SearchTransitGatewayMulticastGroupsResponse]

Show SearchTransitGatewayMulticastGroupsResponse

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

showsPrec :: Int -> SearchTransitGatewayMulticastGroupsResponse -> ShowS

show :: SearchTransitGatewayMulticastGroupsResponse -> String

showList :: [SearchTransitGatewayMulticastGroupsResponse] -> ShowS

NFData SearchTransitGatewayMulticastGroupsResponse

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

rnf :: SearchTransitGatewayMulticastGroupsResponse -> ()

Eq SearchTransitGatewayMulticastGroupsResponse

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

Methods

(==) :: SearchTransitGatewayMulticastGroupsResponse -> SearchTransitGatewayMulticastGroupsResponse -> Bool

(/=) :: SearchTransitGatewayMulticastGroupsResponse -> SearchTransitGatewayMulticastGroupsResponse -> Bool

type Rep SearchTransitGatewayMulticastGroupsResponse

Defined in Amazonka.EC2.SearchTransitGatewayMulticastGroups

type Rep SearchTransitGatewayMulticastGroupsResponse = D1 ('MetaData "SearchTransitGatewayMulticastGroupsResponse" "Amazonka.EC2.SearchTransitGatewayMulticastGroups" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "SearchTransitGatewayMulticastGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "multicastGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TransitGatewayMulticastGroup])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchTransitGatewayMulticastGroupsResponse

Arguments

:: Int

$sel:httpStatus:SearchTransitGatewayMulticastGroupsResponse'

-> SearchTransitGatewayMulticastGroupsResponse

Create a value of SearchTransitGatewayMulticastGroupsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:multicastGroups:SearchTransitGatewayMulticastGroupsResponse', searchTransitGatewayMulticastGroupsResponse_multicastGroups - Information about the transit gateway multicast group.

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

$sel:httpStatus:SearchTransitGatewayMulticastGroupsResponse', searchTransitGatewayMulticastGroupsResponse_httpStatus - The response's http status code.

Response Lenses

searchTransitGatewayMulticastGroupsResponse_multicastGroups :: Lens' SearchTransitGatewayMulticastGroupsResponse (Maybe [TransitGatewayMulticastGroup])

Information about the transit gateway multicast group.

searchTransitGatewayMulticastGroupsResponse_nextToken :: Lens' SearchTransitGatewayMulticastGroupsResponse (Maybe Text)

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

searchTransitGatewayMulticastGroupsResponse_httpStatus :: Lens' SearchTransitGatewayMulticastGroupsResponse Int

The response's http status code.