@Generated(value="software.amazon.awssdk:codegen") public interface ShieldClient extends SdkClient
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AssociateDrtLogBucketResponse |
associateDRTLogBucket(AssociateDrtLogBucketRequest associateDrtLogBucketRequest)
Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow logs.
|
default AssociateDrtLogBucketResponse |
associateDRTLogBucket(Consumer<AssociateDrtLogBucketRequest.Builder> associateDrtLogBucketRequest)
Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow logs.
|
default AssociateDrtRoleResponse |
associateDRTRole(AssociateDrtRoleRequest associateDrtRoleRequest)
Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS
attack mitigation during potential attacks.
|
default AssociateDrtRoleResponse |
associateDRTRole(Consumer<AssociateDrtRoleRequest.Builder> associateDrtRoleRequest)
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 ShieldClientBuilder |
builder()
Create a builder that can be used to configure and create a
ShieldClient . |
static ShieldClient |
create()
Create a
ShieldClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateProtectionResponse |
createProtection(Consumer<CreateProtectionRequest.Builder> createProtectionRequest)
Enables AWS Shield Advanced for a specific AWS resource.
|
default CreateProtectionResponse |
createProtection(CreateProtectionRequest createProtectionRequest)
Enables AWS Shield Advanced for a specific AWS resource.
|
default CreateSubscriptionResponse |
createSubscription()
Activates AWS Shield Advanced for an account.
|
default CreateSubscriptionResponse |
createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest)
Activates AWS Shield Advanced for an account.
|
default CreateSubscriptionResponse |
createSubscription(CreateSubscriptionRequest createSubscriptionRequest)
Activates AWS Shield Advanced for an account.
|
default DeleteProtectionResponse |
deleteProtection(Consumer<DeleteProtectionRequest.Builder> deleteProtectionRequest)
Deletes an AWS Shield Advanced Protection.
|
default DeleteProtectionResponse |
deleteProtection(DeleteProtectionRequest deleteProtectionRequest)
Deletes an AWS Shield Advanced Protection.
|
default DescribeAttackResponse |
describeAttack(Consumer<DescribeAttackRequest.Builder> describeAttackRequest)
Describes the details of a DDoS attack.
|
default DescribeAttackResponse |
describeAttack(DescribeAttackRequest describeAttackRequest)
Describes the details of a DDoS attack.
|
default DescribeDrtAccessResponse |
describeDRTAccess(Consumer<DescribeDrtAccessRequest.Builder> describeDrtAccessRequest)
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.
|
default DescribeDrtAccessResponse |
describeDRTAccess(DescribeDrtAccessRequest describeDrtAccessRequest)
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.
|
default DescribeEmergencyContactSettingsResponse |
describeEmergencyContactSettings(Consumer<DescribeEmergencyContactSettingsRequest.Builder> describeEmergencyContactSettingsRequest)
Lists the email addresses that the DRT can use to contact you during a suspected attack.
|
default DescribeEmergencyContactSettingsResponse |
describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest)
Lists the email addresses that the DRT can use to contact you during a suspected attack.
|
default DescribeProtectionResponse |
describeProtection(Consumer<DescribeProtectionRequest.Builder> describeProtectionRequest)
Lists the details of a Protection object.
|
default DescribeProtectionResponse |
describeProtection(DescribeProtectionRequest describeProtectionRequest)
Lists the details of a Protection object.
|
default DescribeSubscriptionResponse |
describeSubscription()
Provides details about the AWS Shield Advanced subscription for an account.
|
default DescribeSubscriptionResponse |
describeSubscription(Consumer<DescribeSubscriptionRequest.Builder> describeSubscriptionRequest)
Provides details about the AWS Shield Advanced subscription for an account.
|
default DescribeSubscriptionResponse |
describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest)
Provides details about the AWS Shield Advanced subscription for an account.
|
default DisassociateDrtLogBucketResponse |
disassociateDRTLogBucket(Consumer<DisassociateDrtLogBucketRequest.Builder> disassociateDrtLogBucketRequest)
Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs.
|
default DisassociateDrtLogBucketResponse |
disassociateDRTLogBucket(DisassociateDrtLogBucketRequest disassociateDrtLogBucketRequest)
Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs.
|
default DisassociateDrtRoleResponse |
disassociateDRTRole()
Removes the DDoS Response team's (DRT) access to your AWS account.
|
default DisassociateDrtRoleResponse |
disassociateDRTRole(Consumer<DisassociateDrtRoleRequest.Builder> disassociateDrtRoleRequest)
Removes the DDoS Response team's (DRT) access to your AWS account.
|
default DisassociateDrtRoleResponse |
disassociateDRTRole(DisassociateDrtRoleRequest disassociateDrtRoleRequest)
Removes the DDoS Response team's (DRT) access to your AWS account.
|
default GetSubscriptionStateResponse |
getSubscriptionState()
Returns the
SubscriptionState , either Active or Inactive . |
default GetSubscriptionStateResponse |
getSubscriptionState(Consumer<GetSubscriptionStateRequest.Builder> getSubscriptionStateRequest)
Returns the
SubscriptionState , either Active or Inactive . |
default GetSubscriptionStateResponse |
getSubscriptionState(GetSubscriptionStateRequest getSubscriptionStateRequest)
Returns the
SubscriptionState , either Active or Inactive . |
default ListAttacksResponse |
listAttacks()
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default ListAttacksResponse |
listAttacks(Consumer<ListAttacksRequest.Builder> listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default ListAttacksResponse |
listAttacks(ListAttacksRequest listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default ListProtectionsResponse |
listProtections()
Lists all Protection objects for the account.
|
default ListProtectionsResponse |
listProtections(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest)
Lists all Protection objects for the account.
|
default ListProtectionsResponse |
listProtections(ListProtectionsRequest listProtectionsRequest)
Lists all Protection objects for the account.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateEmergencyContactSettingsResponse |
updateEmergencyContactSettings(Consumer<UpdateEmergencyContactSettingsRequest.Builder> updateEmergencyContactSettingsRequest)
Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.
|
default UpdateEmergencyContactSettingsResponse |
updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest)
Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.
|
default UpdateSubscriptionResponse |
updateSubscription(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest)
Updates the details of an existing subscription.
|
default UpdateSubscriptionResponse |
updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest)
Updates the details of an existing subscription.
|
serviceName
close
static final String SERVICE_NAME
static ShieldClient create()
ShieldClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ShieldClientBuilder builder()
ShieldClient
.default AssociateDrtLogBucketResponse associateDRTLogBucket(AssociateDrtLogBucketRequest associateDrtLogBucketRequest) throws InternalErrorException, InvalidOperationException, NoAssociatedRoleException, LimitsExceededException, InvalidParameterException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
associateDrtLogBucketRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateDrtLogBucketResponse associateDRTLogBucket(Consumer<AssociateDrtLogBucketRequest.Builder> associateDrtLogBucketRequest) throws InternalErrorException, InvalidOperationException, NoAssociatedRoleException, LimitsExceededException, InvalidParameterException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
This is a convenience which creates an instance of the AssociateDrtLogBucketRequest.Builder
avoiding the
need to create one manually via AssociateDrtLogBucketRequest.builder()
associateDrtLogBucketRequest
- A Consumer
that will call methods on AssociateDRTLogBucketRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateDrtRoleResponse associateDRTRole(AssociateDrtRoleRequest associateDrtRoleRequest) throws InternalErrorException, InvalidOperationException, InvalidParameterException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
associateDrtRoleRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateDrtRoleResponse associateDRTRole(Consumer<AssociateDrtRoleRequest.Builder> associateDrtRoleRequest) throws InternalErrorException, InvalidOperationException, InvalidParameterException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
This is a convenience which creates an instance of the AssociateDrtRoleRequest.Builder
avoiding the need
to create one manually via AssociateDrtRoleRequest.builder()
associateDrtRoleRequest
- A Consumer
that will call methods on AssociateDRTRoleRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateProtectionResponse createProtection(CreateProtectionRequest createProtectionRequest) throws InternalErrorException, InvalidResourceException, InvalidOperationException, LimitsExceededException, ResourceAlreadyExistsException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
createProtectionRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateProtectionResponse createProtection(Consumer<CreateProtectionRequest.Builder> createProtectionRequest) throws InternalErrorException, InvalidResourceException, InvalidOperationException, LimitsExceededException, ResourceAlreadyExistsException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
This is a convenience which creates an instance of the CreateProtectionRequest.Builder
avoiding the need
to create one manually via CreateProtectionRequest.builder()
createProtectionRequest
- A Consumer
that will call methods on CreateProtectionRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateSubscriptionResponse createSubscription() throws InternalErrorException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, ShieldException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
createSubscription(CreateSubscriptionRequest)
,
AWS API
Documentationdefault CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest createSubscriptionRequest) throws InternalErrorException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, ShieldException
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.
createSubscriptionRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateSubscriptionResponse createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) throws InternalErrorException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, ShieldException
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.
This is a convenience which creates an instance of the CreateSubscriptionRequest.Builder
avoiding the
need to create one manually via CreateSubscriptionRequest.builder()
createSubscriptionRequest
- A Consumer
that will call methods on CreateSubscriptionRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteProtectionResponse deleteProtection(DeleteProtectionRequest deleteProtectionRequest) throws InternalErrorException, ResourceNotFoundException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException
Deletes an AWS Shield Advanced Protection.
deleteProtectionRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteProtectionResponse deleteProtection(Consumer<DeleteProtectionRequest.Builder> deleteProtectionRequest) throws InternalErrorException, ResourceNotFoundException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException
Deletes an AWS Shield Advanced Protection.
This is a convenience which creates an instance of the DeleteProtectionRequest.Builder
avoiding the need
to create one manually via DeleteProtectionRequest.builder()
deleteProtectionRequest
- A Consumer
that will call methods on DeleteProtectionRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAttackResponse describeAttack(DescribeAttackRequest describeAttackRequest) throws InternalErrorException, AccessDeniedException, AwsServiceException, SdkClientException, ShieldException
Describes the details of a DDoS attack.
describeAttackRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.AccessDeniedException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAttackResponse describeAttack(Consumer<DescribeAttackRequest.Builder> describeAttackRequest) throws InternalErrorException, AccessDeniedException, AwsServiceException, SdkClientException, ShieldException
Describes the details of a DDoS attack.
This is a convenience which creates an instance of the DescribeAttackRequest.Builder
avoiding the need to
create one manually via DescribeAttackRequest.builder()
describeAttackRequest
- A Consumer
that will call methods on DescribeAttackRequest.Builder
to create a request.InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.AccessDeniedException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDrtAccessResponse describeDRTAccess(DescribeDrtAccessRequest describeDrtAccessRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
describeDrtAccessRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDrtAccessResponse describeDRTAccess(Consumer<DescribeDrtAccessRequest.Builder> describeDrtAccessRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
This is a convenience which creates an instance of the DescribeDrtAccessRequest.Builder
avoiding the need
to create one manually via DescribeDrtAccessRequest.builder()
describeDrtAccessRequest
- A Consumer
that will call methods on DescribeDRTAccessRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEmergencyContactSettingsResponse describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
Lists the email addresses that the DRT can use to contact you during a suspected attack.
describeEmergencyContactSettingsRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEmergencyContactSettingsResponse describeEmergencyContactSettings(Consumer<DescribeEmergencyContactSettingsRequest.Builder> describeEmergencyContactSettingsRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
Lists the email addresses that the DRT can use to contact you during a suspected attack.
This is a convenience which creates an instance of the DescribeEmergencyContactSettingsRequest.Builder
avoiding the need to create one manually via DescribeEmergencyContactSettingsRequest.builder()
describeEmergencyContactSettingsRequest
- A Consumer
that will call methods on DescribeEmergencyContactSettingsRequest.Builder
to
create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeProtectionResponse describeProtection(DescribeProtectionRequest describeProtectionRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
Lists the details of a Protection object.
describeProtectionRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeProtectionResponse describeProtection(Consumer<DescribeProtectionRequest.Builder> describeProtectionRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
Lists the details of a Protection object.
This is a convenience which creates an instance of the DescribeProtectionRequest.Builder
avoiding the
need to create one manually via DescribeProtectionRequest.builder()
describeProtectionRequest
- A Consumer
that will call methods on DescribeProtectionRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSubscriptionResponse describeSubscription() throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
Provides details about the AWS Shield Advanced subscription for an account.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeSubscription(DescribeSubscriptionRequest)
,
AWS
API Documentationdefault DescribeSubscriptionResponse describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
Provides details about the AWS Shield Advanced subscription for an account.
describeSubscriptionRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSubscriptionResponse describeSubscription(Consumer<DescribeSubscriptionRequest.Builder> describeSubscriptionRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
Provides details about the AWS Shield Advanced subscription for an account.
This is a convenience which creates an instance of the DescribeSubscriptionRequest.Builder
avoiding the
need to create one manually via DescribeSubscriptionRequest.builder()
describeSubscriptionRequest
- A Consumer
that will call methods on DescribeSubscriptionRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateDrtLogBucketResponse disassociateDRTLogBucket(DisassociateDrtLogBucketRequest disassociateDrtLogBucketRequest) throws InternalErrorException, InvalidOperationException, NoAssociatedRoleException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
disassociateDrtLogBucketRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateDrtLogBucketResponse disassociateDRTLogBucket(Consumer<DisassociateDrtLogBucketRequest.Builder> disassociateDrtLogBucketRequest) throws InternalErrorException, InvalidOperationException, NoAssociatedRoleException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
This is a convenience which creates an instance of the DisassociateDrtLogBucketRequest.Builder
avoiding
the need to create one manually via DisassociateDrtLogBucketRequest.builder()
disassociateDrtLogBucketRequest
- A Consumer
that will call methods on DisassociateDRTLogBucketRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateDrtRoleResponse disassociateDRTRole() throws InternalErrorException, InvalidOperationException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
disassociateDRTRole(DisassociateDrtRoleRequest)
,
AWS API
Documentationdefault DisassociateDrtRoleResponse disassociateDRTRole(DisassociateDrtRoleRequest disassociateDrtRoleRequest) throws InternalErrorException, InvalidOperationException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
disassociateDrtRoleRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateDrtRoleResponse disassociateDRTRole(Consumer<DisassociateDrtRoleRequest.Builder> disassociateDrtRoleRequest) throws InternalErrorException, InvalidOperationException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
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.
This is a convenience which creates an instance of the DisassociateDrtRoleRequest.Builder
avoiding the
need to create one manually via DisassociateDrtRoleRequest.builder()
disassociateDrtRoleRequest
- A Consumer
that will call methods on DisassociateDRTRoleRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSubscriptionStateResponse getSubscriptionState() throws InternalErrorException, AwsServiceException, SdkClientException, ShieldException
Returns the SubscriptionState
, either Active
or Inactive
.
InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getSubscriptionState(GetSubscriptionStateRequest)
,
AWS
API Documentationdefault GetSubscriptionStateResponse getSubscriptionState(GetSubscriptionStateRequest getSubscriptionStateRequest) throws InternalErrorException, AwsServiceException, SdkClientException, ShieldException
Returns the SubscriptionState
, either Active
or Inactive
.
getSubscriptionStateRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSubscriptionStateResponse getSubscriptionState(Consumer<GetSubscriptionStateRequest.Builder> getSubscriptionStateRequest) throws InternalErrorException, AwsServiceException, SdkClientException, ShieldException
Returns the SubscriptionState
, either Active
or Inactive
.
This is a convenience which creates an instance of the GetSubscriptionStateRequest.Builder
avoiding the
need to create one manually via GetSubscriptionStateRequest.builder()
getSubscriptionStateRequest
- A Consumer
that will call methods on GetSubscriptionStateRequest.Builder
to create a
request.InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttacksResponse listAttacks() throws InternalErrorException, InvalidParameterException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listAttacks(ListAttacksRequest)
,
AWS API
Documentationdefault ListAttacksResponse listAttacks(ListAttacksRequest listAttacksRequest) throws InternalErrorException, InvalidParameterException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
listAttacksRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttacksResponse listAttacks(Consumer<ListAttacksRequest.Builder> listAttacksRequest) throws InternalErrorException, InvalidParameterException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
This is a convenience which creates an instance of the ListAttacksRequest.Builder
avoiding the need to
create one manually via ListAttacksRequest.builder()
listAttacksRequest
- A Consumer
that will call methods on ListAttacksRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListProtectionsResponse listProtections() throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException
Lists all Protection objects for the account.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listProtections(ListProtectionsRequest)
,
AWS API
Documentationdefault ListProtectionsResponse listProtections(ListProtectionsRequest listProtectionsRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException
Lists all Protection objects for the account.
listProtectionsRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListProtectionsResponse listProtections(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException
Lists all Protection objects for the account.
This is a convenience which creates an instance of the ListProtectionsRequest.Builder
avoiding the need
to create one manually via ListProtectionsRequest.builder()
listProtectionsRequest
- A Consumer
that will call methods on ListProtectionsRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateEmergencyContactSettingsResponse updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest) throws InternalErrorException, InvalidParameterException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.
updateEmergencyContactSettingsRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateEmergencyContactSettingsResponse updateEmergencyContactSettings(Consumer<UpdateEmergencyContactSettingsRequest.Builder> updateEmergencyContactSettingsRequest) throws InternalErrorException, InvalidParameterException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException
Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.
This is a convenience which creates an instance of the UpdateEmergencyContactSettingsRequest.Builder
avoiding the need to create one manually via UpdateEmergencyContactSettingsRequest.builder()
updateEmergencyContactSettingsRequest
- A Consumer
that will call methods on UpdateEmergencyContactSettingsRequest.Builder
to
create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateSubscriptionResponse updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest) throws InternalErrorException, LockedSubscriptionException, ResourceNotFoundException, InvalidParameterException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException
Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
updateSubscriptionRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateSubscriptionResponse updateSubscription(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest) throws InternalErrorException, LockedSubscriptionException, ResourceNotFoundException, InvalidParameterException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException
Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
This is a convenience which creates an instance of the UpdateSubscriptionRequest.Builder
avoiding the
need to create one manually via UpdateSubscriptionRequest.builder()
updateSubscriptionRequest
- A Consumer
that will call methods on UpdateSubscriptionRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.