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

Class: Aws::Shield::Types::ListAttacksRequest

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

Overview

Note:

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

{
  resource_arns: ["ResourceArn"],
  start_time: {
    from_inclusive: Time.now,
    to_exclusive: Time.now,
  },
  end_time: {
    from_inclusive: Time.now,
    to_exclusive: Time.now,
  },
  next_token: "Token",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTypes::TimeRange

The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

Returns:



462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 462

class ListAttacksRequest < Struct.new(
  :resource_arns,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of AttackSummary objects to be returned. If this is left blank, the first 20 results will be returned.

Returns:

  • (Integer)


462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 462

class ListAttacksRequest < Struct.new(
  :resource_arns,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.

Returns:

  • (String)


462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 462

class ListAttacksRequest < Struct.new(
  :resource_arns,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  include Aws::Structure
end

#resource_arnsArray<String>

The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.

Returns:

  • (Array<String>)


462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 462

class ListAttacksRequest < Struct.new(
  :resource_arns,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  include Aws::Structure
end

#start_timeTypes::TimeRange

The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

Returns:



462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 462

class ListAttacksRequest < Struct.new(
  :resource_arns,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  include Aws::Structure
end