AWSShieldClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.shield.AWSShieldClient

All Implemented Interfaces:

AWSShield

Direct Known Subclasses:

AWSShieldAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSShieldClient
extends AmazonWebServiceClient
implements AWSShield
```
Client for accessing AWS Shield. All service calls made using this client are blocking, and will not return until the service call completes.
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.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.shield.AWSShield
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AWSShieldClient()` Deprecated. use `AWSShieldClientBuilder.defaultClient()`
`AWSShieldClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AWSShieldClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AWSShieldClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AWSShieldClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AssociateDRTLogBucketResult`	`associateDRTLogBucket(AssociateDRTLogBucketRequest request)` Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow logs.
`AssociateDRTRoleResult`	`associateDRTRole(AssociateDRTRoleRequest request)` Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks.
`static AWSShieldClientBuilder`	`builder()`
`CreateProtectionResult`	`createProtection(CreateProtectionRequest request)` Enables AWS Shield Advanced for a specific AWS resource.
`CreateSubscriptionResult`	`createSubscription(CreateSubscriptionRequest request)` Activates AWS Shield Advanced for an account.
`DeleteProtectionResult`	`deleteProtection(DeleteProtectionRequest request)` Deletes an AWS Shield Advanced Protection.
`DeleteSubscriptionResult`	`deleteSubscription(DeleteSubscriptionRequest request)` Deprecated.
`DescribeAttackResult`	`describeAttack(DescribeAttackRequest request)` Describes the details of a DDoS attack.
`DescribeDRTAccessResult`	`describeDRTAccess(DescribeDRTAccessRequest request)` Returns the current role and list of Amazon S3 log buckets used by the DDoS Response team (DRT) to access your AWS account while assisting with attack mitigation.
`DescribeEmergencyContactSettingsResult`	`describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest request)` Lists the email addresses that the DRT can use to contact you during a suspected attack.
`DescribeProtectionResult`	`describeProtection(DescribeProtectionRequest request)` Lists the details of a Protection object.
`DescribeSubscriptionResult`	`describeSubscription(DescribeSubscriptionRequest request)` Provides details about the AWS Shield Advanced subscription for an account.
`DisassociateDRTLogBucketResult`	`disassociateDRTLogBucket(DisassociateDRTLogBucketRequest request)` Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs.
`DisassociateDRTRoleResult`	`disassociateDRTRole(DisassociateDRTRoleRequest request)` Removes the DDoS Response team's (DRT) access to your AWS account.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetSubscriptionStateResult`	`getSubscriptionState(GetSubscriptionStateRequest request)` Returns the `SubscriptionState`, either `Active` or `Inactive`.
`ListAttacksResult`	`listAttacks(ListAttacksRequest request)` Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
`ListProtectionsResult`	`listProtections(ListProtectionsRequest request)` Lists all Protection objects for the account.
`UpdateEmergencyContactSettingsResult`	`updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest request)` Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.
`UpdateSubscriptionResult`	`updateSubscription(UpdateSubscriptionRequest request)` Updates the details of an existing subscription.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.shield.AWSShield
setEndpoint, setRegion, shutdown

- Constructor Detail
  - AWSShieldClient
```
@Deprecated
public AWSShieldClient()
```
    Deprecated. use AWSShieldClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on AWS Shield. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSShieldClient
```
@Deprecated
public AWSShieldClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on AWS Shield. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS Shield (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSShieldClient
```
@Deprecated
public AWSShieldClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSShieldClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on AWS Shield using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSShieldClient
```
@Deprecated
public AWSShieldClient(AWSCredentials awsCredentials,
                                   ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on AWS Shield using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS Shield (ex: proxy settings, retry counts, etc.).
  - AWSShieldClient
```
@Deprecated
public AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on AWS Shield using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSShieldClient
```
@Deprecated
public AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on AWS Shield using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS Shield (ex: proxy settings, retry counts, etc.).
  - AWSShieldClient
```
@Deprecated
public AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration,
                                   RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on AWS Shield using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS Shield (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AWSShieldClientBuilder builder()
```
  - associateDRTLogBucket
```
public AssociateDRTLogBucketResult associateDRTLogBucket(AssociateDRTLogBucketRequest request)
```
    Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow logs. You can associate up to 10 Amazon S3 buckets with your subscription.
    
    To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
    
    Specified by:
    
    associateDRTLogBucket in interface AWSShield
    
    Parameters:
    
    associateDRTLogBucketRequest -
    
    Returns:
    
    Result of the AssociateDRTLogBucket operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.
    
    NoAssociatedRoleException - The ARN of the role that you specifed does not exist.
    
    LimitsExceededException - 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.
    
    InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid.
    
    AccessDeniedForDependencyException - In order to grant the necessary access to the DDoS Response Team, the user submitting AssociateDRTRole must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.
    
    OptimisticLockException - Exception that indicates that the protection state has been modified by another client. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - associateDRTRole
```
public AssociateDRTRoleResult associateDRTRole(AssociateDRTRoleRequest request)
```
    Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.
    
    You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.
    
    Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com . For more information, see IAM JSON Policy Elements: Principal.
    
    The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you.
    
    You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.
    
    To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
    
    Specified by:
    
    associateDRTRole in interface AWSShield
    
    Parameters:
    
    associateDRTRoleRequest -
    
    Returns:
    
    Result of the AssociateDRTRole operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.
    
    InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid.
    
    AccessDeniedForDependencyException - In order to grant the necessary access to the DDoS Response Team, the user submitting AssociateDRTRole must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.
    
    OptimisticLockException - Exception that indicates that the protection state has been modified by another client. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - createProtection
```
public CreateProtectionResult createProtection(CreateProtectionRequest request)
```
    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.
    
    You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.
    
    Specified by:
    
    createProtection in interface AWSShield
    
    Parameters:
    
    createProtectionRequest -
    
    Returns:
    
    Result of the CreateProtection operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    InvalidResourceException - Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.
    
    InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.
    
    LimitsExceededException - 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.
    
    ResourceAlreadyExistsException - Exception indicating the specified resource already exists.
    
    OptimisticLockException - Exception that indicates that the protection state has been modified by another client. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - createSubscription
```
public CreateSubscriptionResult createSubscription(CreateSubscriptionRequest request)
```
    Activates AWS Shield Advanced for an account.
    
    As part of this request you can specify EmergencySettings that automaticaly grant the DDoS response team (DRT) needed permissions to assist you during a suspected DDoS attack. For more information see Authorize the DDoS Response Team to Create Rules and Web ACLs on Your Behalf.
    
    When you initally 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 UpdateSubscription request.
    
    Specified by:
    
    createSubscription in interface AWSShield
    
    Parameters:
    
    createSubscriptionRequest -
    
    Returns:
    
    Result of the CreateSubscription operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    ResourceAlreadyExistsException - Exception indicating the specified resource already exists.
    
    See Also:
    
    AWS API Documentation
  - deleteProtection
```
public DeleteProtectionResult deleteProtection(DeleteProtectionRequest request)
```
    Deletes an AWS Shield Advanced Protection.
    
    Specified by:
    
    deleteProtection in interface AWSShield
    
    Parameters:
    
    deleteProtectionRequest -
    
    Returns:
    
    Result of the DeleteProtection operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    OptimisticLockException - Exception that indicates that the protection state has been modified by another client. You can retry the request.
    
    See Also:
    
    AWS API Documentation
  - deleteSubscription
```
@Deprecated
public DeleteSubscriptionResult deleteSubscription(DeleteSubscriptionRequest request)
```
    Deprecated.
    
    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.
    
    Specified by:
    
    deleteSubscription in interface AWSShield
    
    Parameters:
    
    deleteSubscriptionRequest -
    
    Returns:
    
    Result of the DeleteSubscription operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    LockedSubscriptionException - You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - describeAttack
```
public DescribeAttackResult describeAttack(DescribeAttackRequest request)
```
    Describes the details of a DDoS attack.
    
    Specified by:
    
    describeAttack in interface AWSShield
    
    Parameters:
    
    describeAttackRequest -
    
    Returns:
    
    Result of the DescribeAttack operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid.
    
    See Also:
    
    AWS API Documentation
  - describeDRTAccess
```
public DescribeDRTAccessResult describeDRTAccess(DescribeDRTAccessRequest request)
```
    Returns the current role and list of Amazon S3 log buckets used by the DDoS Response team (DRT) to access your AWS account while assisting with attack mitigation.
    
    Specified by:
    
    describeDRTAccess in interface AWSShield
    
    Parameters:
    
    describeDRTAccessRequest -
    
    Returns:
    
    Result of the DescribeDRTAccess operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - describeEmergencyContactSettings
```
public DescribeEmergencyContactSettingsResult describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest request)
```
    Lists the email addresses that the DRT can use to contact you during a suspected attack.
    
    Specified by:
    
    describeEmergencyContactSettings in interface AWSShield
    
    Parameters:
    
    describeEmergencyContactSettingsRequest -
    
    Returns:
    
    Result of the DescribeEmergencyContactSettings operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - describeProtection
```
public DescribeProtectionResult describeProtection(DescribeProtectionRequest request)
```
    Lists the details of a Protection object.
    
    Specified by:
    
    describeProtection in interface AWSShield
    
    Parameters:
    
    describeProtectionRequest -
    
    Returns:
    
    Result of the DescribeProtection operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - describeSubscription
```
public DescribeSubscriptionResult describeSubscription(DescribeSubscriptionRequest request)
```
    Provides details about the AWS Shield Advanced subscription for an account.
    
    Specified by:
    
    describeSubscription in interface AWSShield
    
    Parameters:
    
    describeSubscriptionRequest -
    
    Returns:
    
    Result of the DescribeSubscription operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - disassociateDRTLogBucket
```
public DisassociateDRTLogBucketResult disassociateDRTLogBucket(DisassociateDRTLogBucketRequest request)
```
    Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs.
    
    To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.
    
    Specified by:
    
    disassociateDRTLogBucket in interface AWSShield
    
    Parameters:
    
    disassociateDRTLogBucketRequest -
    
    Returns:
    
    Result of the DisassociateDRTLogBucket operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.
    
    NoAssociatedRoleException - The ARN of the role that you specifed does not exist.
    
    AccessDeniedForDependencyException - In order to grant the necessary access to the DDoS Response Team, the user submitting AssociateDRTRole must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.
    
    OptimisticLockException - Exception that indicates that the protection state has been modified by another client. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - disassociateDRTRole
```
public DisassociateDRTRoleResult disassociateDRTRole(DisassociateDRTRoleRequest request)
```
    Removes the DDoS Response team's (DRT) access to your AWS account.
    
    To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.
    
    Specified by:
    
    disassociateDRTRole in interface AWSShield
    
    Parameters:
    
    disassociateDRTRoleRequest -
    
    Returns:
    
    Result of the DisassociateDRTRole operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.
    
    OptimisticLockException - Exception that indicates that the protection state has been modified by another client. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - getSubscriptionState
```
public GetSubscriptionStateResult getSubscriptionState(GetSubscriptionStateRequest request)
```
    Returns the SubscriptionState, either Active or Inactive.
    
    Specified by:
    
    getSubscriptionState in interface AWSShield
    
    Parameters:
    
    getSubscriptionStateRequest -
    
    Returns:
    
    Result of the GetSubscriptionState operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    See Also:
    
    AWS API Documentation
  - listAttacks
```
public ListAttacksResult listAttacks(ListAttacksRequest request)
```
    Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
    
    Specified by:
    
    listAttacks in interface AWSShield
    
    Parameters:
    
    listAttacksRequest -
    
    Returns:
    
    Result of the ListAttacks operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid.
    
    InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.
    
    See Also:
    
    AWS API Documentation
  - listProtections
```
public ListProtectionsResult listProtections(ListProtectionsRequest request)
```
    Lists all Protection objects for the account.
    
    Specified by:
    
    listProtections in interface AWSShield
    
    Parameters:
    
    listProtectionsRequest -
    
    Returns:
    
    Result of the ListProtections operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    InvalidPaginationTokenException - Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the response.
    
    See Also:
    
    AWS API Documentation
  - updateEmergencyContactSettings
```
public UpdateEmergencyContactSettingsResult updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest request)
```
    Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.
    
    Specified by:
    
    updateEmergencyContactSettings in interface AWSShield
    
    Parameters:
    
    updateEmergencyContactSettingsRequest -
    
    Returns:
    
    Result of the UpdateEmergencyContactSettings operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid.
    
    OptimisticLockException - Exception that indicates that the protection state has been modified by another client. You can retry the request.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - updateSubscription
```
public UpdateSubscriptionResult updateSubscription(UpdateSubscriptionRequest request)
```
    Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
    
    Specified by:
    
    updateSubscription in interface AWSShield
    
    Parameters:
    
    updateSubscriptionRequest -
    
    Returns:
    
    Result of the UpdateSubscription operation returned by the service.
    
    Throws:
    
    InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
    
    LockedSubscriptionException - You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.
    
    ResourceNotFoundException - Exception indicating the specified resource does not exist.
    
    InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid.
    
    OptimisticLockException - Exception that indicates that the protection state has been modified by another client. You can retry the request.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSShield
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AWSShieldClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.shield.AWSShield

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.shield.AWSShield

Constructor Detail

AWSShieldClient

AWSShieldClient

AWSShieldClient

AWSShieldClient

AWSShieldClient

AWSShieldClient

AWSShieldClient

Method Detail

builder

associateDRTLogBucket

associateDRTRole

createProtection

createSubscription

deleteProtection

deleteSubscription

describeAttack

describeDRTAccess

describeEmergencyContactSettings

describeProtection

describeSubscription

disassociateDRTLogBucket

disassociateDRTRole

getSubscriptionState

listAttacks

listProtections

updateEmergencyContactSettings

updateSubscription

getCachedResponseMetadata