Package software.amazon.awssdk.services.shield

Interface ShieldClient

All Superinterfaces:

AutoCloseable

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

Service client for accessing AWS Shield. 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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static ShieldClient create()

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

builder

static ShieldClientBuilder builder()

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

createProtection

default CreateProtectionResponse createProtection(CreateProtectionRequest createProtectionRequest)
                                           throws InternalErrorException,
                                                  InvalidResourceException,
                                                  InvalidOperationException,
                                                  LimitsExceededException,
                                                  ResourceAlreadyExistsException,
                                                  OptimisticLockException,
                                                  ResourceNotFoundException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  ShieldException

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:

Result of the CreateProtection operation returned by the service.

Throws:

InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidResourceException - Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.

LimitsExceededException - Exception that indicates that the operation would exceed a limit.

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createSubscription

default CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest createSubscriptionRequest)
                                               throws InternalErrorException,
                                                      ResourceAlreadyExistsException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      ShieldException

Activates AWS Shield Advanced for an account.

Parameters:

createSubscriptionRequest -

Returns:

Result of the CreateSubscription operation returned by the service.

Throws:

InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceAlreadyExistsException - Exception indicating the specified resource already exists.

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteProtection

default DeleteProtectionResponse deleteProtection(DeleteProtectionRequest deleteProtectionRequest)
                                           throws InternalErrorException,
                                                  ResourceNotFoundException,
                                                  OptimisticLockException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  ShieldException

Deletes an AWS Shield Advanced Protection.

Parameters:

deleteProtectionRequest -

Returns:

Result of the DeleteProtection operation returned by the service.

Throws:

InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException - Exception indicating the specified resource does not exist.

OptimisticLockException - Exception that indicates that the protection state has been modified by another client. You can retry the request.

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteSubscription

default DeleteSubscriptionResponse deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest)
                                               throws InternalErrorException,
                                                      LockedSubscriptionException,
                                                      ResourceNotFoundException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      ShieldException

Removes AWS Shield Advanced from an account.

Parameters:

deleteSubscriptionRequest -

Returns:

Result of the DeleteSubscription operation returned by the service.

Throws:

InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

LockedSubscriptionException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeAttack

default DescribeAttackResponse describeAttack(DescribeAttackRequest describeAttackRequest)
                                       throws InternalErrorException,
                                              InvalidParameterException,
                                              SdkBaseException,
                                              SdkClientException,
                                              ShieldException

Describes the details of a DDoS attack.

Parameters:

describeAttackRequest -

Returns:

Result of the DescribeAttack operation returned by the service.

Throws:

InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid.

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeProtection

default DescribeProtectionResponse describeProtection(DescribeProtectionRequest describeProtectionRequest)
                                               throws InternalErrorException,
                                                      ResourceNotFoundException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      ShieldException

Lists the details of a Protection object.

Parameters:

describeProtectionRequest -

Returns:

Result of the DescribeProtection operation returned by the service.

Throws:

InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException - Exception indicating the specified resource does not exist.

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeSubscription

default DescribeSubscriptionResponse describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest)
                                                   throws InternalErrorException,
                                                          ResourceNotFoundException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          ShieldException

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

Parameters:

describeSubscriptionRequest -

Returns:

Result of the DescribeSubscription operation returned by the service.

Throws:

InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException - Exception indicating the specified resource does not exist.

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listAttacks

default ListAttacksResponse listAttacks(ListAttacksRequest listAttacksRequest)
                                 throws InternalErrorException,
                                        InvalidParameterException,
                                        InvalidOperationException,
                                        SdkBaseException,
                                        SdkClientException,
                                        ShieldException

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

Parameters:

listAttacksRequest -

Returns:

Result of the ListAttacks operation returned by the service.

Throws:

InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid.

InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listProtections

default ListProtectionsResponse listProtections(ListProtectionsRequest listProtectionsRequest)
                                         throws InternalErrorException,
                                                ResourceNotFoundException,
                                                SdkBaseException,
                                                SdkClientException,
                                                ShieldException

Lists all Protection objects for the account.

Parameters:

listProtectionsRequest -

Returns:

Result of the ListProtections operation returned by the service.

Throws:

InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException - Exception indicating the specified resource does not exist.

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()