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

Amazonka.EC2.DescribeTrafficMirrorSessions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribeTrafficMirrorSessions Source #

See: newDescribeTrafficMirrorSessions smart constructor.

Constructors

DescribeTrafficMirrorSessions'

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]
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.
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.
nextToken :: Maybe Text
The token for the next page of results.
trafficMirrorSessionIds :: Maybe [Text]
The ID of the Traffic Mirror session.

Instances

Instances details

ToHeaders DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods toHeaders :: DescribeTrafficMirrorSessions -> [Header] #
ToPath DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods toPath :: DescribeTrafficMirrorSessions -> ByteString #
ToQuery DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods toQuery :: DescribeTrafficMirrorSessions -> QueryString #
AWSPager DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods page :: DescribeTrafficMirrorSessions -> AWSResponse DescribeTrafficMirrorSessions -> Maybe DescribeTrafficMirrorSessions #
AWSRequest DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Associated Types type AWSResponse DescribeTrafficMirrorSessions # Methods request :: (Service -> Service) -> DescribeTrafficMirrorSessions -> Request DescribeTrafficMirrorSessions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTrafficMirrorSessions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTrafficMirrorSessions))) #
Generic DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Associated Types type Rep DescribeTrafficMirrorSessions :: Type -> Type # Methods from :: DescribeTrafficMirrorSessions -> Rep DescribeTrafficMirrorSessions x # to :: Rep DescribeTrafficMirrorSessions x -> DescribeTrafficMirrorSessions #
Read DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods readsPrec :: Int -> ReadS DescribeTrafficMirrorSessions # readList :: ReadS [DescribeTrafficMirrorSessions] # readPrec :: ReadPrec DescribeTrafficMirrorSessions # readListPrec :: ReadPrec [DescribeTrafficMirrorSessions] #
Show DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods showsPrec :: Int -> DescribeTrafficMirrorSessions -> ShowS # show :: DescribeTrafficMirrorSessions -> String # showList :: [DescribeTrafficMirrorSessions] -> ShowS #
NFData DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods rnf :: DescribeTrafficMirrorSessions -> () #
Eq DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods (==) :: DescribeTrafficMirrorSessions -> DescribeTrafficMirrorSessions -> Bool # (/=) :: DescribeTrafficMirrorSessions -> DescribeTrafficMirrorSessions -> Bool #
Hashable DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods hashWithSalt :: Int -> DescribeTrafficMirrorSessions -> Int # hash :: DescribeTrafficMirrorSessions -> Int #
type AWSResponse DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions type AWSResponse DescribeTrafficMirrorSessions = DescribeTrafficMirrorSessionsResponse
type Rep DescribeTrafficMirrorSessions Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions type Rep DescribeTrafficMirrorSessions = D1 ('MetaData "DescribeTrafficMirrorSessions" "Amazonka.EC2.DescribeTrafficMirrorSessions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTrafficMirrorSessions'" '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 "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "trafficMirrorSessionIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

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.

Constructors

DescribeTrafficMirrorSessionsResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. The value is `null` when there are no more results to return. trafficMirrorSessions :: Maybe [TrafficMirrorSession] Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeTrafficMirrorSessionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Associated Types type Rep DescribeTrafficMirrorSessionsResponse :: Type -> Type # Methods from :: DescribeTrafficMirrorSessionsResponse -> Rep DescribeTrafficMirrorSessionsResponse x # to :: Rep DescribeTrafficMirrorSessionsResponse x -> DescribeTrafficMirrorSessionsResponse #
Read DescribeTrafficMirrorSessionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods readsPrec :: Int -> ReadS DescribeTrafficMirrorSessionsResponse # readList :: ReadS [DescribeTrafficMirrorSessionsResponse] # readPrec :: ReadPrec DescribeTrafficMirrorSessionsResponse # readListPrec :: ReadPrec [DescribeTrafficMirrorSessionsResponse] #
Show DescribeTrafficMirrorSessionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods showsPrec :: Int -> DescribeTrafficMirrorSessionsResponse -> ShowS # show :: DescribeTrafficMirrorSessionsResponse -> String # showList :: [DescribeTrafficMirrorSessionsResponse] -> ShowS #
NFData DescribeTrafficMirrorSessionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods rnf :: DescribeTrafficMirrorSessionsResponse -> () #
Eq DescribeTrafficMirrorSessionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions Methods (==) :: DescribeTrafficMirrorSessionsResponse -> DescribeTrafficMirrorSessionsResponse -> Bool # (/=) :: DescribeTrafficMirrorSessionsResponse -> DescribeTrafficMirrorSessionsResponse -> Bool #
type Rep DescribeTrafficMirrorSessionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTrafficMirrorSessions type Rep DescribeTrafficMirrorSessionsResponse = D1 ('MetaData "DescribeTrafficMirrorSessionsResponse" "Amazonka.EC2.DescribeTrafficMirrorSessions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTrafficMirrorSessionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "trafficMirrorSessions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TrafficMirrorSession])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTrafficMirrorSessionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTrafficMirrorSessionsResponse'`
-> DescribeTrafficMirrorSessionsResponse

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.