You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Shield::Types::ListAttacksRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Shield::Types::ListAttacksRequest
- Defined in:
- (unknown)
Overview
When passing ListAttacksRequest as input to an Aws::Client method, you can use a vanilla 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
-
#end_time ⇒ Types::TimeRange
The end of the time period for the attacks.
-
#max_results ⇒ Integer
The maximum number of AttackSummary objects to return.
-
#next_token ⇒ String
The
ListAttacksRequest.NextMarker
value from a previous call toListAttacksRequest
. -
#resource_arns ⇒ Array<String>
The ARN (Amazon Resource Name) of the resource that was attacked.
-
#start_time ⇒ Types::TimeRange
The start of the time period for the attacks.
Instance Attribute Details
#end_time ⇒ Types::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.
#max_results ⇒ Integer
The maximum number of AttackSummary objects to return. If you leave this blank, Shield Advanced returns the first 20 results.
This is a maximum value. Shield Advanced might return the results in
smaller batches. That is, the number of objects returned could be less
than MaxResults
, even if there are still more objects yet to return.
If there are more objects to return, Shield Advanced returns a value in
NextToken
that you can use in your next request, to get the next batch
of objects.
#next_token ⇒ String
The ListAttacksRequest.NextMarker
value from a previous call to
ListAttacksRequest
. Pass null if this is the first call.
#resource_arns ⇒ Array<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.
#start_time ⇒ Types::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.