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 paths.
This operation returns paginated results.
Synopsis
- data DescribeNetworkInsightsPaths = DescribeNetworkInsightsPaths' {}
- newDescribeNetworkInsightsPaths :: DescribeNetworkInsightsPaths
- describeNetworkInsightsPaths_dryRun :: Lens' DescribeNetworkInsightsPaths (Maybe Bool)
- describeNetworkInsightsPaths_filters :: Lens' DescribeNetworkInsightsPaths (Maybe [Filter])
- describeNetworkInsightsPaths_maxResults :: Lens' DescribeNetworkInsightsPaths (Maybe Natural)
- describeNetworkInsightsPaths_networkInsightsPathIds :: Lens' DescribeNetworkInsightsPaths (Maybe [Text])
- describeNetworkInsightsPaths_nextToken :: Lens' DescribeNetworkInsightsPaths (Maybe Text)
- data DescribeNetworkInsightsPathsResponse = DescribeNetworkInsightsPathsResponse' {}
- newDescribeNetworkInsightsPathsResponse :: Int -> DescribeNetworkInsightsPathsResponse
- describeNetworkInsightsPathsResponse_networkInsightsPaths :: Lens' DescribeNetworkInsightsPathsResponse (Maybe [NetworkInsightsPath])
- describeNetworkInsightsPathsResponse_nextToken :: Lens' DescribeNetworkInsightsPathsResponse (Maybe Text)
- describeNetworkInsightsPathsResponse_httpStatus :: Lens' DescribeNetworkInsightsPathsResponse Int
Creating a Request
data DescribeNetworkInsightsPaths Source #
See: newDescribeNetworkInsightsPaths
smart constructor.
DescribeNetworkInsightsPaths' | |
|
Instances
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.
DescribeNetworkInsightsPathsResponse' | |
|
Instances
newDescribeNetworkInsightsPathsResponse Source #
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.