Skip to content

List Attacks

shield_list_attacks R Documentation

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 ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this 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 request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

EndTime

The end of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

NextToken

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

MaxResults

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.

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
)