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 of your network insights analyses.
This operation returns paginated results.
Synopsis
- data DescribeNetworkInsightsAnalyses = DescribeNetworkInsightsAnalyses' {}
- newDescribeNetworkInsightsAnalyses :: DescribeNetworkInsightsAnalyses
- describeNetworkInsightsAnalyses_analysisEndTime :: Lens' DescribeNetworkInsightsAnalyses (Maybe UTCTime)
- describeNetworkInsightsAnalyses_analysisStartTime :: Lens' DescribeNetworkInsightsAnalyses (Maybe UTCTime)
- describeNetworkInsightsAnalyses_dryRun :: Lens' DescribeNetworkInsightsAnalyses (Maybe Bool)
- describeNetworkInsightsAnalyses_filters :: Lens' DescribeNetworkInsightsAnalyses (Maybe [Filter])
- describeNetworkInsightsAnalyses_maxResults :: Lens' DescribeNetworkInsightsAnalyses (Maybe Natural)
- describeNetworkInsightsAnalyses_networkInsightsAnalysisIds :: Lens' DescribeNetworkInsightsAnalyses (Maybe [Text])
- describeNetworkInsightsAnalyses_networkInsightsPathId :: Lens' DescribeNetworkInsightsAnalyses (Maybe Text)
- describeNetworkInsightsAnalyses_nextToken :: Lens' DescribeNetworkInsightsAnalyses (Maybe Text)
- data DescribeNetworkInsightsAnalysesResponse = DescribeNetworkInsightsAnalysesResponse' {}
- newDescribeNetworkInsightsAnalysesResponse :: Int -> DescribeNetworkInsightsAnalysesResponse
- describeNetworkInsightsAnalysesResponse_networkInsightsAnalyses :: Lens' DescribeNetworkInsightsAnalysesResponse (Maybe [NetworkInsightsAnalysis])
- describeNetworkInsightsAnalysesResponse_nextToken :: Lens' DescribeNetworkInsightsAnalysesResponse (Maybe Text)
- describeNetworkInsightsAnalysesResponse_httpStatus :: Lens' DescribeNetworkInsightsAnalysesResponse Int
Creating a Request
data DescribeNetworkInsightsAnalyses Source #
See: newDescribeNetworkInsightsAnalyses
smart constructor.
DescribeNetworkInsightsAnalyses' | |
|
Instances
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.
DescribeNetworkInsightsAnalysesResponse' | |
|
Instances
newDescribeNetworkInsightsAnalysesResponse Source #
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.