Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeTransitGatewayMulticastDomains

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more transit gateway multicast domains.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTransitGatewayMulticastDomains Source #

See: newDescribeTransitGatewayMulticastDomains smart constructor.

Constructors

DescribeTransitGatewayMulticastDomains'

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:
- 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.
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.
transitGatewayMulticastDomainIds :: Maybe [Text]
The ID of the transit gateway multicast domain.

Instances

Instances details

ToHeaders DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods toHeaders :: DescribeTransitGatewayMulticastDomains -> [Header] #
ToPath DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods toPath :: DescribeTransitGatewayMulticastDomains -> ByteString #
ToQuery DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods toQuery :: DescribeTransitGatewayMulticastDomains -> QueryString #
AWSPager DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods page :: DescribeTransitGatewayMulticastDomains -> AWSResponse DescribeTransitGatewayMulticastDomains -> Maybe DescribeTransitGatewayMulticastDomains #
AWSRequest DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Associated Types type AWSResponse DescribeTransitGatewayMulticastDomains # Methods request :: (Service -> Service) -> DescribeTransitGatewayMulticastDomains -> Request DescribeTransitGatewayMulticastDomains # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTransitGatewayMulticastDomains -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTransitGatewayMulticastDomains))) #
Generic DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Associated Types type Rep DescribeTransitGatewayMulticastDomains :: Type -> Type # Methods from :: DescribeTransitGatewayMulticastDomains -> Rep DescribeTransitGatewayMulticastDomains x # to :: Rep DescribeTransitGatewayMulticastDomains x -> DescribeTransitGatewayMulticastDomains #
Read DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods readsPrec :: Int -> ReadS DescribeTransitGatewayMulticastDomains # readList :: ReadS [DescribeTransitGatewayMulticastDomains] # readPrec :: ReadPrec DescribeTransitGatewayMulticastDomains # readListPrec :: ReadPrec [DescribeTransitGatewayMulticastDomains] #
Show DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods showsPrec :: Int -> DescribeTransitGatewayMulticastDomains -> ShowS # show :: DescribeTransitGatewayMulticastDomains -> String # showList :: [DescribeTransitGatewayMulticastDomains] -> ShowS #
NFData DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods rnf :: DescribeTransitGatewayMulticastDomains -> () #
Eq DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods (==) :: DescribeTransitGatewayMulticastDomains -> DescribeTransitGatewayMulticastDomains -> Bool # (/=) :: DescribeTransitGatewayMulticastDomains -> DescribeTransitGatewayMulticastDomains -> Bool #
Hashable DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods hashWithSalt :: Int -> DescribeTransitGatewayMulticastDomains -> Int # hash :: DescribeTransitGatewayMulticastDomains -> Int #
type AWSResponse DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains type AWSResponse DescribeTransitGatewayMulticastDomains = DescribeTransitGatewayMulticastDomainsResponse
type Rep DescribeTransitGatewayMulticastDomains Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains type Rep DescribeTransitGatewayMulticastDomains = D1 ('MetaData "DescribeTransitGatewayMulticastDomains" "Amazonka.EC2.DescribeTransitGatewayMulticastDomains" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTransitGatewayMulticastDomains'" '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 "transitGatewayMulticastDomainIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeTransitGatewayMulticastDomains :: DescribeTransitGatewayMulticastDomains Source #

Create a value of DescribeTransitGatewayMulticastDomains 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:DescribeTransitGatewayMulticastDomains', describeTransitGatewayMulticastDomains_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:DescribeTransitGatewayMulticastDomains', describeTransitGatewayMulticastDomains_filters - 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.

$sel:maxResults:DescribeTransitGatewayMulticastDomains', describeTransitGatewayMulticastDomains_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.

DescribeTransitGatewayMulticastDomains, describeTransitGatewayMulticastDomains_nextToken - The token for the next page of results.

$sel:transitGatewayMulticastDomainIds:DescribeTransitGatewayMulticastDomains', describeTransitGatewayMulticastDomains_transitGatewayMulticastDomainIds - The ID of the transit gateway multicast domain.

Request Lenses

describeTransitGatewayMulticastDomains_dryRun :: Lens' DescribeTransitGatewayMulticastDomains (Maybe Bool) Source #

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.

describeTransitGatewayMulticastDomains_filters :: Lens' DescribeTransitGatewayMulticastDomains (Maybe [Filter]) Source #

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.

describeTransitGatewayMulticastDomains_maxResults :: Lens' DescribeTransitGatewayMulticastDomains (Maybe Natural) Source #

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

describeTransitGatewayMulticastDomains_nextToken :: Lens' DescribeTransitGatewayMulticastDomains (Maybe Text) Source #

The token for the next page of results.

describeTransitGatewayMulticastDomains_transitGatewayMulticastDomainIds :: Lens' DescribeTransitGatewayMulticastDomains (Maybe [Text]) Source #

The ID of the transit gateway multicast domain.

Destructuring the Response

data DescribeTransitGatewayMulticastDomainsResponse Source #

See: newDescribeTransitGatewayMulticastDomainsResponse smart constructor.

Constructors

DescribeTransitGatewayMulticastDomainsResponse'
Fields 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. transitGatewayMulticastDomains :: Maybe [TransitGatewayMulticastDomain] Information about the transit gateway multicast domains. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeTransitGatewayMulticastDomainsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Associated Types type Rep DescribeTransitGatewayMulticastDomainsResponse :: Type -> Type # Methods from :: DescribeTransitGatewayMulticastDomainsResponse -> Rep DescribeTransitGatewayMulticastDomainsResponse x # to :: Rep DescribeTransitGatewayMulticastDomainsResponse x -> DescribeTransitGatewayMulticastDomainsResponse #
Read DescribeTransitGatewayMulticastDomainsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods readsPrec :: Int -> ReadS DescribeTransitGatewayMulticastDomainsResponse # readList :: ReadS [DescribeTransitGatewayMulticastDomainsResponse] # readPrec :: ReadPrec DescribeTransitGatewayMulticastDomainsResponse # readListPrec :: ReadPrec [DescribeTransitGatewayMulticastDomainsResponse] #
Show DescribeTransitGatewayMulticastDomainsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods showsPrec :: Int -> DescribeTransitGatewayMulticastDomainsResponse -> ShowS # show :: DescribeTransitGatewayMulticastDomainsResponse -> String # showList :: [DescribeTransitGatewayMulticastDomainsResponse] -> ShowS #
NFData DescribeTransitGatewayMulticastDomainsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods rnf :: DescribeTransitGatewayMulticastDomainsResponse -> () #
Eq DescribeTransitGatewayMulticastDomainsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains Methods (==) :: DescribeTransitGatewayMulticastDomainsResponse -> DescribeTransitGatewayMulticastDomainsResponse -> Bool # (/=) :: DescribeTransitGatewayMulticastDomainsResponse -> DescribeTransitGatewayMulticastDomainsResponse -> Bool #
type Rep DescribeTransitGatewayMulticastDomainsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayMulticastDomains type Rep DescribeTransitGatewayMulticastDomainsResponse = D1 ('MetaData "DescribeTransitGatewayMulticastDomainsResponse" "Amazonka.EC2.DescribeTransitGatewayMulticastDomains" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTransitGatewayMulticastDomainsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "transitGatewayMulticastDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TransitGatewayMulticastDomain])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTransitGatewayMulticastDomainsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTransitGatewayMulticastDomainsResponse'`
-> DescribeTransitGatewayMulticastDomainsResponse

Create a value of DescribeTransitGatewayMulticastDomainsResponse 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:

DescribeTransitGatewayMulticastDomains, describeTransitGatewayMulticastDomainsResponse_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:transitGatewayMulticastDomains:DescribeTransitGatewayMulticastDomainsResponse', describeTransitGatewayMulticastDomainsResponse_transitGatewayMulticastDomains - Information about the transit gateway multicast domains.

$sel:httpStatus:DescribeTransitGatewayMulticastDomainsResponse', describeTransitGatewayMulticastDomainsResponse_httpStatus - The response's http status code.

Response Lenses

describeTransitGatewayMulticastDomainsResponse_nextToken :: Lens' DescribeTransitGatewayMulticastDomainsResponse (Maybe Text) Source #

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

describeTransitGatewayMulticastDomainsResponse_transitGatewayMulticastDomains :: Lens' DescribeTransitGatewayMulticastDomainsResponse (Maybe [TransitGatewayMulticastDomain]) Source #

Information about the transit gateway multicast domains.

describeTransitGatewayMulticastDomainsResponse_httpStatus :: Lens' DescribeTransitGatewayMulticastDomainsResponse Int Source #

The response's http status code.