amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeNetworkInsightsPaths

Description

Describes one or more of your paths.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeNetworkInsightsPaths Source #

See: newDescribeNetworkInsightsPaths smart constructor.

Constructors

DescribeNetworkInsightsPaths' 

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]

    The filters. The following are the possible values:

    • destination - The ID of the resource.
    • destination-port - The destination port.
    • protocol - The protocol.
    • source - The ID of the resource.
  • 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.

  • networkInsightsPathIds :: Maybe [Text]

    The IDs of the paths.

  • nextToken :: Maybe Text

    The token for the next page of results.

Instances

Instances details
ToHeaders DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

toHeaders :: DescribeNetworkInsightsPaths -> [Header] #

ToPath DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

toPath :: DescribeNetworkInsightsPaths -> ByteString #

ToQuery DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

toQuery :: DescribeNetworkInsightsPaths -> QueryString #

AWSPager DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

page :: DescribeNetworkInsightsPaths -> AWSResponse DescribeNetworkInsightsPaths -> Maybe DescribeNetworkInsightsPaths #

AWSRequest DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Associated Types

type AWSResponse DescribeNetworkInsightsPaths #

Methods

request :: (Service -> Service) -> DescribeNetworkInsightsPaths -> Request DescribeNetworkInsightsPaths #

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

Generic DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Associated Types

type Rep DescribeNetworkInsightsPaths :: Type -> Type #

Methods

from :: DescribeNetworkInsightsPaths -> Rep DescribeNetworkInsightsPaths x #

to :: Rep DescribeNetworkInsightsPaths x -> DescribeNetworkInsightsPaths #

Read DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

readsPrec :: Int -> ReadS DescribeNetworkInsightsPaths #

readList :: ReadS [DescribeNetworkInsightsPaths] #

readPrec :: ReadPrec DescribeNetworkInsightsPaths #

readListPrec :: ReadPrec [DescribeNetworkInsightsPaths] #

Show DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

showsPrec :: Int -> DescribeNetworkInsightsPaths -> ShowS #

show :: DescribeNetworkInsightsPaths -> String #

showList :: [DescribeNetworkInsightsPaths] -> ShowS #

NFData DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

rnf :: DescribeNetworkInsightsPaths -> () #

Eq DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

(==) :: DescribeNetworkInsightsPaths -> DescribeNetworkInsightsPaths -> Bool #

(/=) :: DescribeNetworkInsightsPaths -> DescribeNetworkInsightsPaths -> Bool #

Hashable DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

hashWithSalt :: Int -> DescribeNetworkInsightsPaths -> Int #

hash :: DescribeNetworkInsightsPaths -> Int #

type AWSResponse DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

type AWSResponse DescribeNetworkInsightsPaths = DescribeNetworkInsightsPathsResponse
type Rep DescribeNetworkInsightsPaths Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

type Rep DescribeNetworkInsightsPaths = D1 ('MetaData "DescribeNetworkInsightsPaths" "Amazonka.EC2.DescribeNetworkInsightsPaths" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeNetworkInsightsPaths'" '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 "networkInsightsPathIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeNetworkInsightsPaths :: DescribeNetworkInsightsPaths Source #

Create a value of DescribeNetworkInsightsPaths 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:DescribeNetworkInsightsPaths', describeNetworkInsightsPaths_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:DescribeNetworkInsightsPaths', describeNetworkInsightsPaths_filters - The filters. The following are the possible values:

  • destination - The ID of the resource.
  • destination-port - The destination port.
  • protocol - The protocol.
  • source - The ID of the resource.

$sel:maxResults:DescribeNetworkInsightsPaths', describeNetworkInsightsPaths_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.

$sel:networkInsightsPathIds:DescribeNetworkInsightsPaths', describeNetworkInsightsPaths_networkInsightsPathIds - The IDs of the paths.

DescribeNetworkInsightsPaths, describeNetworkInsightsPaths_nextToken - The token for the next page of results.

Request Lenses

describeNetworkInsightsPaths_dryRun :: Lens' DescribeNetworkInsightsPaths (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.

describeNetworkInsightsPaths_filters :: Lens' DescribeNetworkInsightsPaths (Maybe [Filter]) Source #

The filters. The following are the possible values:

  • destination - The ID of the resource.
  • destination-port - The destination port.
  • protocol - The protocol.
  • source - The ID of the resource.

describeNetworkInsightsPaths_maxResults :: Lens' DescribeNetworkInsightsPaths (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.

describeNetworkInsightsPaths_networkInsightsPathIds :: Lens' DescribeNetworkInsightsPaths (Maybe [Text]) Source #

The IDs of the paths.

describeNetworkInsightsPaths_nextToken :: Lens' DescribeNetworkInsightsPaths (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeNetworkInsightsPathsResponse Source #

See: newDescribeNetworkInsightsPathsResponse smart constructor.

Constructors

DescribeNetworkInsightsPathsResponse' 

Fields

Instances

Instances details
Generic DescribeNetworkInsightsPathsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Associated Types

type Rep DescribeNetworkInsightsPathsResponse :: Type -> Type #

Methods

from :: DescribeNetworkInsightsPathsResponse -> Rep DescribeNetworkInsightsPathsResponse x #

to :: Rep DescribeNetworkInsightsPathsResponse x -> DescribeNetworkInsightsPathsResponse #

Read DescribeNetworkInsightsPathsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

readsPrec :: Int -> ReadS DescribeNetworkInsightsPathsResponse #

readList :: ReadS [DescribeNetworkInsightsPathsResponse] #

readPrec :: ReadPrec DescribeNetworkInsightsPathsResponse #

readListPrec :: ReadPrec [DescribeNetworkInsightsPathsResponse] #

Show DescribeNetworkInsightsPathsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

showsPrec :: Int -> DescribeNetworkInsightsPathsResponse -> ShowS #

show :: DescribeNetworkInsightsPathsResponse -> String #

showList :: [DescribeNetworkInsightsPathsResponse] -> ShowS #

NFData DescribeNetworkInsightsPathsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

rnf :: DescribeNetworkInsightsPathsResponse -> () #

Eq DescribeNetworkInsightsPathsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

Methods

(==) :: DescribeNetworkInsightsPathsResponse -> DescribeNetworkInsightsPathsResponse -> Bool #

(/=) :: DescribeNetworkInsightsPathsResponse -> DescribeNetworkInsightsPathsResponse -> Bool #

type Rep DescribeNetworkInsightsPathsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsPaths

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

newDescribeNetworkInsightsPathsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeNetworkInsightsPathsResponse'

-> DescribeNetworkInsightsPathsResponse 

Create a value of DescribeNetworkInsightsPathsResponse 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:networkInsightsPaths:DescribeNetworkInsightsPathsResponse', describeNetworkInsightsPathsResponse_networkInsightsPaths - Information about the paths.

DescribeNetworkInsightsPaths, describeNetworkInsightsPathsResponse_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:DescribeNetworkInsightsPathsResponse', describeNetworkInsightsPathsResponse_httpStatus - The response's http status code.

Response Lenses

describeNetworkInsightsPathsResponse_networkInsightsPaths :: Lens' DescribeNetworkInsightsPathsResponse (Maybe [NetworkInsightsPath]) Source #

Information about the paths.

describeNetworkInsightsPathsResponse_nextToken :: Lens' DescribeNetworkInsightsPathsResponse (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.

describeNetworkInsightsPathsResponse_httpStatus :: Lens' DescribeNetworkInsightsPathsResponse Int Source #

The response's http status code.