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.NetworkManager.GetNetworkRoutes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the network routes of the specified global network.

Synopsis

data GetNetworkRoutes = GetNetworkRoutes' {
- destinationFilters :: Maybe (HashMap Text [Text])
- exactCidrMatches :: Maybe [Text]
- longestPrefixMatches :: Maybe [Text]
- prefixListIds :: Maybe [Text]
- states :: Maybe [RouteState]
- subnetOfMatches :: Maybe [Text]
- supernetOfMatches :: Maybe [Text]
- types :: Maybe [RouteType]
- globalNetworkId :: Text
- routeTableIdentifier :: RouteTableIdentifier
}
newGetNetworkRoutes :: Text -> RouteTableIdentifier -> GetNetworkRoutes
getNetworkRoutes_destinationFilters :: Lens' GetNetworkRoutes (Maybe (HashMap Text [Text]))
getNetworkRoutes_exactCidrMatches :: Lens' GetNetworkRoutes (Maybe [Text])
getNetworkRoutes_longestPrefixMatches :: Lens' GetNetworkRoutes (Maybe [Text])
getNetworkRoutes_prefixListIds :: Lens' GetNetworkRoutes (Maybe [Text])
getNetworkRoutes_states :: Lens' GetNetworkRoutes (Maybe [RouteState])
getNetworkRoutes_subnetOfMatches :: Lens' GetNetworkRoutes (Maybe [Text])
getNetworkRoutes_supernetOfMatches :: Lens' GetNetworkRoutes (Maybe [Text])
getNetworkRoutes_types :: Lens' GetNetworkRoutes (Maybe [RouteType])
getNetworkRoutes_globalNetworkId :: Lens' GetNetworkRoutes Text
getNetworkRoutes_routeTableIdentifier :: Lens' GetNetworkRoutes RouteTableIdentifier
data GetNetworkRoutesResponse = GetNetworkRoutesResponse' {
- coreNetworkSegmentEdge :: Maybe CoreNetworkSegmentEdgeIdentifier
- networkRoutes :: Maybe [NetworkRoute]
- routeTableArn :: Maybe Text
- routeTableTimestamp :: Maybe POSIX
- routeTableType :: Maybe RouteTableType
- httpStatus :: Int
}
newGetNetworkRoutesResponse :: Int -> GetNetworkRoutesResponse
getNetworkRoutesResponse_coreNetworkSegmentEdge :: Lens' GetNetworkRoutesResponse (Maybe CoreNetworkSegmentEdgeIdentifier)
getNetworkRoutesResponse_networkRoutes :: Lens' GetNetworkRoutesResponse (Maybe [NetworkRoute])
getNetworkRoutesResponse_routeTableArn :: Lens' GetNetworkRoutesResponse (Maybe Text)
getNetworkRoutesResponse_routeTableTimestamp :: Lens' GetNetworkRoutesResponse (Maybe UTCTime)
getNetworkRoutesResponse_routeTableType :: Lens' GetNetworkRoutesResponse (Maybe RouteTableType)
getNetworkRoutesResponse_httpStatus :: Lens' GetNetworkRoutesResponse Int

Creating a Request

data GetNetworkRoutes Source #

See: newGetNetworkRoutes smart constructor.

Constructors

GetNetworkRoutes'

Fields

destinationFilters :: Maybe (HashMap Text [Text])
Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.
exactCidrMatches :: Maybe [Text]
An exact CIDR block.
longestPrefixMatches :: Maybe [Text]
The most specific route that matches the traffic (longest prefix match).
prefixListIds :: Maybe [Text]
The IDs of the prefix lists.
states :: Maybe [RouteState]
The route states.
subnetOfMatches :: Maybe [Text]
The routes with a subnet that match the specified CIDR filter.
supernetOfMatches :: Maybe [Text]
The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.
types :: Maybe [RouteType]
The route types.
globalNetworkId :: Text
The ID of the global network.
routeTableIdentifier :: RouteTableIdentifier
The ID of the route table.

Instances

Instances details

ToJSON GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods toJSON :: GetNetworkRoutes -> Value # toEncoding :: GetNetworkRoutes -> Encoding # toJSONList :: [GetNetworkRoutes] -> Value # toEncodingList :: [GetNetworkRoutes] -> Encoding #
ToHeaders GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods toHeaders :: GetNetworkRoutes -> [Header] #
ToPath GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods toPath :: GetNetworkRoutes -> ByteString #
ToQuery GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods toQuery :: GetNetworkRoutes -> QueryString #
AWSRequest GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Associated Types type AWSResponse GetNetworkRoutes # Methods request :: (Service -> Service) -> GetNetworkRoutes -> Request GetNetworkRoutes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetNetworkRoutes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetNetworkRoutes))) #
Generic GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Associated Types type Rep GetNetworkRoutes :: Type -> Type # Methods from :: GetNetworkRoutes -> Rep GetNetworkRoutes x # to :: Rep GetNetworkRoutes x -> GetNetworkRoutes #
Read GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods readsPrec :: Int -> ReadS GetNetworkRoutes # readList :: ReadS [GetNetworkRoutes] # readPrec :: ReadPrec GetNetworkRoutes # readListPrec :: ReadPrec [GetNetworkRoutes] #
Show GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods showsPrec :: Int -> GetNetworkRoutes -> ShowS # show :: GetNetworkRoutes -> String # showList :: [GetNetworkRoutes] -> ShowS #
NFData GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods rnf :: GetNetworkRoutes -> () #
Eq GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods (==) :: GetNetworkRoutes -> GetNetworkRoutes -> Bool # (/=) :: GetNetworkRoutes -> GetNetworkRoutes -> Bool #
Hashable GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods hashWithSalt :: Int -> GetNetworkRoutes -> Int # hash :: GetNetworkRoutes -> Int #
type AWSResponse GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes type AWSResponse GetNetworkRoutes = GetNetworkRoutesResponse
type Rep GetNetworkRoutes Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes type Rep GetNetworkRoutes = D1 ('MetaData "GetNetworkRoutes" "Amazonka.NetworkManager.GetNetworkRoutes" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "GetNetworkRoutes'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "destinationFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :: S1 ('MetaSel ('Just "exactCidrMatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "longestPrefixMatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "prefixListIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "states") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RouteState]))))) :: ((S1 ('MetaSel ('Just "subnetOfMatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "supernetOfMatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "types") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RouteType])) :: (S1 ('MetaSel ('Just "globalNetworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "routeTableIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RouteTableIdentifier))))))

newGetNetworkRoutes Source #

Arguments

:: Text	`GetNetworkRoutes`
-> RouteTableIdentifier	`$sel:routeTableIdentifier:GetNetworkRoutes'`
-> GetNetworkRoutes

Create a value of GetNetworkRoutes 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:destinationFilters:GetNetworkRoutes', getNetworkRoutes_destinationFilters - Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

$sel:exactCidrMatches:GetNetworkRoutes', getNetworkRoutes_exactCidrMatches - An exact CIDR block.

$sel:longestPrefixMatches:GetNetworkRoutes', getNetworkRoutes_longestPrefixMatches - The most specific route that matches the traffic (longest prefix match).

$sel:prefixListIds:GetNetworkRoutes', getNetworkRoutes_prefixListIds - The IDs of the prefix lists.

$sel:states:GetNetworkRoutes', getNetworkRoutes_states - The route states.

$sel:subnetOfMatches:GetNetworkRoutes', getNetworkRoutes_subnetOfMatches - The routes with a subnet that match the specified CIDR filter.

$sel:supernetOfMatches:GetNetworkRoutes', getNetworkRoutes_supernetOfMatches - The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

$sel:types:GetNetworkRoutes', getNetworkRoutes_types - The route types.

GetNetworkRoutes, getNetworkRoutes_globalNetworkId - The ID of the global network.

$sel:routeTableIdentifier:GetNetworkRoutes', getNetworkRoutes_routeTableIdentifier - The ID of the route table.

Request Lenses

getNetworkRoutes_destinationFilters :: Lens' GetNetworkRoutes (Maybe (HashMap Text [Text])) Source #

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

getNetworkRoutes_exactCidrMatches :: Lens' GetNetworkRoutes (Maybe [Text]) Source #

An exact CIDR block.

getNetworkRoutes_longestPrefixMatches :: Lens' GetNetworkRoutes (Maybe [Text]) Source #

The most specific route that matches the traffic (longest prefix match).

getNetworkRoutes_prefixListIds :: Lens' GetNetworkRoutes (Maybe [Text]) Source #

The IDs of the prefix lists.

getNetworkRoutes_states :: Lens' GetNetworkRoutes (Maybe [RouteState]) Source #

The route states.

getNetworkRoutes_subnetOfMatches :: Lens' GetNetworkRoutes (Maybe [Text]) Source #

The routes with a subnet that match the specified CIDR filter.

getNetworkRoutes_supernetOfMatches :: Lens' GetNetworkRoutes (Maybe [Text]) Source #

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

getNetworkRoutes_types :: Lens' GetNetworkRoutes (Maybe [RouteType]) Source #

The route types.

getNetworkRoutes_globalNetworkId :: Lens' GetNetworkRoutes Text Source #

The ID of the global network.

getNetworkRoutes_routeTableIdentifier :: Lens' GetNetworkRoutes RouteTableIdentifier Source #

The ID of the route table.

Destructuring the Response

data GetNetworkRoutesResponse Source #

See: newGetNetworkRoutesResponse smart constructor.

Constructors

GetNetworkRoutesResponse'

Fields

coreNetworkSegmentEdge :: Maybe CoreNetworkSegmentEdgeIdentifier
Describes a core network segment edge.
networkRoutes :: Maybe [NetworkRoute]
The network routes.
routeTableArn :: Maybe Text
The ARN of the route table.
routeTableTimestamp :: Maybe POSIX
The route table creation time.
routeTableType :: Maybe RouteTableType
The route table type.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetNetworkRoutesResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Associated Types type Rep GetNetworkRoutesResponse :: Type -> Type # Methods from :: GetNetworkRoutesResponse -> Rep GetNetworkRoutesResponse x # to :: Rep GetNetworkRoutesResponse x -> GetNetworkRoutesResponse #
Read GetNetworkRoutesResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods readsPrec :: Int -> ReadS GetNetworkRoutesResponse # readList :: ReadS [GetNetworkRoutesResponse] # readPrec :: ReadPrec GetNetworkRoutesResponse # readListPrec :: ReadPrec [GetNetworkRoutesResponse] #
Show GetNetworkRoutesResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods showsPrec :: Int -> GetNetworkRoutesResponse -> ShowS # show :: GetNetworkRoutesResponse -> String # showList :: [GetNetworkRoutesResponse] -> ShowS #
NFData GetNetworkRoutesResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods rnf :: GetNetworkRoutesResponse -> () #
Eq GetNetworkRoutesResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes Methods (==) :: GetNetworkRoutesResponse -> GetNetworkRoutesResponse -> Bool # (/=) :: GetNetworkRoutesResponse -> GetNetworkRoutesResponse -> Bool #
type Rep GetNetworkRoutesResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkRoutes type Rep GetNetworkRoutesResponse = D1 ('MetaData "GetNetworkRoutesResponse" "Amazonka.NetworkManager.GetNetworkRoutes" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "GetNetworkRoutesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "coreNetworkSegmentEdge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CoreNetworkSegmentEdgeIdentifier)) :: (S1 ('MetaSel ('Just "networkRoutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkRoute])) :: S1 ('MetaSel ('Just "routeTableArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "routeTableTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "routeTableType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteTableType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))