AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Interface for accessing Shield
Shield AdvancedThis is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and Shield Developer Guide.
Namespace: Amazon.Shield
Assembly: AWSSDK.Shield.dll
Version: 3.x.y.z
public interface IAmazonShield IAmazonService, IDisposable
The IAmazonShield type exposes the following members
Name | Type | Description | |
---|---|---|---|
Paginators | Amazon.Shield.Model.IShieldPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
AssociateDRTLogBucket(AssociateDRTLogBucketRequest) |
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an |
|
AssociateDRTLogBucketAsync(AssociateDRTLogBucketRequest, CancellationToken) |
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an |
|
AssociateDRTRole(AssociateDRTRoleRequest) |
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
You can associate only one
Prior to making the The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
You must have the
To use the services of the SRT and make an |
|
AssociateDRTRoleAsync(AssociateDRTRoleRequest, CancellationToken) |
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
You can associate only one
Prior to making the The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
You must have the
To use the services of the SRT and make an |
|
AssociateHealthCheck(AssociateHealthCheckRequest) |
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response. You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide. |
|
AssociateHealthCheckAsync(AssociateHealthCheckRequest, CancellationToken) |
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response. You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide. |
|
AssociateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest) |
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable
proactive engagement, use the calls This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.
The contacts that you provide in the request replace any contacts that were already
defined. If you already have contacts defined and want to use them, retrieve the list
using |
|
AssociateProactiveEngagementDetailsAsync(AssociateProactiveEngagementDetailsRequest, CancellationToken) |
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable
proactive engagement, use the calls This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.
The contacts that you provide in the request replace any contacts that were already
defined. If you already have contacts defined and want to use them, retrieve the list
using |
|
CreateProtection(CreateProtectionRequest) |
Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
You can add protection to only a single resource with each |
|
CreateProtectionAsync(CreateProtectionRequest, CancellationToken) |
Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
You can add protection to only a single resource with each |
|
CreateProtectionGroup(CreateProtectionGroupRequest) |
Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives. |
|
CreateProtectionGroupAsync(CreateProtectionGroupRequest, CancellationToken) |
Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives. |
|
CreateSubscription(CreateSubscriptionRequest) |
Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions
are billed against the organization's payer account, regardless of whether the payer
account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically
renewed at the end of the existing subscription period. You can change this by submitting
an |
|
CreateSubscriptionAsync(CreateSubscriptionRequest, CancellationToken) |
Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions
are billed against the organization's payer account, regardless of whether the payer
account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically
renewed at the end of the existing subscription period. You can change this by submitting
an |
|
DeleteProtection(DeleteProtectionRequest) |
Deletes an Shield Advanced Protection. |
|
DeleteProtectionAsync(DeleteProtectionRequest, CancellationToken) |
Deletes an Shield Advanced Protection. |
|
DeleteProtectionGroup(DeleteProtectionGroupRequest) |
Removes the specified protection group. |
|
DeleteProtectionGroupAsync(DeleteProtectionGroupRequest, CancellationToken) |
Removes the specified protection group. |
|
DeleteSubscription(DeleteSubscriptionRequest) |
Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment. |
|
DeleteSubscriptionAsync(DeleteSubscriptionRequest, CancellationToken) |
Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment. |
|
DescribeAttack(DescribeAttackRequest) |
Describes the details of a DDoS attack. |
|
DescribeAttackAsync(DescribeAttackRequest, CancellationToken) |
Describes the details of a DDoS attack. |
|
DescribeAttackStatistics(DescribeAttackStatisticsRequest) |
Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight
UTC, today. For example, if the current time is The time range indicates the period covered by the attack statistics data items. |
|
DescribeAttackStatisticsAsync(DescribeAttackStatisticsRequest, CancellationToken) |
Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight
UTC, today. For example, if the current time is The time range indicates the period covered by the attack statistics data items. |
|
DescribeDRTAccess(DescribeDRTAccessRequest) |
Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation. |
|
DescribeDRTAccessAsync(DescribeDRTAccessRequest, CancellationToken) |
Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation. |
|
DescribeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest) |
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support. |
|
DescribeEmergencyContactSettingsAsync(DescribeEmergencyContactSettingsRequest, CancellationToken) |
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support. |
|
DescribeProtection(DescribeProtectionRequest) |
Lists the details of a Protection object. |
|
DescribeProtectionAsync(DescribeProtectionRequest, CancellationToken) |
Lists the details of a Protection object. |
|
DescribeProtectionGroup(DescribeProtectionGroupRequest) |
Returns the specification for the specified protection group. |
|
DescribeProtectionGroupAsync(DescribeProtectionGroupRequest, CancellationToken) |
Returns the specification for the specified protection group. |
|
DescribeSubscription(DescribeSubscriptionRequest) |
Provides details about the Shield Advanced subscription for an account. |
|
DescribeSubscriptionAsync(DescribeSubscriptionRequest, CancellationToken) |
Provides details about the Shield Advanced subscription for an account. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
DisableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest) |
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource. |
|
DisableApplicationLayerAutomaticResponseAsync(DisableApplicationLayerAutomaticResponseRequest, CancellationToken) |
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource. |
|
DisableProactiveEngagement(DisableProactiveEngagementRequest) |
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support. |
|
DisableProactiveEngagementAsync(DisableProactiveEngagementRequest, CancellationToken) |
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support. |
|
DisassociateDRTLogBucket(DisassociateDRTLogBucketRequest) |
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously. |
|
DisassociateDRTLogBucketAsync(DisassociateDRTLogBucketRequest, CancellationToken) |
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously. |
|
DisassociateDRTRole(DisassociateDRTRoleRequest) |
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account. |
|
DisassociateDRTRoleAsync(DisassociateDRTRoleRequest, CancellationToken) |
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account. |
|
DisassociateHealthCheck(DisassociateHealthCheckRequest) |
Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response. You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide. |
|
DisassociateHealthCheckAsync(DisassociateHealthCheckRequest, CancellationToken) |
Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response. You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide. |
|
EnableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest) |
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected
resource.
This feature is available for Amazon CloudFront distributions and Application Load
Balancers only.
This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation. Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse. To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide. |
|
EnableApplicationLayerAutomaticResponseAsync(EnableApplicationLayerAutomaticResponseRequest, CancellationToken) |
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected
resource.
This feature is available for Amazon CloudFront distributions and Application Load
Balancers only.
This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation. Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse. To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide. |
|
EnableProactiveEngagement(EnableProactiveEngagementRequest) |
Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support. |
|
EnableProactiveEngagementAsync(EnableProactiveEngagementRequest, CancellationToken) |
Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support. |
|
GetSubscriptionState(GetSubscriptionStateRequest) |
Returns the |
|
GetSubscriptionStateAsync(GetSubscriptionStateRequest, CancellationToken) |
Returns the |
|
ListAttacks(ListAttacksRequest) |
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period. |
|
ListAttacksAsync(ListAttacksRequest, CancellationToken) |
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period. |
|
ListProtectionGroups(ListProtectionGroupsRequest) |
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria. |
|
ListProtectionGroupsAsync(ListProtectionGroupsRequest, CancellationToken) |
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria. |
|
ListProtections(ListProtectionsRequest) |
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria. |
|
ListProtectionsAsync(ListProtectionsRequest, CancellationToken) |
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria. |
|
ListResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest) |
Retrieves the resources that are included in the protection group. |
|
ListResourcesInProtectionGroupAsync(ListResourcesInProtectionGroupRequest, CancellationToken) |
Retrieves the resources that are included in the protection group. |
|
ListTagsForResource(ListTagsForResourceRequest) |
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield. |
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield. |
|
TagResource(TagResourceRequest) |
Adds or updates tags for a resource in Shield. |
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Adds or updates tags for a resource in Shield. |
|
UntagResource(UntagResourceRequest) |
Removes tags from a resource in Shield. |
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Removes tags from a resource in Shield. |
|
UpdateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest) |
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource. |
|
UpdateApplicationLayerAutomaticResponseAsync(UpdateApplicationLayerAutomaticResponseRequest, CancellationToken) |
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource. |
|
UpdateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest) |
Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support. |
|
UpdateEmergencyContactSettingsAsync(UpdateEmergencyContactSettingsRequest, CancellationToken) |
Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support. |
|
UpdateProtectionGroup(UpdateProtectionGroupRequest) |
Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives. |
|
UpdateProtectionGroupAsync(UpdateProtectionGroupRequest, CancellationToken) |
Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives. |
|
UpdateSubscription(UpdateSubscriptionRequest) |
Updates the details of an existing subscription. Only enter values for parameters
you want to change. Empty parameters are not updated.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions
are billed against the organization's payer account, regardless of whether the payer
account itself is subscribed.
|
|
UpdateSubscriptionAsync(UpdateSubscriptionRequest, CancellationToken) |
Updates the details of an existing subscription. Only enter values for parameters
you want to change. Empty parameters are not updated.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions
are billed against the organization's payer account, regardless of whether the payer
account itself is subscribed.
|
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5