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 Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
This operation returns paginated results.
Synopsis
- data DescribeTrafficMirrorSessions = DescribeTrafficMirrorSessions' {}
- newDescribeTrafficMirrorSessions :: DescribeTrafficMirrorSessions
- describeTrafficMirrorSessions_dryRun :: Lens' DescribeTrafficMirrorSessions (Maybe Bool)
- describeTrafficMirrorSessions_filters :: Lens' DescribeTrafficMirrorSessions (Maybe [Filter])
- describeTrafficMirrorSessions_maxResults :: Lens' DescribeTrafficMirrorSessions (Maybe Natural)
- describeTrafficMirrorSessions_nextToken :: Lens' DescribeTrafficMirrorSessions (Maybe Text)
- describeTrafficMirrorSessions_trafficMirrorSessionIds :: Lens' DescribeTrafficMirrorSessions (Maybe [Text])
- data DescribeTrafficMirrorSessionsResponse = DescribeTrafficMirrorSessionsResponse' {}
- newDescribeTrafficMirrorSessionsResponse :: Int -> DescribeTrafficMirrorSessionsResponse
- describeTrafficMirrorSessionsResponse_nextToken :: Lens' DescribeTrafficMirrorSessionsResponse (Maybe Text)
- describeTrafficMirrorSessionsResponse_trafficMirrorSessions :: Lens' DescribeTrafficMirrorSessionsResponse (Maybe [TrafficMirrorSession])
- describeTrafficMirrorSessionsResponse_httpStatus :: Lens' DescribeTrafficMirrorSessionsResponse Int
Creating a Request
data DescribeTrafficMirrorSessions Source #
See: newDescribeTrafficMirrorSessions
smart constructor.
DescribeTrafficMirrorSessions' | |
|
Instances
newDescribeTrafficMirrorSessions :: DescribeTrafficMirrorSessions Source #
Create a value of DescribeTrafficMirrorSessions
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:DescribeTrafficMirrorSessions'
, describeTrafficMirrorSessions_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:DescribeTrafficMirrorSessions'
, describeTrafficMirrorSessions_filters
- One or more filters. The possible values are:
description
: The Traffic Mirror session description.network-interface-id
: The ID of the Traffic Mirror session network interface.owner-id
: The ID of the account that owns the Traffic Mirror session.packet-length
: The assigned number of packets to mirror.session-number
: The assigned session number.traffic-mirror-filter-id
: The ID of the Traffic Mirror filter.traffic-mirror-session-id
: The ID of the Traffic Mirror session.traffic-mirror-target-id
: The ID of the Traffic Mirror target.virtual-network-id
: The virtual network ID of the Traffic Mirror session.
$sel:maxResults:DescribeTrafficMirrorSessions'
, describeTrafficMirrorSessions_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.
DescribeTrafficMirrorSessions
, describeTrafficMirrorSessions_nextToken
- The token for the next page of results.
$sel:trafficMirrorSessionIds:DescribeTrafficMirrorSessions'
, describeTrafficMirrorSessions_trafficMirrorSessionIds
- The ID of the Traffic Mirror session.
Request Lenses
describeTrafficMirrorSessions_dryRun :: Lens' DescribeTrafficMirrorSessions (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
.
describeTrafficMirrorSessions_filters :: Lens' DescribeTrafficMirrorSessions (Maybe [Filter]) Source #
One or more filters. The possible values are:
description
: The Traffic Mirror session description.network-interface-id
: The ID of the Traffic Mirror session network interface.owner-id
: The ID of the account that owns the Traffic Mirror session.packet-length
: The assigned number of packets to mirror.session-number
: The assigned session number.traffic-mirror-filter-id
: The ID of the Traffic Mirror filter.traffic-mirror-session-id
: The ID of the Traffic Mirror session.traffic-mirror-target-id
: The ID of the Traffic Mirror target.virtual-network-id
: The virtual network ID of the Traffic Mirror session.
describeTrafficMirrorSessions_maxResults :: Lens' DescribeTrafficMirrorSessions (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.
describeTrafficMirrorSessions_nextToken :: Lens' DescribeTrafficMirrorSessions (Maybe Text) Source #
The token for the next page of results.
describeTrafficMirrorSessions_trafficMirrorSessionIds :: Lens' DescribeTrafficMirrorSessions (Maybe [Text]) Source #
The ID of the Traffic Mirror session.
Destructuring the Response
data DescribeTrafficMirrorSessionsResponse Source #
See: newDescribeTrafficMirrorSessionsResponse
smart constructor.
DescribeTrafficMirrorSessionsResponse' | |
|
Instances
newDescribeTrafficMirrorSessionsResponse Source #
Create a value of DescribeTrafficMirrorSessionsResponse
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:
DescribeTrafficMirrorSessions
, describeTrafficMirrorSessionsResponse_nextToken
- The token to use to retrieve the next page of results. The value is
null
when there are no more results to return.
$sel:trafficMirrorSessions:DescribeTrafficMirrorSessionsResponse'
, describeTrafficMirrorSessionsResponse_trafficMirrorSessions
- Describes one or more Traffic Mirror sessions. By default, all Traffic
Mirror sessions are described. Alternatively, you can filter the
results.
$sel:httpStatus:DescribeTrafficMirrorSessionsResponse'
, describeTrafficMirrorSessionsResponse_httpStatus
- The response's http status code.
Response Lenses
describeTrafficMirrorSessionsResponse_nextToken :: Lens' DescribeTrafficMirrorSessionsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. The value is
null
when there are no more results to return.
describeTrafficMirrorSessionsResponse_trafficMirrorSessions :: Lens' DescribeTrafficMirrorSessionsResponse (Maybe [TrafficMirrorSession]) Source #
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
describeTrafficMirrorSessionsResponse_httpStatus :: Lens' DescribeTrafficMirrorSessionsResponse Int Source #
The response's http status code.