[ aws . shield ]

list-attacks

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-attacks is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: AttackSummaries

Synopsis

  list-attacks
[--resource-arns <value>]
[--start-time <value>]
[--end-time <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--resource-arns (list)

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.

(string)

Syntax:

"string" "string" ...

--start-time (structure)

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.

FromInclusive -> (timestamp)

The start time, in Unix time in seconds. For more information see timestamp .

ToExclusive -> (timestamp)

The end time, in Unix time in seconds. For more information see timestamp .

Shorthand Syntax:

FromInclusive=timestamp,ToExclusive=timestamp

JSON Syntax:

{
  "FromInclusive": timestamp,
  "ToExclusive": timestamp
}

--end-time (structure)

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.

FromInclusive -> (timestamp)

The start time, in Unix time in seconds. For more information see timestamp .

ToExclusive -> (timestamp)

The end time, in Unix time in seconds. For more information see timestamp .

Shorthand Syntax:

FromInclusive=timestamp,ToExclusive=timestamp

JSON Syntax:

{
  "FromInclusive": timestamp,
  "ToExclusive": timestamp
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve attack summaries from AWS Shield Advanced

The following list-attacks example retrieves summaries of attacks for the specified AWS CloudFront distribution during the specified time period. The response includes attack IDs that you can provide to the describe-attack command for detailed information on an attack.

aws shield list-attacks \
    --resource-arns arn:aws:cloudfront::12345678910:distribution/E1PXMP22ZVFAOR \
    --start-time FromInclusive=1529280000,ToExclusive=1529300000

Output:

{
    "AttackSummaries": [
        {
            "AttackId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "ResourceArn": "arn:aws:cloudfront::123456789012:distribution/E1PXMP22ZVFAOR",
            "StartTime": 1529280000.0,
            "EndTime": 1529449200.0,
            "AttackVectors": [
                {
                    "VectorType": "SYN_FLOOD"
                }
            ]
        }
    ]
}

For more information, see Reviewing DDoS Incidents in the AWS Shield Advanced Developer Guide.

Output

AttackSummaries -> (list)

The attack information for the specified time range.

(structure)

Summarizes all DDoS attacks for a specified time period.

AttackId -> (string)

The unique identifier (ID) of the attack.

ResourceArn -> (string)

The ARN (Amazon Resource Name) of the resource that was attacked.

StartTime -> (timestamp)

The start time of the attack, in Unix time in seconds. For more information see timestamp .

EndTime -> (timestamp)

The end time of the attack, in Unix time in seconds. For more information see timestamp .

AttackVectors -> (list)

The list of attacks for a specified time period.

(structure)

Describes the attack.

VectorType -> (string)

The attack type. Valid values:

• UDP_TRAFFIC

• UDP_FRAGMENT

• GENERIC_UDP_REFLECTION

• DNS_REFLECTION

• NTP_REFLECTION

• CHARGEN_REFLECTION

• SSDP_REFLECTION

• PORT_MAPPER

• RIP_REFLECTION

• SNMP_REFLECTION

• MSSQL_REFLECTION

• NET_BIOS_REFLECTION

• SYN_FLOOD

• ACK_FLOOD

• REQUEST_FLOOD

• HTTP_REFLECTION

• UDS_REFLECTION

• MEMCACHED_REFLECTION

NextToken -> (string)

The token returned by a previous call to indicate that there is more data available. If not null, more results are available. Pass this value for the NextMarker parameter in a subsequent call to ListAttacks to retrieve the next set of items.

AWS WAF might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken .