Learn R Programming

paws.security.identity (version 0.1.11)

shield_list_attacks: Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period

Description

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

Usage

shield_list_attacks(ResourceArns, StartTime, EndTime, NextToken,
  MaxResults)

Arguments

ResourceArns

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.

StartTime

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.

EndTime

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.

NextToken

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

MaxResults

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.

Value

A list with the following syntax:

list(
  AttackSummaries = list(
    list(
      AttackId = "string",
      ResourceArn = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      AttackVectors = list(
        list(
          VectorType = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_attacks(
  ResourceArns = list(
    "string"
  ),
  StartTime = list(
    FromInclusive = as.POSIXct(
      "2015-01-01"
    ),
    ToExclusive = as.POSIXct(
      "2015-01-01"
    )
  ),
  EndTime = list(
    FromInclusive = as.POSIXct(
      "2015-01-01"
    ),
    ToExclusive = as.POSIXct(
      "2015-01-01"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)