Interface ShieldAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and Shield Developer Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateDRTLogBucket
(Consumer<AssociateDrtLogBucketRequest.Builder> associateDrtLogBucketRequest) Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources.associateDRTLogBucket
(AssociateDrtLogBucketRequest associateDrtLogBucketRequest) Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources.associateDRTRole
(Consumer<AssociateDrtRoleRequest.Builder> associateDrtRoleRequest) Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks.associateDRTRole
(AssociateDrtRoleRequest associateDrtRoleRequest) Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks.associateHealthCheck
(Consumer<AssociateHealthCheckRequest.Builder> associateHealthCheckRequest) Adds health-based detection to the Shield Advanced protection for a resource.associateHealthCheck
(AssociateHealthCheckRequest associateHealthCheckRequest) Adds health-based detection to the Shield Advanced protection for a resource.associateProactiveEngagementDetails
(Consumer<AssociateProactiveEngagementDetailsRequest.Builder> associateProactiveEngagementDetailsRequest) Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use.associateProactiveEngagementDetails
(AssociateProactiveEngagementDetailsRequest associateProactiveEngagementDetailsRequest) Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use.static ShieldAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aShieldAsyncClient
.static ShieldAsyncClient
create()
Create aShieldAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createProtection
(Consumer<CreateProtectionRequest.Builder> createProtectionRequest) Enables Shield Advanced for a specific Amazon Web Services resource.createProtection
(CreateProtectionRequest createProtectionRequest) Enables Shield Advanced for a specific Amazon Web Services resource.createProtectionGroup
(Consumer<CreateProtectionGroupRequest.Builder> createProtectionGroupRequest) Creates a grouping of protected resources so they can be handled as a collective.createProtectionGroup
(CreateProtectionGroupRequest createProtectionGroupRequest) Creates a grouping of protected resources so they can be handled as a collective.Activates Shield Advanced for an account.createSubscription
(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) Activates Shield Advanced for an account.createSubscription
(CreateSubscriptionRequest createSubscriptionRequest) Activates Shield Advanced for an account.deleteProtection
(Consumer<DeleteProtectionRequest.Builder> deleteProtectionRequest) Deletes an Shield Advanced Protection.deleteProtection
(DeleteProtectionRequest deleteProtectionRequest) Deletes an Shield Advanced Protection.deleteProtectionGroup
(Consumer<DeleteProtectionGroupRequest.Builder> deleteProtectionGroupRequest) Removes the specified protection group.deleteProtectionGroup
(DeleteProtectionGroupRequest deleteProtectionGroupRequest) Removes the specified protection group.default CompletableFuture
<DescribeAttackResponse> describeAttack
(Consumer<DescribeAttackRequest.Builder> describeAttackRequest) Describes the details of a DDoS attack.default CompletableFuture
<DescribeAttackResponse> describeAttack
(DescribeAttackRequest describeAttackRequest) Describes the details of a DDoS attack.describeAttackStatistics
(Consumer<DescribeAttackStatisticsRequest.Builder> describeAttackStatisticsRequest) Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them.describeAttackStatistics
(DescribeAttackStatisticsRequest describeAttackStatisticsRequest) Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them.describeDRTAccess
(Consumer<DescribeDrtAccessRequest.Builder> describeDrtAccessRequest) Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.describeDRTAccess
(DescribeDrtAccessRequest describeDrtAccessRequest) Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.describeEmergencyContactSettings
(Consumer<DescribeEmergencyContactSettingsRequest.Builder> describeEmergencyContactSettingsRequest) A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.describeEmergencyContactSettings
(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest) A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.describeProtection
(Consumer<DescribeProtectionRequest.Builder> describeProtectionRequest) Lists the details of a Protection object.describeProtection
(DescribeProtectionRequest describeProtectionRequest) Lists the details of a Protection object.describeProtectionGroup
(Consumer<DescribeProtectionGroupRequest.Builder> describeProtectionGroupRequest) Returns the specification for the specified protection group.describeProtectionGroup
(DescribeProtectionGroupRequest describeProtectionGroupRequest) Returns the specification for the specified protection group.Provides details about the Shield Advanced subscription for an account.describeSubscription
(Consumer<DescribeSubscriptionRequest.Builder> describeSubscriptionRequest) Provides details about the Shield Advanced subscription for an account.describeSubscription
(DescribeSubscriptionRequest describeSubscriptionRequest) Provides details about the Shield Advanced subscription for an account.disableApplicationLayerAutomaticResponse
(Consumer<DisableApplicationLayerAutomaticResponseRequest.Builder> disableApplicationLayerAutomaticResponseRequest) Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource.disableApplicationLayerAutomaticResponse
(DisableApplicationLayerAutomaticResponseRequest disableApplicationLayerAutomaticResponseRequest) Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource.disableProactiveEngagement
(Consumer<DisableProactiveEngagementRequest.Builder> disableProactiveEngagementRequest) Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.disableProactiveEngagement
(DisableProactiveEngagementRequest disableProactiveEngagementRequest) Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.disassociateDRTLogBucket
(Consumer<DisassociateDrtLogBucketRequest.Builder> disassociateDrtLogBucketRequest) Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.disassociateDRTLogBucket
(DisassociateDrtLogBucketRequest disassociateDrtLogBucketRequest) Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.disassociateDRTRole
(Consumer<DisassociateDrtRoleRequest.Builder> disassociateDrtRoleRequest) Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.disassociateDRTRole
(DisassociateDrtRoleRequest disassociateDrtRoleRequest) Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.disassociateHealthCheck
(Consumer<DisassociateHealthCheckRequest.Builder> disassociateHealthCheckRequest) Removes health-based detection from the Shield Advanced protection for a resource.disassociateHealthCheck
(DisassociateHealthCheckRequest disassociateHealthCheckRequest) Removes health-based detection from the Shield Advanced protection for a resource.enableApplicationLayerAutomaticResponse
(Consumer<EnableApplicationLayerAutomaticResponseRequest.Builder> enableApplicationLayerAutomaticResponseRequest) Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.enableApplicationLayerAutomaticResponse
(EnableApplicationLayerAutomaticResponseRequest enableApplicationLayerAutomaticResponseRequest) Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.enableProactiveEngagement
(Consumer<EnableProactiveEngagementRequest.Builder> enableProactiveEngagementRequest) Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.enableProactiveEngagement
(EnableProactiveEngagementRequest enableProactiveEngagementRequest) Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.Returns theSubscriptionState
, eitherActive
orInactive
.getSubscriptionState
(Consumer<GetSubscriptionStateRequest.Builder> getSubscriptionStateRequest) Returns theSubscriptionState
, eitherActive
orInactive
.getSubscriptionState
(GetSubscriptionStateRequest getSubscriptionStateRequest) Returns theSubscriptionState
, eitherActive
orInactive
.default CompletableFuture
<ListAttacksResponse> Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.default CompletableFuture
<ListAttacksResponse> listAttacks
(Consumer<ListAttacksRequest.Builder> listAttacksRequest) Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.default CompletableFuture
<ListAttacksResponse> listAttacks
(ListAttacksRequest listAttacksRequest) Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.default ListAttacksPublisher
This is a variant oflistAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.default ListAttacksPublisher
listAttacksPaginator
(Consumer<ListAttacksRequest.Builder> listAttacksRequest) This is a variant oflistAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.default ListAttacksPublisher
listAttacksPaginator
(ListAttacksRequest listAttacksRequest) This is a variant oflistAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.listProtectionGroups
(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest) Retrieves ProtectionGroup objects for the account.listProtectionGroups
(ListProtectionGroupsRequest listProtectionGroupsRequest) Retrieves ProtectionGroup objects for the account.default ListProtectionGroupsPublisher
listProtectionGroupsPaginator
(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest) This is a variant oflistProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation.default ListProtectionGroupsPublisher
listProtectionGroupsPaginator
(ListProtectionGroupsRequest listProtectionGroupsRequest) This is a variant oflistProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation.default CompletableFuture
<ListProtectionsResponse> Retrieves Protection objects for the account.default CompletableFuture
<ListProtectionsResponse> listProtections
(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest) Retrieves Protection objects for the account.default CompletableFuture
<ListProtectionsResponse> listProtections
(ListProtectionsRequest listProtectionsRequest) Retrieves Protection objects for the account.default ListProtectionsPublisher
This is a variant oflistProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.default ListProtectionsPublisher
listProtectionsPaginator
(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest) This is a variant oflistProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.default ListProtectionsPublisher
listProtectionsPaginator
(ListProtectionsRequest listProtectionsRequest) This is a variant oflistProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.listResourcesInProtectionGroup
(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest) Retrieves the resources that are included in the protection group.listResourcesInProtectionGroup
(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest) Retrieves the resources that are included in the protection group.listResourcesInProtectionGroupPaginator
(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest) This is a variant oflistResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation.listResourcesInProtectionGroupPaginator
(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest) This is a variant oflistResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.default ShieldServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for a resource in Shield.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds or updates tags for a resource in Shield.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a resource in Shield.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from a resource in Shield.updateApplicationLayerAutomaticResponse
(Consumer<UpdateApplicationLayerAutomaticResponseRequest.Builder> updateApplicationLayerAutomaticResponseRequest) Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.updateApplicationLayerAutomaticResponse
(UpdateApplicationLayerAutomaticResponseRequest updateApplicationLayerAutomaticResponseRequest) Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.updateEmergencyContactSettings
(Consumer<UpdateEmergencyContactSettingsRequest.Builder> updateEmergencyContactSettingsRequest) Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.updateEmergencyContactSettings
(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest) Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.updateProtectionGroup
(Consumer<UpdateProtectionGroupRequest.Builder> updateProtectionGroupRequest) Updates an existing protection group.updateProtectionGroup
(UpdateProtectionGroupRequest updateProtectionGroupRequest) Updates an existing protection group.updateSubscription
(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest) Updates the details of an existing subscription.updateSubscription
(UpdateSubscriptionRequest updateSubscriptionRequest) Updates the details of an existing subscription.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateDRTLogBucket
default CompletableFuture<AssociateDrtLogBucketResponse> associateDRTLogBucket(AssociateDrtLogBucketRequest associateDrtLogBucketRequest) Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an
AssociateDRTLogBucket
request, you must be subscribed to the Business Support plan or the Enterprise Support plan.- Parameters:
associateDrtLogBucketRequest
-- Returns:
- A Java Future containing the result of the AssociateDRTLogBucket operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 specified does not exist.
- LimitsExceededException Exception that indicates that the operation would exceed a limit.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- AccessDeniedForDependencyException In order to grant the necessary access to the Shield Response Team
(SRT) the user submitting the request 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 Amazon Web Services Service. - OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
associateDRTLogBucket
default CompletableFuture<AssociateDrtLogBucketResponse> associateDRTLogBucket(Consumer<AssociateDrtLogBucketRequest.Builder> associateDrtLogBucketRequest) Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an
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 viaAssociateDrtLogBucketRequest.builder()
- Parameters:
associateDrtLogBucketRequest
- AConsumer
that will call methods onAssociateDrtLogBucketRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateDRTLogBucket operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 specified does not exist.
- LimitsExceededException Exception that indicates that the operation would exceed a limit.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- AccessDeniedForDependencyException In order to grant the necessary access to the Shield Response Team
(SRT) the user submitting the request 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 Amazon Web Services Service. - OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
associateDRTRole
default CompletableFuture<AssociateDrtRoleResponse> associateDRTRole(AssociateDrtRoleRequest associateDrtRoleRequest) Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
You can associate only one
RoleArn
with your subscription. If you submit anAssociateDRTRole
request for an account that already has an associated role, the newRoleArn
will replace the existingRoleArn
.Prior to making the
AssociateDRTRole
request, you must attach theAWSShieldDRTAccessPolicy
managed policy to the role that you'll specify in the request. You can access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and removing IAM identity permissions. The role must also trust the service principaldrt.shield.amazonaws.com
. For more information, see IAM JSON policy elements: Principal.The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
You must have the
iam:PassRole
permission to make anAssociateDRTRole
request. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.To use the services of the SRT and make an
AssociateDRTRole
request, you must be subscribed to the Business Support plan or the Enterprise Support plan.- Parameters:
associateDrtRoleRequest
-- Returns:
- A Java Future containing the result of the AssociateDRTRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- AccessDeniedForDependencyException In order to grant the necessary access to the Shield Response Team
(SRT) the user submitting the request 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 Amazon Web Services Service. - OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
associateDRTRole
default CompletableFuture<AssociateDrtRoleResponse> associateDRTRole(Consumer<AssociateDrtRoleRequest.Builder> associateDrtRoleRequest) Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
You can associate only one
RoleArn
with your subscription. If you submit anAssociateDRTRole
request for an account that already has an associated role, the newRoleArn
will replace the existingRoleArn
.Prior to making the
AssociateDRTRole
request, you must attach theAWSShieldDRTAccessPolicy
managed policy to the role that you'll specify in the request. You can access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and removing IAM identity permissions. The role must also trust the service principaldrt.shield.amazonaws.com
. For more information, see IAM JSON policy elements: Principal.The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
You must have the
iam:PassRole
permission to make anAssociateDRTRole
request. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.To use the services of the SRT 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 viaAssociateDrtRoleRequest.builder()
- Parameters:
associateDrtRoleRequest
- AConsumer
that will call methods onAssociateDrtRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateDRTRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- AccessDeniedForDependencyException In order to grant the necessary access to the Shield Response Team
(SRT) the user submitting the request 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 Amazon Web Services Service. - OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
associateHealthCheck
default CompletableFuture<AssociateHealthCheckResponse> associateHealthCheck(AssociateHealthCheckRequest associateHealthCheckRequest) Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
- Parameters:
associateHealthCheckRequest
-- Returns:
- A Java Future containing the result of the AssociateHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalErrorException Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
- LimitsExceededException Exception that indicates that the operation would exceed a limit.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- InvalidResourceException Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might 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.
- See Also:
-
associateHealthCheck
default CompletableFuture<AssociateHealthCheckResponse> associateHealthCheck(Consumer<AssociateHealthCheckRequest.Builder> associateHealthCheckRequest) Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
This is a convenience which creates an instance of the
AssociateHealthCheckRequest.Builder
avoiding the need to create one manually viaAssociateHealthCheckRequest.builder()
- Parameters:
associateHealthCheckRequest
- AConsumer
that will call methods onAssociateHealthCheckRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalErrorException Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
- LimitsExceededException Exception that indicates that the operation would exceed a limit.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- InvalidResourceException Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might 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.
- See Also:
-
associateProactiveEngagementDetails
default CompletableFuture<AssociateProactiveEngagementDetailsResponse> associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest associateProactiveEngagementDetailsRequest) Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls
DisableProactiveEngagement
andEnableProactiveEngagement
.This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.
The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using
DescribeEmergencyContactSettings
and then provide it to this call.- Parameters:
associateProactiveEngagementDetailsRequest
-- Returns:
- A Java Future containing the result of the AssociateProactiveEngagementDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.
- See Also:
-
associateProactiveEngagementDetails
default CompletableFuture<AssociateProactiveEngagementDetailsResponse> associateProactiveEngagementDetails(Consumer<AssociateProactiveEngagementDetailsRequest.Builder> associateProactiveEngagementDetailsRequest) Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls
DisableProactiveEngagement
andEnableProactiveEngagement
.This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.
The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using
DescribeEmergencyContactSettings
and then provide it to this call.
This is a convenience which creates an instance of the
AssociateProactiveEngagementDetailsRequest.Builder
avoiding the need to create one manually viaAssociateProactiveEngagementDetailsRequest.builder()
- Parameters:
associateProactiveEngagementDetailsRequest
- AConsumer
that will call methods onAssociateProactiveEngagementDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateProactiveEngagementDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.
- See Also:
-
createProtection
default CompletableFuture<CreateProtectionResponse> createProtection(CreateProtectionRequest createProtectionRequest) Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
You can add protection to only a single resource with each
CreateProtection
request. You can add protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information see Getting Started with Shield Advanced and Adding Shield Advanced protection to Amazon Web Services resources.- Parameters:
createProtectionRequest
-- Returns:
- A Java Future containing the result of the CreateProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- ResourceAlreadyExistsException Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
createProtection
default CompletableFuture<CreateProtectionResponse> createProtection(Consumer<CreateProtectionRequest.Builder> createProtectionRequest) Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
You can add protection to only a single resource with each
CreateProtection
request. You can add protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information see Getting Started with Shield Advanced and Adding Shield Advanced protection to Amazon Web Services resources.
This is a convenience which creates an instance of the
CreateProtectionRequest.Builder
avoiding the need to create one manually viaCreateProtectionRequest.builder()
- Parameters:
createProtectionRequest
- AConsumer
that will call methods onCreateProtectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- ResourceAlreadyExistsException Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
createProtectionGroup
default CompletableFuture<CreateProtectionGroupResponse> createProtectionGroup(CreateProtectionGroupRequest createProtectionGroupRequest) Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
- Parameters:
createProtectionGroupRequest
-- Returns:
- A Java Future containing the result of the CreateProtectionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- LimitsExceededException Exception that indicates that the operation would exceed a limit.
- 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.
- See Also:
-
createProtectionGroup
default CompletableFuture<CreateProtectionGroupResponse> createProtectionGroup(Consumer<CreateProtectionGroupRequest.Builder> createProtectionGroupRequest) Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
This is a convenience which creates an instance of the
CreateProtectionGroupRequest.Builder
avoiding the need to create one manually viaCreateProtectionGroupRequest.builder()
- Parameters:
createProtectionGroupRequest
- AConsumer
that will call methods onCreateProtectionGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProtectionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- LimitsExceededException Exception that indicates that the operation would exceed a limit.
- 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.
- See Also:
-
createSubscription
default CompletableFuture<CreateSubscriptionResponse> createSubscription(CreateSubscriptionRequest createSubscriptionRequest) Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an
UpdateSubscription
request.- Parameters:
createSubscriptionRequest
-- Returns:
- A Java Future containing the result of the CreateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
createSubscription
default CompletableFuture<CreateSubscriptionResponse> createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an
UpdateSubscription
request.
This is a convenience which creates an instance of the
CreateSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateSubscriptionRequest.builder()
- Parameters:
createSubscriptionRequest
- AConsumer
that will call methods onCreateSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
createSubscription
Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an
UpdateSubscription
request.- Returns:
- A Java Future containing the result of the CreateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
deleteProtection
default CompletableFuture<DeleteProtectionResponse> deleteProtection(DeleteProtectionRequest deleteProtectionRequest) Deletes an Shield Advanced Protection.
- Parameters:
deleteProtectionRequest
-- Returns:
- A Java Future containing the result of the DeleteProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.
- See Also:
-
deleteProtection
default CompletableFuture<DeleteProtectionResponse> deleteProtection(Consumer<DeleteProtectionRequest.Builder> deleteProtectionRequest) Deletes an Shield Advanced Protection.
This is a convenience which creates an instance of the
DeleteProtectionRequest.Builder
avoiding the need to create one manually viaDeleteProtectionRequest.builder()
- Parameters:
deleteProtectionRequest
- AConsumer
that will call methods onDeleteProtectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.
- See Also:
-
deleteProtectionGroup
default CompletableFuture<DeleteProtectionGroupResponse> deleteProtectionGroup(DeleteProtectionGroupRequest deleteProtectionGroupRequest) Removes the specified protection group.
- Parameters:
deleteProtectionGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteProtectionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalErrorException Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
deleteProtectionGroup
default CompletableFuture<DeleteProtectionGroupResponse> deleteProtectionGroup(Consumer<DeleteProtectionGroupRequest.Builder> deleteProtectionGroupRequest) Removes the specified protection group.
This is a convenience which creates an instance of the
DeleteProtectionGroupRequest.Builder
avoiding the need to create one manually viaDeleteProtectionGroupRequest.builder()
- Parameters:
deleteProtectionGroupRequest
- AConsumer
that will call methods onDeleteProtectionGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProtectionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalErrorException Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeAttack
default CompletableFuture<DescribeAttackResponse> describeAttack(DescribeAttackRequest describeAttackRequest) Describes the details of a DDoS attack.
- Parameters:
describeAttackRequest
-- Returns:
- A Java Future containing the result of the DescribeAttack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalErrorException Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
- AccessDeniedException Exception that indicates the specified
AttackId
does not exist, or the requester does not have the appropriate permissions to access theAttackId
. - 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.
- See Also:
-
describeAttack
default CompletableFuture<DescribeAttackResponse> describeAttack(Consumer<DescribeAttackRequest.Builder> describeAttackRequest) 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 viaDescribeAttackRequest.builder()
- Parameters:
describeAttackRequest
- AConsumer
that will call methods onDescribeAttackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAttack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalErrorException Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
- AccessDeniedException Exception that indicates the specified
AttackId
does not exist, or the requester does not have the appropriate permissions to access theAttackId
. - 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.
- See Also:
-
describeAttackStatistics
default CompletableFuture<DescribeAttackStatisticsResponse> describeAttackStatistics(DescribeAttackStatisticsRequest describeAttackStatisticsRequest) Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is
2020-10-26 15:39:32 PDT
, equal to2020-10-26 22:39:32 UTC
, then the time range for the attack data returned is from2019-10-26 00:00:00 UTC
to2020-10-26 00:00:00 UTC
.The time range indicates the period covered by the attack statistics data items.
- Parameters:
describeAttackStatisticsRequest
-- Returns:
- A Java Future containing the result of the DescribeAttackStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAttackStatistics
default CompletableFuture<DescribeAttackStatisticsResponse> describeAttackStatistics(Consumer<DescribeAttackStatisticsRequest.Builder> describeAttackStatisticsRequest) Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is
2020-10-26 15:39:32 PDT
, equal to2020-10-26 22:39:32 UTC
, then the time range for the attack data returned is from2019-10-26 00:00:00 UTC
to2020-10-26 00:00:00 UTC
.The time range indicates the period covered by the attack statistics data items.
This is a convenience which creates an instance of the
DescribeAttackStatisticsRequest.Builder
avoiding the need to create one manually viaDescribeAttackStatisticsRequest.builder()
- Parameters:
describeAttackStatisticsRequest
- AConsumer
that will call methods onDescribeAttackStatisticsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAttackStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeDRTAccess
default CompletableFuture<DescribeDrtAccessResponse> describeDRTAccess(DescribeDrtAccessRequest describeDrtAccessRequest) Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.
- Parameters:
describeDrtAccessRequest
-- Returns:
- A Java Future containing the result of the DescribeDRTAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeDRTAccess
default CompletableFuture<DescribeDrtAccessResponse> describeDRTAccess(Consumer<DescribeDrtAccessRequest.Builder> describeDrtAccessRequest) Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.
This is a convenience which creates an instance of the
DescribeDrtAccessRequest.Builder
avoiding the need to create one manually viaDescribeDrtAccessRequest.builder()
- Parameters:
describeDrtAccessRequest
- AConsumer
that will call methods onDescribeDrtAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDRTAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeEmergencyContactSettings
default CompletableFuture<DescribeEmergencyContactSettingsResponse> describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest) A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
- Parameters:
describeEmergencyContactSettingsRequest
-- Returns:
- A Java Future containing the result of the DescribeEmergencyContactSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeEmergencyContactSettings
default CompletableFuture<DescribeEmergencyContactSettingsResponse> describeEmergencyContactSettings(Consumer<DescribeEmergencyContactSettingsRequest.Builder> describeEmergencyContactSettingsRequest) A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
This is a convenience which creates an instance of the
DescribeEmergencyContactSettingsRequest.Builder
avoiding the need to create one manually viaDescribeEmergencyContactSettingsRequest.builder()
- Parameters:
describeEmergencyContactSettingsRequest
- AConsumer
that will call methods onDescribeEmergencyContactSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEmergencyContactSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeProtection
default CompletableFuture<DescribeProtectionResponse> describeProtection(DescribeProtectionRequest describeProtectionRequest) Lists the details of a Protection object.
- Parameters:
describeProtectionRequest
-- Returns:
- A Java Future containing the result of the DescribeProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeProtection
default CompletableFuture<DescribeProtectionResponse> describeProtection(Consumer<DescribeProtectionRequest.Builder> describeProtectionRequest) 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 viaDescribeProtectionRequest.builder()
- Parameters:
describeProtectionRequest
- AConsumer
that will call methods onDescribeProtectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeProtectionGroup
default CompletableFuture<DescribeProtectionGroupResponse> describeProtectionGroup(DescribeProtectionGroupRequest describeProtectionGroupRequest) Returns the specification for the specified protection group.
- Parameters:
describeProtectionGroupRequest
-- Returns:
- A Java Future containing the result of the DescribeProtectionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeProtectionGroup
default CompletableFuture<DescribeProtectionGroupResponse> describeProtectionGroup(Consumer<DescribeProtectionGroupRequest.Builder> describeProtectionGroupRequest) Returns the specification for the specified protection group.
This is a convenience which creates an instance of the
DescribeProtectionGroupRequest.Builder
avoiding the need to create one manually viaDescribeProtectionGroupRequest.builder()
- Parameters:
describeProtectionGroupRequest
- AConsumer
that will call methods onDescribeProtectionGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProtectionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeSubscription
default CompletableFuture<DescribeSubscriptionResponse> describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest) Provides details about the Shield Advanced subscription for an account.
- Parameters:
describeSubscriptionRequest
-- Returns:
- A Java Future containing the result of the DescribeSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeSubscription
default CompletableFuture<DescribeSubscriptionResponse> describeSubscription(Consumer<DescribeSubscriptionRequest.Builder> describeSubscriptionRequest) Provides details about the 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 viaDescribeSubscriptionRequest.builder()
- Parameters:
describeSubscriptionRequest
- AConsumer
that will call methods onDescribeSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
describeSubscription
Provides details about the Shield Advanced subscription for an account.
- Returns:
- A Java Future containing the result of the DescribeSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
disableApplicationLayerAutomaticResponse
default CompletableFuture<DisableApplicationLayerAutomaticResponseResponse> disableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest disableApplicationLayerAutomaticResponseRequest) Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.
- Parameters:
disableApplicationLayerAutomaticResponseRequest
-- Returns:
- A Java Future containing the result of the DisableApplicationLayerAutomaticResponse operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- 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.
- See Also:
-
disableApplicationLayerAutomaticResponse
default CompletableFuture<DisableApplicationLayerAutomaticResponseResponse> disableApplicationLayerAutomaticResponse(Consumer<DisableApplicationLayerAutomaticResponseRequest.Builder> disableApplicationLayerAutomaticResponseRequest) Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.
This is a convenience which creates an instance of the
DisableApplicationLayerAutomaticResponseRequest.Builder
avoiding the need to create one manually viaDisableApplicationLayerAutomaticResponseRequest.builder()
- Parameters:
disableApplicationLayerAutomaticResponseRequest
- AConsumer
that will call methods onDisableApplicationLayerAutomaticResponseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableApplicationLayerAutomaticResponse operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- 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.
- See Also:
-
disableProactiveEngagement
default CompletableFuture<DisableProactiveEngagementResponse> disableProactiveEngagement(DisableProactiveEngagementRequest disableProactiveEngagementRequest) Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
- Parameters:
disableProactiveEngagementRequest
-- Returns:
- A Java Future containing the result of the DisableProactiveEngagement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.
- See Also:
-
disableProactiveEngagement
default CompletableFuture<DisableProactiveEngagementResponse> disableProactiveEngagement(Consumer<DisableProactiveEngagementRequest.Builder> disableProactiveEngagementRequest) Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
This is a convenience which creates an instance of the
DisableProactiveEngagementRequest.Builder
avoiding the need to create one manually viaDisableProactiveEngagementRequest.builder()
- Parameters:
disableProactiveEngagementRequest
- AConsumer
that will call methods onDisableProactiveEngagementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableProactiveEngagement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.
- See Also:
-
disassociateDRTLogBucket
default CompletableFuture<DisassociateDrtLogBucketResponse> disassociateDRTLogBucket(DisassociateDrtLogBucketRequest disassociateDrtLogBucketRequest) Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
- Parameters:
disassociateDrtLogBucketRequest
-- Returns:
- A Java Future containing the result of the DisassociateDRTLogBucket operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 specified does not exist.
- AccessDeniedForDependencyException In order to grant the necessary access to the Shield Response Team
(SRT) the user submitting the request 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 Amazon Web Services Service. - OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
disassociateDRTLogBucket
default CompletableFuture<DisassociateDrtLogBucketResponse> disassociateDRTLogBucket(Consumer<DisassociateDrtLogBucketRequest.Builder> disassociateDrtLogBucketRequest) Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
This is a convenience which creates an instance of the
DisassociateDrtLogBucketRequest.Builder
avoiding the need to create one manually viaDisassociateDrtLogBucketRequest.builder()
- Parameters:
disassociateDrtLogBucketRequest
- AConsumer
that will call methods onDisassociateDrtLogBucketRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateDRTLogBucket operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 specified does not exist.
- AccessDeniedForDependencyException In order to grant the necessary access to the Shield Response Team
(SRT) the user submitting the request 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 Amazon Web Services Service. - OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
disassociateDRTRole
default CompletableFuture<DisassociateDrtRoleResponse> disassociateDRTRole(DisassociateDrtRoleRequest disassociateDrtRoleRequest) Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
- Parameters:
disassociateDrtRoleRequest
-- Returns:
- A Java Future containing the result of the DisassociateDRTRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
disassociateDRTRole
default CompletableFuture<DisassociateDrtRoleResponse> disassociateDRTRole(Consumer<DisassociateDrtRoleRequest.Builder> disassociateDrtRoleRequest) Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
This is a convenience which creates an instance of the
DisassociateDrtRoleRequest.Builder
avoiding the need to create one manually viaDisassociateDrtRoleRequest.builder()
- Parameters:
disassociateDrtRoleRequest
- AConsumer
that will call methods onDisassociateDrtRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateDRTRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
disassociateDRTRole
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
- Returns:
- A Java Future containing the result of the DisassociateDRTRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
disassociateHealthCheck
default CompletableFuture<DisassociateHealthCheckResponse> disassociateHealthCheck(DisassociateHealthCheckRequest disassociateHealthCheckRequest) Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
- Parameters:
disassociateHealthCheckRequest
-- Returns:
- A Java Future containing the result of the DisassociateHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- InvalidResourceException Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might 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.
- See Also:
-
disassociateHealthCheck
default CompletableFuture<DisassociateHealthCheckResponse> disassociateHealthCheck(Consumer<DisassociateHealthCheckRequest.Builder> disassociateHealthCheckRequest) Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
This is a convenience which creates an instance of the
DisassociateHealthCheckRequest.Builder
avoiding the need to create one manually viaDisassociateHealthCheckRequest.builder()
- Parameters:
disassociateHealthCheckRequest
- AConsumer
that will call methods onDisassociateHealthCheckRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- InvalidResourceException Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might 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.
- See Also:
-
enableApplicationLayerAutomaticResponse
default CompletableFuture<EnableApplicationLayerAutomaticResponseResponse> enableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest enableApplicationLayerAutomaticResponseRequest) Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
This feature is available for Amazon CloudFront distributions and Application Load Balancers only.
This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation.
Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.
To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide.
- Parameters:
enableApplicationLayerAutomaticResponseRequest
-- Returns:
- A Java Future containing the result of the EnableApplicationLayerAutomaticResponse operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitsExceededException Exception that indicates that the operation would exceed a limit.
- 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. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- 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.
- See Also:
-
enableApplicationLayerAutomaticResponse
default CompletableFuture<EnableApplicationLayerAutomaticResponseResponse> enableApplicationLayerAutomaticResponse(Consumer<EnableApplicationLayerAutomaticResponseRequest.Builder> enableApplicationLayerAutomaticResponseRequest) Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
This feature is available for Amazon CloudFront distributions and Application Load Balancers only.
This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation.
Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.
To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide.
This is a convenience which creates an instance of the
EnableApplicationLayerAutomaticResponseRequest.Builder
avoiding the need to create one manually viaEnableApplicationLayerAutomaticResponseRequest.builder()
- Parameters:
enableApplicationLayerAutomaticResponseRequest
- AConsumer
that will call methods onEnableApplicationLayerAutomaticResponseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableApplicationLayerAutomaticResponse operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitsExceededException Exception that indicates that the operation would exceed a limit.
- 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. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- 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.
- See Also:
-
enableProactiveEngagement
default CompletableFuture<EnableProactiveEngagementResponse> enableProactiveEngagement(EnableProactiveEngagementRequest enableProactiveEngagementRequest) Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
- Parameters:
enableProactiveEngagementRequest
-- Returns:
- A Java Future containing the result of the EnableProactiveEngagement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.
- See Also:
-
enableProactiveEngagement
default CompletableFuture<EnableProactiveEngagementResponse> enableProactiveEngagement(Consumer<EnableProactiveEngagementRequest.Builder> enableProactiveEngagementRequest) Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
This is a convenience which creates an instance of the
EnableProactiveEngagementRequest.Builder
avoiding the need to create one manually viaEnableProactiveEngagementRequest.builder()
- Parameters:
enableProactiveEngagementRequest
- AConsumer
that will call methods onEnableProactiveEngagementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableProactiveEngagement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.
- See Also:
-
getSubscriptionState
default CompletableFuture<GetSubscriptionStateResponse> getSubscriptionState(GetSubscriptionStateRequest getSubscriptionStateRequest) Returns the
SubscriptionState
, eitherActive
orInactive
.- Parameters:
getSubscriptionStateRequest
-- Returns:
- A Java Future containing the result of the GetSubscriptionState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSubscriptionState
default CompletableFuture<GetSubscriptionStateResponse> getSubscriptionState(Consumer<GetSubscriptionStateRequest.Builder> getSubscriptionStateRequest) Returns the
SubscriptionState
, eitherActive
orInactive
.
This is a convenience which creates an instance of the
GetSubscriptionStateRequest.Builder
avoiding the need to create one manually viaGetSubscriptionStateRequest.builder()
- Parameters:
getSubscriptionStateRequest
- AConsumer
that will call methods onGetSubscriptionStateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSubscriptionState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSubscriptionState
Returns the
SubscriptionState
, eitherActive
orInactive
.- Returns:
- A Java Future containing the result of the GetSubscriptionState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttacks
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
- Parameters:
listAttacksRequest
-- Returns:
- A Java Future containing the result of the ListAttacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
listAttacks
default CompletableFuture<ListAttacksResponse> listAttacks(Consumer<ListAttacksRequest.Builder> listAttacksRequest) 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 viaListAttacksRequest.builder()
- Parameters:
listAttacksRequest
- AConsumer
that will call methods onListAttacksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAttacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
listAttacks
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
- Returns:
- A Java Future containing the result of the ListAttacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
listAttacksPaginator
This is a variant of
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListAttacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.shield.model.ListAttacksResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
listAttacksPaginator
This is a variant of
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListAttacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.shield.model.ListAttacksResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.- Parameters:
listAttacksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
listAttacksPaginator
default ListAttacksPublisher listAttacksPaginator(Consumer<ListAttacksRequest.Builder> listAttacksRequest) This is a variant of
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListAttacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.shield.model.ListAttacksResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.
This is a convenience which creates an instance of the
ListAttacksRequest.Builder
avoiding the need to create one manually viaListAttacksRequest.builder()
- Parameters:
listAttacksRequest
- AConsumer
that will call methods onListAttacksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
listProtectionGroups
default CompletableFuture<ListProtectionGroupsResponse> listProtectionGroups(ListProtectionGroupsRequest listProtectionGroupsRequest) Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
- Parameters:
listProtectionGroupsRequest
-- Returns:
- A Java Future containing the result of the ListProtectionGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listProtectionGroups
default CompletableFuture<ListProtectionGroupsResponse> listProtectionGroups(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest) Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
This is a convenience which creates an instance of the
ListProtectionGroupsRequest.Builder
avoiding the need to create one manually viaListProtectionGroupsRequest.builder()
- Parameters:
listProtectionGroupsRequest
- AConsumer
that will call methods onListProtectionGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProtectionGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listProtectionGroupsPaginator
default ListProtectionGroupsPublisher listProtectionGroupsPaginator(ListProtectionGroupsRequest listProtectionGroupsRequest) This is a variant of
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.shield.paginators.ListProtectionGroupsPublisher publisher = client.listProtectionGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.shield.paginators.ListProtectionGroupsPublisher publisher = client.listProtectionGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListProtectionGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.shield.model.ListProtectionGroupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation.- Parameters:
listProtectionGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listProtectionGroupsPaginator
default ListProtectionGroupsPublisher listProtectionGroupsPaginator(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest) This is a variant of
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.shield.paginators.ListProtectionGroupsPublisher publisher = client.listProtectionGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.shield.paginators.ListProtectionGroupsPublisher publisher = client.listProtectionGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListProtectionGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.shield.model.ListProtectionGroupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListProtectionGroupsRequest.Builder
avoiding the need to create one manually viaListProtectionGroupsRequest.builder()
- Parameters:
listProtectionGroupsRequest
- AConsumer
that will call methods onListProtectionGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listProtections
default CompletableFuture<ListProtectionsResponse> listProtections(ListProtectionsRequest listProtectionsRequest) Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
- Parameters:
listProtectionsRequest
-- Returns:
- A Java Future containing the result of the ListProtections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listProtections
default CompletableFuture<ListProtectionsResponse> listProtections(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest) Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
This is a convenience which creates an instance of the
ListProtectionsRequest.Builder
avoiding the need to create one manually viaListProtectionsRequest.builder()
- Parameters:
listProtectionsRequest
- AConsumer
that will call methods onListProtectionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProtections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listProtections
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
- Returns:
- A Java Future containing the result of the ListProtections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listProtectionsPaginator
This is a variant of
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListProtectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.shield.model.ListProtectionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listProtectionsPaginator
default ListProtectionsPublisher listProtectionsPaginator(ListProtectionsRequest listProtectionsRequest) This is a variant of
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListProtectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.shield.model.ListProtectionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.- Parameters:
listProtectionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listProtectionsPaginator
default ListProtectionsPublisher listProtectionsPaginator(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest) This is a variant of
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListProtectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.shield.model.ListProtectionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.
This is a convenience which creates an instance of the
ListProtectionsRequest.Builder
avoiding the need to create one manually viaListProtectionsRequest.builder()
- Parameters:
listProtectionsRequest
- AConsumer
that will call methods onListProtectionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listResourcesInProtectionGroup
default CompletableFuture<ListResourcesInProtectionGroupResponse> listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest) Retrieves the resources that are included in the protection group.
- Parameters:
listResourcesInProtectionGroupRequest
-- Returns:
- A Java Future containing the result of the ListResourcesInProtectionGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listResourcesInProtectionGroup
default CompletableFuture<ListResourcesInProtectionGroupResponse> listResourcesInProtectionGroup(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest) Retrieves the resources that are included in the protection group.
This is a convenience which creates an instance of the
ListResourcesInProtectionGroupRequest.Builder
avoiding the need to create one manually viaListResourcesInProtectionGroupRequest.builder()
- Parameters:
listResourcesInProtectionGroupRequest
- AConsumer
that will call methods onListResourcesInProtectionGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourcesInProtectionGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listResourcesInProtectionGroupPaginator
default ListResourcesInProtectionGroupPublisher listResourcesInProtectionGroupPaginator(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest) This is a variant of
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupPublisher publisher = client.listResourcesInProtectionGroupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupPublisher publisher = client.listResourcesInProtectionGroupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation.- Parameters:
listResourcesInProtectionGroupRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listResourcesInProtectionGroupPaginator
default ListResourcesInProtectionGroupPublisher listResourcesInProtectionGroupPaginator(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest) This is a variant of
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupPublisher publisher = client.listResourcesInProtectionGroupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupPublisher publisher = client.listResourcesInProtectionGroupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation.
This is a convenience which creates an instance of the
ListResourcesInProtectionGroupRequest.Builder
avoiding the need to create one manually viaListResourcesInProtectionGroupRequest.builder()
- Parameters:
listResourcesInProtectionGroupRequest
- AConsumer
that will call methods onListResourcesInProtectionGroupRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidPaginationTokenException Exception that indicates that the
NextToken
specified in the request is invalid. Submit the request using theNextToken
value that was returned in the prior 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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
tagResource
Adds or updates tags for a resource in Shield.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for a resource in Shield.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a resource in Shield.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a resource in Shield.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
updateApplicationLayerAutomaticResponse
default CompletableFuture<UpdateApplicationLayerAutomaticResponseResponse> updateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest updateApplicationLayerAutomaticResponseRequest) Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
- Parameters:
updateApplicationLayerAutomaticResponseRequest
-- Returns:
- A Java Future containing the result of the UpdateApplicationLayerAutomaticResponse operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- 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.
- See Also:
-
updateApplicationLayerAutomaticResponse
default CompletableFuture<UpdateApplicationLayerAutomaticResponseResponse> updateApplicationLayerAutomaticResponse(Consumer<UpdateApplicationLayerAutomaticResponseRequest.Builder> updateApplicationLayerAutomaticResponseRequest) Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
This is a convenience which creates an instance of the
UpdateApplicationLayerAutomaticResponseRequest.Builder
avoiding the need to create one manually viaUpdateApplicationLayerAutomaticResponseRequest.builder()
- Parameters:
updateApplicationLayerAutomaticResponseRequest
- AConsumer
that will call methods onUpdateApplicationLayerAutomaticResponseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateApplicationLayerAutomaticResponse operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- 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.
- See Also:
-
updateEmergencyContactSettings
default CompletableFuture<UpdateEmergencyContactSettingsResponse> updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest) Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
- Parameters:
updateEmergencyContactSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdateEmergencyContactSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
updateEmergencyContactSettings
default CompletableFuture<UpdateEmergencyContactSettingsResponse> updateEmergencyContactSettings(Consumer<UpdateEmergencyContactSettingsRequest.Builder> updateEmergencyContactSettingsRequest) Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
This is a convenience which creates an instance of the
UpdateEmergencyContactSettingsRequest.Builder
avoiding the need to create one manually viaUpdateEmergencyContactSettingsRequest.builder()
- Parameters:
updateEmergencyContactSettingsRequest
- AConsumer
that will call methods onUpdateEmergencyContactSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEmergencyContactSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
updateProtectionGroup
default CompletableFuture<UpdateProtectionGroupResponse> updateProtectionGroup(UpdateProtectionGroupRequest updateProtectionGroupRequest) Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
- Parameters:
updateProtectionGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateProtectionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
updateProtectionGroup
default CompletableFuture<UpdateProtectionGroupResponse> updateProtectionGroup(Consumer<UpdateProtectionGroupRequest.Builder> updateProtectionGroupRequest) Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
This is a convenience which creates an instance of the
UpdateProtectionGroupRequest.Builder
avoiding the need to create one manually viaUpdateProtectionGroupRequest.builder()
- Parameters:
updateProtectionGroupRequest
- AConsumer
that will call methods onUpdateProtectionGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProtectionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- 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.
- See Also:
-
updateSubscription
default CompletableFuture<UpdateSubscriptionResponse> updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest) Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
- Parameters:
updateSubscriptionRequest
-- Returns:
- A Java Future containing the result of the UpdateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 changeAutoRenew
prior to that period. - ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.
- See Also:
-
updateSubscription
default CompletableFuture<UpdateSubscriptionResponse> updateSubscription(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest) Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
This is a convenience which creates an instance of the
UpdateSubscriptionRequest.Builder
avoiding the need to create one manually viaUpdateSubscriptionRequest.builder()
- Parameters:
updateSubscriptionRequest
- AConsumer
that will call methods onUpdateSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 changeAutoRenew
prior to that period. - ResourceNotFoundException Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
- InvalidParameterException Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
- OptimisticLockException Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aShieldAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aShieldAsyncClient
.
-