Package software.amazon.awssdk.services.shield

Interface ShieldAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface ShieldAsyncClient
extends AutoCloseable

Service client for accessing AWS Shield asynchronously. This can be created using the static builder() method. AWS Shield Advanced

This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.

Method Summary

Modifier and Type	Method	Description
static ShieldAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a ShieldAsyncClient.
static ShieldAsyncClient	create()	Create a ShieldAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateProtectionResponse>	createProtection(CreateProtectionRequest createProtectionRequest)	Enables AWS Shield Advanced for a specific AWS resource.
default CompletableFuture<CreateSubscriptionResponse>	createSubscription(CreateSubscriptionRequest createSubscriptionRequest)	Activates AWS Shield Advanced for an account.
default CompletableFuture<DeleteProtectionResponse>	deleteProtection(DeleteProtectionRequest deleteProtectionRequest)	Deletes an AWS Shield Advanced Protection.
default CompletableFuture<DeleteSubscriptionResponse>	deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest)	Removes AWS Shield Advanced from an account.
default CompletableFuture<DescribeAttackResponse>	describeAttack(DescribeAttackRequest describeAttackRequest)	Describes the details of a DDoS attack.
default CompletableFuture<DescribeProtectionResponse>	describeProtection(DescribeProtectionRequest describeProtectionRequest)	Lists the details of a Protection object.
default CompletableFuture<DescribeSubscriptionResponse>	describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest)	Provides details about the AWS Shield Advanced subscription for an account.
default CompletableFuture<ListAttacksResponse>	listAttacks(ListAttacksRequest listAttacksRequest)	Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
default CompletableFuture<ListProtectionsResponse>	listProtections(ListProtectionsRequest listProtectionsRequest)	Lists all Protection objects for the account.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static ShieldAsyncClient create()

Create a ShieldAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ShieldAsyncClientBuilder builder()

Create a builder that can be used to configure and create a ShieldAsyncClient.

createProtection

default CompletableFuture<CreateProtectionResponse> createProtection(CreateProtectionRequest createProtectionRequest)

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

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.

• 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.
• OptimisticLockException Exception that indicates that the protection state has been modified by another client. You can retry the request.
• ResourceNotFoundException Exception indicating the specified resource does not exist.
• SdkBaseException 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

See Also:

AWS API Documentation

createSubscription

default CompletableFuture<CreateSubscriptionResponse> createSubscription(CreateSubscriptionRequest createSubscriptionRequest)

Activates AWS Shield Advanced for an account.

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.

• 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.
• SdkBaseException 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

See Also:

AWS API Documentation

deleteProtection

default CompletableFuture<DeleteProtectionResponse> deleteProtection(DeleteProtectionRequest deleteProtectionRequest)

Deletes an AWS 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.

• InternalErrorException Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
• ResourceNotFoundException Exception indicating the specified resource does not exist.
• OptimisticLockException Exception that indicates that the protection state has been modified by another client. You can retry the request.
• SdkBaseException 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

See Also:

AWS API Documentation

deleteSubscription

default CompletableFuture<DeleteSubscriptionResponse> deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest)

Removes AWS Shield Advanced from an account.

Parameters:

deleteSubscriptionRequest -

Returns:

A Java Future containing the result of the DeleteSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
• LockedSubscriptionException Exception that indicates that the subscription has been modified by another client. You can retry the request.
• ResourceNotFoundException Exception indicating the specified resource does not exist.
• SdkBaseException 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

See Also:

AWS API Documentation

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.

• 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.
• SdkBaseException 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

See Also:

AWS API Documentation

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.

• 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.
• SdkBaseException 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

See Also:

AWS API Documentation

describeSubscription

default CompletableFuture<DescribeSubscriptionResponse> describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest)

Provides details about the AWS 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.

• 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.
• SdkBaseException 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

See Also:

AWS API Documentation

listAttacks

default CompletableFuture<ListAttacksResponse> listAttacks(ListAttacksRequest listAttacksRequest)

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.

• InternalErrorException Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
• InvalidParameterException Exception that indicates that the parameters passed to the API are invalid.
• InvalidOperationException Exception that indicates that the operation would not cause any change to occur.
• SdkBaseException 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

See Also:

AWS API Documentation

listProtections

default CompletableFuture<ListProtectionsResponse> listProtections(ListProtectionsRequest listProtectionsRequest)

Lists all Protection objects for the account.

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.

• 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.
• SdkBaseException 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

See Also:

AWS API Documentation