This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.
", "operations": { "CreateProtection": "Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, Elastic IP Address, or an Amazon Route 53 hosted zone.
", "CreateSubscription": "Activates AWS Shield Advanced for an account.
", "DeleteProtection": "Deletes an AWS Shield Advanced Protection.
", "DeleteSubscription": "Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.
", "DescribeAttack": "Describes the details of a DDoS attack.
", "DescribeProtection": "Lists the details of a Protection object.
", "DescribeSubscription": "Provides details about the AWS Shield Advanced subscription for an account.
", "GetSubscriptionState": "Returns the SubscriptionState, either Active or Inactive.
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
", "ListProtections": "Lists all Protection objects for the account.
" }, "shapes": { "AttackDetail": { "base": "The details of a DDoS attack.
", "refs": { "DescribeAttackResponse$Attack": "The attack that is described.
" } }, "AttackId": { "base": null, "refs": { "AttackDetail$AttackId": "The unique identifier (ID) of the attack.
", "DescribeAttackRequest$AttackId": "The unique identifier (ID) for the attack that to be described.
" } }, "AttackLayer": { "base": null, "refs": { "AttackProperty$AttackLayer": "The type of DDoS event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.
The array of AttackProperty objects.
" } }, "AttackProperty": { "base": "Details of the described attack.
", "refs": { "AttackProperties$member": null } }, "AttackPropertyIdentifier": { "base": null, "refs": { "AttackProperty$AttackPropertyIdentifier": "Defines the DDoS attack property information that is provided.
" } }, "AttackSummaries": { "base": null, "refs": { "ListAttacksResponse$AttackSummaries": "The attack information for the specified time range.
" } }, "AttackSummary": { "base": "Summarizes all DDoS attacks for a specified time period.
", "refs": { "AttackSummaries$member": null } }, "AttackTimestamp": { "base": null, "refs": { "AttackDetail$StartTime": "The time the attack started, in Unix time in seconds. For more information see timestamp.
", "AttackDetail$EndTime": "The time the attack ended, in Unix time in seconds. For more information see timestamp.
", "AttackSummary$StartTime": "The start time of the attack, in Unix time in seconds. For more information see timestamp.
", "AttackSummary$EndTime": "The end time of the attack, in Unix time in seconds. For more information see timestamp.
", "TimeRange$FromInclusive": "The start time, in Unix time in seconds. For more information see timestamp.
", "TimeRange$ToExclusive": "The end time, in Unix time in seconds. For more information see timestamp.
" } }, "AttackVectorDescription": { "base": "Describes the attack.
", "refs": { "AttackVectorDescriptionList$member": null } }, "AttackVectorDescriptionList": { "base": null, "refs": { "AttackSummary$AttackVectors": "The list of attacks for a specified time period.
" } }, "Contributor": { "base": "A contributor to the attack and their contribution.
", "refs": { "TopContributors$member": null } }, "CreateProtectionRequest": { "base": null, "refs": { } }, "CreateProtectionResponse": { "base": null, "refs": { } }, "CreateSubscriptionRequest": { "base": null, "refs": { } }, "CreateSubscriptionResponse": { "base": null, "refs": { } }, "DeleteProtectionRequest": { "base": null, "refs": { } }, "DeleteProtectionResponse": { "base": null, "refs": { } }, "DeleteSubscriptionRequest": { "base": null, "refs": { } }, "DeleteSubscriptionResponse": { "base": null, "refs": { } }, "DescribeAttackRequest": { "base": null, "refs": { } }, "DescribeAttackResponse": { "base": null, "refs": { } }, "DescribeProtectionRequest": { "base": null, "refs": { } }, "DescribeProtectionResponse": { "base": null, "refs": { } }, "DescribeSubscriptionRequest": { "base": null, "refs": { } }, "DescribeSubscriptionResponse": { "base": null, "refs": { } }, "Double": { "base": null, "refs": { "SummarizedCounter$Max": "The maximum value of the counter for a specified time period.
", "SummarizedCounter$Average": "The average value of the counter for a specified time period.
", "SummarizedCounter$Sum": "The total of counter values for a specified time period.
" } }, "DurationInSeconds": { "base": null, "refs": { "Subscription$TimeCommitmentInSeconds": "The length, in seconds, of the AWS Shield Advanced subscription for the account.
" } }, "GetSubscriptionStateRequest": { "base": null, "refs": { } }, "GetSubscriptionStateResponse": { "base": null, "refs": { } }, "Integer": { "base": null, "refs": { "SummarizedCounter$N": "The number of counters for a specified time period.
" } }, "InternalErrorException": { "base": "Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
", "refs": { } }, "InvalidOperationException": { "base": "Exception that indicates that the operation would not cause any change to occur.
", "refs": { } }, "InvalidParameterException": { "base": "Exception that indicates that the parameters passed to the API are invalid.
", "refs": { } }, "InvalidResourceException": { "base": "Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.
", "refs": { } }, "LimitNumber": { "base": null, "refs": { "LimitsExceededException$Limit": null } }, "LimitType": { "base": null, "refs": { "LimitsExceededException$Type": null } }, "LimitsExceededException": { "base": "Exception that indicates that the operation would exceed a limit.
Type is the type of limit that would be exceeded.
Limit is the threshold that would be exceeded.
Exception that indicates that the subscription you are trying to delete has not yet completed the 1-year commitment. You cannot delete this subscription.
", "refs": { } }, "Long": { "base": null, "refs": { "AttackProperty$Total": "The total contributions made to this attack by all contributors, not just the five listed in the TopContributors list.
The contribution of this contributor expressed in Protection units. For example 10,000.
The maximum number of AttackSummary objects to be returned. If this is left blank, the first 20 results will be returned.
", "ListProtectionsRequest$MaxResults": "The maximum number of Protection objects to be returned. If this is left blank the first 20 results will be returned.
" } }, "Mitigation": { "base": "The mitigation applied to a DDoS attack.
", "refs": { "MitigationList$member": null } }, "MitigationList": { "base": null, "refs": { "AttackDetail$Mitigations": "List of mitigation actions taken for the attack.
" } }, "OptimisticLockException": { "base": "Exception that indicates that the protection state has been modified by another client. You can retry the request.
", "refs": { } }, "Protection": { "base": "An object that represents a resource that is under DDoS protection.
", "refs": { "DescribeProtectionResponse$Protection": "The Protection object that is described.
", "Protections$member": null } }, "ProtectionId": { "base": null, "refs": { "CreateProtectionResponse$ProtectionId": "The unique identifier (ID) for the Protection object that is created.
", "DeleteProtectionRequest$ProtectionId": "The unique identifier (ID) for the Protection object to be deleted.
", "DescribeProtectionRequest$ProtectionId": "The unique identifier (ID) for the Protection object that is described.
", "Protection$Id": "The unique identifier (ID) of the protection.
" } }, "ProtectionName": { "base": null, "refs": { "CreateProtectionRequest$Name": "Friendly name for the Protection you are creating.
The friendly name of the protection. For example, My CloudFront distributions.
The array of enabled Protection objects.
" } }, "ResourceAlreadyExistsException": { "base": "Exception indicating the specified resource already exists.
", "refs": { } }, "ResourceArn": { "base": null, "refs": { "AttackDetail$ResourceArn": "The ARN (Amazon Resource Name) of the resource that was attacked.
", "CreateProtectionRequest$ResourceArn": "The ARN (Amazon Resource Name) of the resource to be protected.
The ARN should be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
For AWS CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
For Amazon Route 53: arn:aws:route53::account-id:hostedzone/hosted-zone-id
For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id
The ARN (Amazon Resource Name) of the AWS resource that is protected.
", "ResourceArnFilterList$member": null } }, "ResourceArnFilterList": { "base": null, "refs": { "ListAttacksRequest$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.
" } }, "ResourceNotFoundException": { "base": "Exception indicating the specified resource does not exist.
", "refs": { } }, "String": { "base": null, "refs": { "AttackSummary$AttackId": "The unique identifier (ID) of the attack.
", "AttackSummary$ResourceArn": "The ARN (Amazon Resource Name) of the resource that was attacked.
", "AttackVectorDescription$VectorType": "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
The name of the contributor. This is dependent on the AttackPropertyIdentifier. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States.
The name of the mitigation taken for this attack.
", "SubResourceSummary$Id": "The unique identifier (ID) of the SubResource.
The attack type, for example, SNMP reflection or SYN flood.
", "SummarizedCounter$Name": "The counter name.
", "SummarizedCounter$Unit": "The unit of the counters.
" } }, "SubResourceSummary": { "base": "The attack information for the specified SubResource.
", "refs": { "SubResourceSummaryList$member": null } }, "SubResourceSummaryList": { "base": null, "refs": { "AttackDetail$SubResources": "If applicable, additional detail about the resource being attacked, for example, IP address or URL.
" } }, "SubResourceType": { "base": null, "refs": { "SubResourceSummary$Type": "The SubResource type.
Information about the AWS Shield Advanced subscription for an account.
", "refs": { "DescribeSubscriptionResponse$Subscription": "The AWS Shield Advanced subscription details for an account.
" } }, "SubscriptionState": { "base": null, "refs": { "GetSubscriptionStateResponse$SubscriptionState": "The status of the subscription.
" } }, "SummarizedAttackVector": { "base": "A summary of information about the attack.
", "refs": { "SummarizedAttackVectorList$member": null } }, "SummarizedAttackVectorList": { "base": null, "refs": { "SubResourceSummary$AttackVectors": "The list of attack types and associated counters.
" } }, "SummarizedCounter": { "base": "The counter that describes a DDoS attack.
", "refs": { "SummarizedCounterList$member": null } }, "SummarizedCounterList": { "base": null, "refs": { "AttackDetail$AttackCounters": "List of counters that describe the attack for the specified time period.
", "SubResourceSummary$Counters": "The counters that describe the details of the attack.
", "SummarizedAttackVector$VectorCounters": "The list of counters that describe the details of the attack.
" } }, "TimeRange": { "base": "The time range.
", "refs": { "ListAttacksRequest$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.
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.
The start time of the subscription, in Unix time in seconds. For more information see timestamp.
" } }, "Token": { "base": null, "refs": { "ListAttacksRequest$NextToken": "The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.
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.
The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.
If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.
The array of Contributor objects that includes the top five contributors to an attack.
" } }, "Unit": { "base": null, "refs": { "AttackProperty$Unit": "The unit of the Value of the contributions.