You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeFlowLogsRequest

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 DescribeFlowLogsRequest data as a hash:

{
  dry_run: false,
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  flow_log_ids: ["String"],
  max_results: 1,
  next_token: "String",
}

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)


10822
10823
10824
10825
10826
10827
10828
10829
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10822

class DescribeFlowLogsRequest < Struct.new(
  :dry_run,
  :filter,
  :flow_log_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#filterArray<Types::Filter>

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and S3.

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL).

Returns:



10822
10823
10824
10825
10826
10827
10828
10829
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10822

class DescribeFlowLogsRequest < Struct.new(
  :dry_run,
  :filter,
  :flow_log_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#flow_log_idsArray<String>

One or more flow log IDs.

Returns:

  • (Array<String>)


10822
10823
10824
10825
10826
10827
10828
10829
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10822

class DescribeFlowLogsRequest < Struct.new(
  :dry_run,
  :filter,
  :flow_log_ids,
  :max_results,
  :next_token)
  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)


10822
10823
10824
10825
10826
10827
10828
10829
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10822

class DescribeFlowLogsRequest < Struct.new(
  :dry_run,
  :filter,
  :flow_log_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


10822
10823
10824
10825
10826
10827
10828
10829
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10822

class DescribeFlowLogsRequest < Struct.new(
  :dry_run,
  :filter,
  :flow_log_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end