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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.

Synopsis

Creating a Request

data StartRouteAnalysis Source #

See: newStartRouteAnalysis smart constructor.

Constructors

StartRouteAnalysis'

Fields

includeReturnPath :: Maybe Bool
Indicates whether to analyze the return path. The default is false.
useMiddleboxes :: Maybe Bool
Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.
globalNetworkId :: Text
The ID of the global network.
source :: RouteAnalysisEndpointOptionsSpecification
The source from which traffic originates.
destination :: RouteAnalysisEndpointOptionsSpecification
The destination.

Instances

Instances details

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

newStartRouteAnalysis Source #

Arguments

:: Text	`StartRouteAnalysis`
-> RouteAnalysisEndpointOptionsSpecification	`StartRouteAnalysis`
-> RouteAnalysisEndpointOptionsSpecification	`StartRouteAnalysis`
-> StartRouteAnalysis

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

StartRouteAnalysis, startRouteAnalysis_includeReturnPath - Indicates whether to analyze the return path. The default is false.

StartRouteAnalysis, startRouteAnalysis_useMiddleboxes - Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.

StartRouteAnalysis, startRouteAnalysis_globalNetworkId - The ID of the global network.

StartRouteAnalysis, startRouteAnalysis_source - The source from which traffic originates.

StartRouteAnalysis, startRouteAnalysis_destination - The destination.

Request Lenses

startRouteAnalysis_includeReturnPath :: Lens' StartRouteAnalysis (Maybe Bool) Source #

Indicates whether to analyze the return path. The default is false.

startRouteAnalysis_useMiddleboxes :: Lens' StartRouteAnalysis (Maybe Bool) Source #

Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.

startRouteAnalysis_globalNetworkId :: Lens' StartRouteAnalysis Text Source #

The ID of the global network.

startRouteAnalysis_source :: Lens' StartRouteAnalysis RouteAnalysisEndpointOptionsSpecification Source #

The source from which traffic originates.

startRouteAnalysis_destination :: Lens' StartRouteAnalysis RouteAnalysisEndpointOptionsSpecification Source #

The destination.

Destructuring the Response

data StartRouteAnalysisResponse Source #

See: newStartRouteAnalysisResponse smart constructor.

Constructors

StartRouteAnalysisResponse'
Fields routeAnalysis :: Maybe RouteAnalysis The route analysis. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartRouteAnalysisResponse Source #

Arguments

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

Create a value of StartRouteAnalysisResponse 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:routeAnalysis:StartRouteAnalysisResponse', startRouteAnalysisResponse_routeAnalysis - The route analysis.

$sel:httpStatus:StartRouteAnalysisResponse', startRouteAnalysisResponse_httpStatus - The response's http status code.

Response Lenses

startRouteAnalysisResponse_routeAnalysis :: Lens' StartRouteAnalysisResponse (Maybe RouteAnalysis) Source #

The route analysis.

startRouteAnalysisResponse_httpStatus :: Lens' StartRouteAnalysisResponse Int Source #

The response's http status code.