Class: Aws::EC2::Types::DescribeTrafficMirrorSessionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeTrafficMirrorSessionsRequest data as a hash:

{
  traffic_mirror_session_ids: ["TrafficMirrorSessionId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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.

Returns:

  • (Boolean)


20434
20435
20436
20437
20438
20439
20440
20441
20442
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20434

class DescribeTrafficMirrorSessionsRequest < Struct.new(
  :traffic_mirror_session_ids,
  :dry_run,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::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.

Returns:



20434
20435
20436
20437
20438
20439
20440
20441
20442
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20434

class DescribeTrafficMirrorSessionsRequest < Struct.new(
  :traffic_mirror_session_ids,
  :dry_run,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

  • (Integer)


20434
20435
20436
20437
20438
20439
20440
20441
20442
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20434

class DescribeTrafficMirrorSessionsRequest < Struct.new(
  :traffic_mirror_session_ids,
  :dry_run,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


20434
20435
20436
20437
20438
20439
20440
20441
20442
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20434

class DescribeTrafficMirrorSessionsRequest < Struct.new(
  :traffic_mirror_session_ids,
  :dry_run,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_mirror_session_idsArray<String>

The ID of the Traffic Mirror session.

Returns:

  • (Array<String>)


20434
20435
20436
20437
20438
20439
20440
20441
20442
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20434

class DescribeTrafficMirrorSessionsRequest < Struct.new(
  :traffic_mirror_session_ids,
  :dry_run,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end