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

Description

Describes one or more of your network insights analyses.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeNetworkInsightsAnalyses Source #

See: newDescribeNetworkInsightsAnalyses smart constructor.

Constructors

DescribeNetworkInsightsAnalyses' 

Fields

  • analysisEndTime :: Maybe ISO8601

    The time when the network insights analyses ended.

  • analysisStartTime :: Maybe ISO8601

    The time when the network insights analyses started.

  • 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:

    • path-found - A Boolean value that indicates whether a feasible path is found.
    • status - The status of the analysis (running | succeeded | failed).
  • 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.

  • networkInsightsAnalysisIds :: Maybe [Text]

    The ID of the network insights analyses. You must specify either analysis IDs or a path ID.

  • networkInsightsPathId :: Maybe Text

    The ID of the path. You must specify either a path ID or analysis IDs.

  • nextToken :: Maybe Text

    The token for the next page of results.

Instances

Instances details
ToHeaders DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

toHeaders :: DescribeNetworkInsightsAnalyses -> [Header] #

ToPath DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

toPath :: DescribeNetworkInsightsAnalyses -> ByteString #

ToQuery DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

toQuery :: DescribeNetworkInsightsAnalyses -> QueryString #

AWSPager DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

page :: DescribeNetworkInsightsAnalyses -> AWSResponse DescribeNetworkInsightsAnalyses -> Maybe DescribeNetworkInsightsAnalyses #

AWSRequest DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Associated Types

type AWSResponse DescribeNetworkInsightsAnalyses #

Methods

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

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

Generic DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Associated Types

type Rep DescribeNetworkInsightsAnalyses :: Type -> Type #

Methods

from :: DescribeNetworkInsightsAnalyses -> Rep DescribeNetworkInsightsAnalyses x #

to :: Rep DescribeNetworkInsightsAnalyses x -> DescribeNetworkInsightsAnalyses #

Read DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

readsPrec :: Int -> ReadS DescribeNetworkInsightsAnalyses #

readList :: ReadS [DescribeNetworkInsightsAnalyses] #

readPrec :: ReadPrec DescribeNetworkInsightsAnalyses #

readListPrec :: ReadPrec [DescribeNetworkInsightsAnalyses] #

Show DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

showsPrec :: Int -> DescribeNetworkInsightsAnalyses -> ShowS #

show :: DescribeNetworkInsightsAnalyses -> String #

showList :: [DescribeNetworkInsightsAnalyses] -> ShowS #

NFData DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

rnf :: DescribeNetworkInsightsAnalyses -> () #

Eq DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

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

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

Hashable DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

hashWithSalt :: Int -> DescribeNetworkInsightsAnalyses -> Int #

hash :: DescribeNetworkInsightsAnalyses -> Int #

type AWSResponse DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

type AWSResponse DescribeNetworkInsightsAnalyses = DescribeNetworkInsightsAnalysesResponse
type Rep DescribeNetworkInsightsAnalyses Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

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

newDescribeNetworkInsightsAnalyses :: DescribeNetworkInsightsAnalyses Source #

Create a value of DescribeNetworkInsightsAnalyses 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:analysisEndTime:DescribeNetworkInsightsAnalyses', describeNetworkInsightsAnalyses_analysisEndTime - The time when the network insights analyses ended.

$sel:analysisStartTime:DescribeNetworkInsightsAnalyses', describeNetworkInsightsAnalyses_analysisStartTime - The time when the network insights analyses started.

$sel:dryRun:DescribeNetworkInsightsAnalyses', describeNetworkInsightsAnalyses_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:DescribeNetworkInsightsAnalyses', describeNetworkInsightsAnalyses_filters - The filters. The following are the possible values:

  • path-found - A Boolean value that indicates whether a feasible path is found.
  • status - The status of the analysis (running | succeeded | failed).

$sel:maxResults:DescribeNetworkInsightsAnalyses', describeNetworkInsightsAnalyses_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:networkInsightsAnalysisIds:DescribeNetworkInsightsAnalyses', describeNetworkInsightsAnalyses_networkInsightsAnalysisIds - The ID of the network insights analyses. You must specify either analysis IDs or a path ID.

DescribeNetworkInsightsAnalyses, describeNetworkInsightsAnalyses_networkInsightsPathId - The ID of the path. You must specify either a path ID or analysis IDs.

DescribeNetworkInsightsAnalyses, describeNetworkInsightsAnalyses_nextToken - The token for the next page of results.

Request Lenses

describeNetworkInsightsAnalyses_analysisEndTime :: Lens' DescribeNetworkInsightsAnalyses (Maybe UTCTime) Source #

The time when the network insights analyses ended.

describeNetworkInsightsAnalyses_analysisStartTime :: Lens' DescribeNetworkInsightsAnalyses (Maybe UTCTime) Source #

The time when the network insights analyses started.

describeNetworkInsightsAnalyses_dryRun :: Lens' DescribeNetworkInsightsAnalyses (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.

describeNetworkInsightsAnalyses_filters :: Lens' DescribeNetworkInsightsAnalyses (Maybe [Filter]) Source #

The filters. The following are the possible values:

  • path-found - A Boolean value that indicates whether a feasible path is found.
  • status - The status of the analysis (running | succeeded | failed).

describeNetworkInsightsAnalyses_maxResults :: Lens' DescribeNetworkInsightsAnalyses (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.

describeNetworkInsightsAnalyses_networkInsightsAnalysisIds :: Lens' DescribeNetworkInsightsAnalyses (Maybe [Text]) Source #

The ID of the network insights analyses. You must specify either analysis IDs or a path ID.

describeNetworkInsightsAnalyses_networkInsightsPathId :: Lens' DescribeNetworkInsightsAnalyses (Maybe Text) Source #

The ID of the path. You must specify either a path ID or analysis IDs.

describeNetworkInsightsAnalyses_nextToken :: Lens' DescribeNetworkInsightsAnalyses (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeNetworkInsightsAnalysesResponse Source #

See: newDescribeNetworkInsightsAnalysesResponse smart constructor.

Constructors

DescribeNetworkInsightsAnalysesResponse' 

Fields

Instances

Instances details
Generic DescribeNetworkInsightsAnalysesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Associated Types

type Rep DescribeNetworkInsightsAnalysesResponse :: Type -> Type #

Methods

from :: DescribeNetworkInsightsAnalysesResponse -> Rep DescribeNetworkInsightsAnalysesResponse x #

to :: Rep DescribeNetworkInsightsAnalysesResponse x -> DescribeNetworkInsightsAnalysesResponse #

Read DescribeNetworkInsightsAnalysesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

readsPrec :: Int -> ReadS DescribeNetworkInsightsAnalysesResponse #

readList :: ReadS [DescribeNetworkInsightsAnalysesResponse] #

readPrec :: ReadPrec DescribeNetworkInsightsAnalysesResponse #

readListPrec :: ReadPrec [DescribeNetworkInsightsAnalysesResponse] #

Show DescribeNetworkInsightsAnalysesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

showsPrec :: Int -> DescribeNetworkInsightsAnalysesResponse -> ShowS #

show :: DescribeNetworkInsightsAnalysesResponse -> String #

showList :: [DescribeNetworkInsightsAnalysesResponse] -> ShowS #

NFData DescribeNetworkInsightsAnalysesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

rnf :: DescribeNetworkInsightsAnalysesResponse -> () #

Eq DescribeNetworkInsightsAnalysesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

Methods

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

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

type Rep DescribeNetworkInsightsAnalysesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNetworkInsightsAnalyses

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

newDescribeNetworkInsightsAnalysesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeNetworkInsightsAnalysesResponse'

-> DescribeNetworkInsightsAnalysesResponse 

Create a value of DescribeNetworkInsightsAnalysesResponse 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:networkInsightsAnalyses:DescribeNetworkInsightsAnalysesResponse', describeNetworkInsightsAnalysesResponse_networkInsightsAnalyses - Information about the network insights analyses.

DescribeNetworkInsightsAnalyses, describeNetworkInsightsAnalysesResponse_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:DescribeNetworkInsightsAnalysesResponse', describeNetworkInsightsAnalysesResponse_httpStatus - The response's http status code.

Response Lenses

describeNetworkInsightsAnalysesResponse_networkInsightsAnalyses :: Lens' DescribeNetworkInsightsAnalysesResponse (Maybe [NetworkInsightsAnalysis]) Source #

Information about the network insights analyses.

describeNetworkInsightsAnalysesResponse_nextToken :: Lens' DescribeNetworkInsightsAnalysesResponse (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.

describeNetworkInsightsAnalysesResponse_httpStatus :: Lens' DescribeNetworkInsightsAnalysesResponse Int Source #

The response's http status code.