AWS SDK Version 3 for .NET
API Reference

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.

Implementation for accessing Shield AWS Shield Advanced

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Shield.AmazonShieldClient

Namespace: Amazon.Shield
Assembly: AWSSDK.Shield.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonShieldClient : AmazonServiceClient
         IAmazonService, IAmazonShield, IDisposable

The AmazonShieldClient type exposes the following members

Constructors

NameDescription
Public Method AmazonShieldClient()

Constructs AmazonShieldClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonShieldClient(RegionEndpoint)

Constructs AmazonShieldClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonShieldClient(AmazonShieldConfig)

Constructs AmazonShieldClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonShieldClient(AWSCredentials)

Constructs AmazonShieldClient with AWS Credentials

Public Method AmazonShieldClient(AWSCredentials, RegionEndpoint)

Constructs AmazonShieldClient with AWS Credentials

Public Method AmazonShieldClient(AWSCredentials, AmazonShieldConfig)

Constructs AmazonShieldClient with AWS Credentials and an AmazonShieldClient Configuration object.

Public Method AmazonShieldClient(string, string)

Constructs AmazonShieldClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonShieldClient(string, string, RegionEndpoint)

Constructs AmazonShieldClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonShieldClient(string, string, AmazonShieldConfig)

Constructs AmazonShieldClient with AWS Access Key ID, AWS Secret Key and an AmazonShieldClient Configuration object.

Public Method AmazonShieldClient(string, string, string)

Constructs AmazonShieldClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonShieldClient(string, string, string, RegionEndpoint)

Constructs AmazonShieldClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonShieldClient(string, string, string, AmazonShieldConfig)

Constructs AmazonShieldClient with AWS Access Key ID, AWS Secret Key and an AmazonShieldClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateProtection(CreateProtectionRequest)

Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, or an Amazon Route 53 hosted zone.

Public Method CreateProtectionAsync(CreateProtectionRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProtection operation.

Public Method CreateSubscription(CreateSubscriptionRequest)

Activates AWS Shield Advanced for an account.

Public Method CreateSubscriptionAsync(CreateSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the CreateSubscription operation.

Public Method DeleteProtection(DeleteProtectionRequest)

Deletes an AWS Shield Advanced Protection.

Public Method DeleteProtectionAsync(DeleteProtectionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProtection operation.

Public Method DeleteSubscription(DeleteSubscriptionRequest)

Removes AWS Shield Advanced from an account.

Public Method DeleteSubscriptionAsync(DeleteSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSubscription operation.

Public Method DescribeAttack(DescribeAttackRequest)

Describes the details of a DDoS attack.

Public Method DescribeAttackAsync(DescribeAttackRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAttack operation.

Public Method DescribeProtection(DescribeProtectionRequest)

Lists the details of a Protection object.

Public Method DescribeProtectionAsync(DescribeProtectionRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProtection operation.

Public Method DescribeSubscription(DescribeSubscriptionRequest)

Provides details about the AWS Shield Advanced subscription for an account.

Public Method DescribeSubscriptionAsync(DescribeSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeSubscription operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ListAttacks(ListAttacksRequest)

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

Public Method ListAttacksAsync(ListAttacksRequest, CancellationToken)

Initiates the asynchronous execution of the ListAttacks operation.

Public Method ListProtections(ListProtectionsRequest)

Lists all Protection objects for the account.

Public Method ListProtectionsAsync(ListProtectionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListProtections operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms