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 |
Describes one or more transit gateway multicast domains.
This operation returns paginated results.
Synopsis
- data DescribeTransitGatewayMulticastDomains = DescribeTransitGatewayMulticastDomains' {}
- newDescribeTransitGatewayMulticastDomains :: DescribeTransitGatewayMulticastDomains
- describeTransitGatewayMulticastDomains_dryRun :: Lens' DescribeTransitGatewayMulticastDomains (Maybe Bool)
- describeTransitGatewayMulticastDomains_filters :: Lens' DescribeTransitGatewayMulticastDomains (Maybe [Filter])
- describeTransitGatewayMulticastDomains_maxResults :: Lens' DescribeTransitGatewayMulticastDomains (Maybe Natural)
- describeTransitGatewayMulticastDomains_nextToken :: Lens' DescribeTransitGatewayMulticastDomains (Maybe Text)
- describeTransitGatewayMulticastDomains_transitGatewayMulticastDomainIds :: Lens' DescribeTransitGatewayMulticastDomains (Maybe [Text])
- data DescribeTransitGatewayMulticastDomainsResponse = DescribeTransitGatewayMulticastDomainsResponse' {}
- newDescribeTransitGatewayMulticastDomainsResponse :: Int -> DescribeTransitGatewayMulticastDomainsResponse
- describeTransitGatewayMulticastDomainsResponse_nextToken :: Lens' DescribeTransitGatewayMulticastDomainsResponse (Maybe Text)
- describeTransitGatewayMulticastDomainsResponse_transitGatewayMulticastDomains :: Lens' DescribeTransitGatewayMulticastDomainsResponse (Maybe [TransitGatewayMulticastDomain])
- describeTransitGatewayMulticastDomainsResponse_httpStatus :: Lens' DescribeTransitGatewayMulticastDomainsResponse Int
Creating a Request
data DescribeTransitGatewayMulticastDomains Source #
See: newDescribeTransitGatewayMulticastDomains
smart constructor.
DescribeTransitGatewayMulticastDomains' | |
|
Instances
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 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.
$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 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.
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.
DescribeTransitGatewayMulticastDomainsResponse' | |
|
Instances
newDescribeTransitGatewayMulticastDomainsResponse Source #
:: Int |
|
-> 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.