Shield / Client / list_attacks

list_attacks

Shield.Client.list_attacks(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_attacks(
    ResourceArns=[
        'string',
    ],
    StartTime={
        'FromInclusive': datetime(2015, 1, 1),
        'ToExclusive': datetime(2015, 1, 1)
    },
    EndTime={
        'FromInclusive': datetime(2015, 1, 1),
        'ToExclusive': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

Parameters:

• ResourceArns (list) –

  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.

  • (string) –

• StartTime (dict) –

  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.

  • FromInclusive (datetime) –

    The start time, in Unix time in seconds.

  • ToExclusive (datetime) –

    The end time, in Unix time in seconds.

• EndTime (dict) –

  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.

  • FromInclusive (datetime) –

    The start time, in Unix time in seconds.

  • ToExclusive (datetime) –

    The end time, in Unix time in seconds.

• NextToken (string) –

  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 (integer) –

  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.

Return type:

dict

Returns:

Response Syntax

{
    'AttackSummaries': [
        {
            'AttackId': 'string',
            'ResourceArn': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'AttackVectors': [
                {
                    'VectorType': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • AttackSummaries (list) –

    The attack information for the specified time range.

    • (dict) –

      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 (datetime) –

        The start time of the attack, in Unix time in seconds.

      • EndTime (datetime) –

        The end time of the attack, in Unix time in seconds.

      • AttackVectors (list) –

        The list of attacks for a specified time period.

        • (dict) –

          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) –

    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.

Exceptions

• Shield.Client.exceptions.InternalErrorException

• Shield.Client.exceptions.InvalidParameterException

• Shield.Client.exceptions.InvalidOperationException