@Generated(value="software.amazon.awssdk:codegen") public interface ShieldClient extends SdkClient, SdkAutoCloseable
builder()
method.
This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static ShieldClientBuilder |
builder()
Create a builder that can be used to configure and create a
ShieldClient . |
static ShieldClient |
create()
Create a
ShieldClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CreateProtectionResponse |
createProtection(Consumer<CreateProtectionRequest.Builder> createProtectionRequest)
Enables AWS Shield Advanced for a specific AWS resource.
|
default CreateProtectionResponse |
createProtection(CreateProtectionRequest createProtectionRequest)
Enables AWS Shield Advanced for a specific AWS resource.
|
default CreateSubscriptionResponse |
createSubscription()
Activates AWS Shield Advanced for an account.
|
default CreateSubscriptionResponse |
createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest)
Activates AWS Shield Advanced for an account.
|
default CreateSubscriptionResponse |
createSubscription(CreateSubscriptionRequest createSubscriptionRequest)
Activates AWS Shield Advanced for an account.
|
default DeleteProtectionResponse |
deleteProtection(Consumer<DeleteProtectionRequest.Builder> deleteProtectionRequest)
Deletes an AWS Shield Advanced Protection.
|
default DeleteProtectionResponse |
deleteProtection(DeleteProtectionRequest deleteProtectionRequest)
Deletes an AWS Shield Advanced Protection.
|
default DeleteSubscriptionResponse |
deleteSubscription()
Removes AWS Shield Advanced from an account.
|
default DeleteSubscriptionResponse |
deleteSubscription(Consumer<DeleteSubscriptionRequest.Builder> deleteSubscriptionRequest)
Removes AWS Shield Advanced from an account.
|
default DeleteSubscriptionResponse |
deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest)
Removes AWS Shield Advanced from an account.
|
default DescribeAttackResponse |
describeAttack(Consumer<DescribeAttackRequest.Builder> describeAttackRequest)
Describes the details of a DDoS attack.
|
default DescribeAttackResponse |
describeAttack(DescribeAttackRequest describeAttackRequest)
Describes the details of a DDoS attack.
|
default DescribeProtectionResponse |
describeProtection(Consumer<DescribeProtectionRequest.Builder> describeProtectionRequest)
Lists the details of a Protection object.
|
default DescribeProtectionResponse |
describeProtection(DescribeProtectionRequest describeProtectionRequest)
Lists the details of a Protection object.
|
default DescribeSubscriptionResponse |
describeSubscription()
Provides details about the AWS Shield Advanced subscription for an account.
|
default DescribeSubscriptionResponse |
describeSubscription(Consumer<DescribeSubscriptionRequest.Builder> describeSubscriptionRequest)
Provides details about the AWS Shield Advanced subscription for an account.
|
default DescribeSubscriptionResponse |
describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest)
Provides details about the AWS Shield Advanced subscription for an account.
|
default ListAttacksResponse |
listAttacks()
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default ListAttacksResponse |
listAttacks(Consumer<ListAttacksRequest.Builder> listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default ListAttacksResponse |
listAttacks(ListAttacksRequest listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default ListProtectionsResponse |
listProtections()
Lists all Protection objects for the account.
|
default ListProtectionsResponse |
listProtections(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest)
Lists all Protection objects for the account.
|
default ListProtectionsResponse |
listProtections(ListProtectionsRequest listProtectionsRequest)
Lists all Protection objects for the account.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static ShieldClient create()
ShieldClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static ShieldClientBuilder builder()
ShieldClient
.default CreateProtectionResponse createProtection(CreateProtectionRequest createProtectionRequest) throws InternalErrorException, InvalidResourceException, InvalidOperationException, LimitsExceededException, ResourceAlreadyExistsException, OptimisticLockException, ResourceNotFoundException, SdkServiceException, 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.
createProtectionRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.InvalidResourceException
- Exception that indicates that the resource is invalid. You might not have access to the resource, or the
resource might not exist.InvalidOperationException
- Exception that indicates that the operation would not cause any change to occur.LimitsExceededException
- Exception that indicates that the operation would exceed a limit.ResourceAlreadyExistsException
- Exception indicating the specified resource already exists.OptimisticLockException
- Exception that indicates that the protection state has been modified by another client. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateProtectionResponse createProtection(Consumer<CreateProtectionRequest.Builder> createProtectionRequest) throws InternalErrorException, InvalidResourceException, InvalidOperationException, LimitsExceededException, ResourceAlreadyExistsException, OptimisticLockException, ResourceNotFoundException, SdkServiceException, 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.
createProtectionRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.InvalidResourceException
- Exception that indicates that the resource is invalid. You might not have access to the resource, or the
resource might not exist.InvalidOperationException
- Exception that indicates that the operation would not cause any change to occur.LimitsExceededException
- Exception that indicates that the operation would exceed a limit.ResourceAlreadyExistsException
- Exception indicating the specified resource already exists.OptimisticLockException
- Exception that indicates that the protection state has been modified by another client. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateSubscriptionResponse createSubscription() throws InternalErrorException, ResourceAlreadyExistsException, SdkServiceException, SdkClientException, ShieldException
Activates AWS Shield Advanced for an account.
InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceAlreadyExistsException
- Exception indicating the specified resource already exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
createSubscription(CreateSubscriptionRequest)
,
AWS API
Documentationdefault CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest createSubscriptionRequest) throws InternalErrorException, ResourceAlreadyExistsException, SdkServiceException, SdkClientException, ShieldException
Activates AWS Shield Advanced for an account.
createSubscriptionRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceAlreadyExistsException
- Exception indicating the specified resource already exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateSubscriptionResponse createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) throws InternalErrorException, ResourceAlreadyExistsException, SdkServiceException, SdkClientException, ShieldException
Activates AWS Shield Advanced for an account.
createSubscriptionRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceAlreadyExistsException
- Exception indicating the specified resource already exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteProtectionResponse deleteProtection(DeleteProtectionRequest deleteProtectionRequest) throws InternalErrorException, ResourceNotFoundException, OptimisticLockException, SdkServiceException, SdkClientException, ShieldException
Deletes an AWS Shield Advanced Protection.
deleteProtectionRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.OptimisticLockException
- Exception that indicates that the protection state has been modified by another client. You can retry the
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteProtectionResponse deleteProtection(Consumer<DeleteProtectionRequest.Builder> deleteProtectionRequest) throws InternalErrorException, ResourceNotFoundException, OptimisticLockException, SdkServiceException, SdkClientException, ShieldException
Deletes an AWS Shield Advanced Protection.
deleteProtectionRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.OptimisticLockException
- Exception that indicates that the protection state has been modified by another client. You can retry the
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteSubscriptionResponse deleteSubscription() throws InternalErrorException, LockedSubscriptionException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Removes AWS Shield Advanced from an account.
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.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.SdkServiceException
deleteSubscription(DeleteSubscriptionRequest)
,
AWS API
Documentationdefault DeleteSubscriptionResponse deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest) throws InternalErrorException, LockedSubscriptionException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Removes AWS Shield Advanced from an account.
deleteSubscriptionRequest
- 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.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.SdkServiceException
default DeleteSubscriptionResponse deleteSubscription(Consumer<DeleteSubscriptionRequest.Builder> deleteSubscriptionRequest) throws InternalErrorException, LockedSubscriptionException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Removes AWS Shield Advanced from an account.
deleteSubscriptionRequest
- 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.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.SdkServiceException
default DescribeAttackResponse describeAttack(DescribeAttackRequest describeAttackRequest) throws InternalErrorException, InvalidParameterException, SdkServiceException, SdkClientException, ShieldException
Describes the details of a DDoS attack.
describeAttackRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.InvalidParameterException
- Exception that indicates that the parameters passed to the API are invalid.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.SdkServiceException
default DescribeAttackResponse describeAttack(Consumer<DescribeAttackRequest.Builder> describeAttackRequest) throws InternalErrorException, InvalidParameterException, SdkServiceException, SdkClientException, ShieldException
Describes the details of a DDoS attack.
describeAttackRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.InvalidParameterException
- Exception that indicates that the parameters passed to the API are invalid.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.SdkServiceException
default DescribeProtectionResponse describeProtection(DescribeProtectionRequest describeProtectionRequest) throws InternalErrorException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Lists the details of a Protection object.
describeProtectionRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeProtectionResponse describeProtection(Consumer<DescribeProtectionRequest.Builder> describeProtectionRequest) throws InternalErrorException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Lists the details of a Protection object.
describeProtectionRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeSubscriptionResponse describeSubscription() throws InternalErrorException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Provides details about the AWS Shield Advanced subscription for an account.
InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
describeSubscription(DescribeSubscriptionRequest)
,
AWS
API Documentationdefault DescribeSubscriptionResponse describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest) throws InternalErrorException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Provides details about the AWS Shield Advanced subscription for an account.
describeSubscriptionRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeSubscriptionResponse describeSubscription(Consumer<DescribeSubscriptionRequest.Builder> describeSubscriptionRequest) throws InternalErrorException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Provides details about the AWS Shield Advanced subscription for an account.
describeSubscriptionRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListAttacksResponse listAttacks() throws InternalErrorException, InvalidParameterException, InvalidOperationException, SdkServiceException, SdkClientException, ShieldException
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.InvalidParameterException
- Exception that indicates that the parameters passed to the API are invalid.InvalidOperationException
- Exception that indicates that the operation would not cause any change to occur.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listAttacks(ListAttacksRequest)
,
AWS API
Documentationdefault ListAttacksResponse listAttacks(ListAttacksRequest listAttacksRequest) throws InternalErrorException, InvalidParameterException, InvalidOperationException, SdkServiceException, SdkClientException, ShieldException
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
listAttacksRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.InvalidParameterException
- Exception that indicates that the parameters passed to the API are invalid.InvalidOperationException
- Exception that indicates that the operation would not cause any change to occur.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListAttacksResponse listAttacks(Consumer<ListAttacksRequest.Builder> listAttacksRequest) throws InternalErrorException, InvalidParameterException, InvalidOperationException, SdkServiceException, SdkClientException, ShieldException
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
listAttacksRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.InvalidParameterException
- Exception that indicates that the parameters passed to the API are invalid.InvalidOperationException
- Exception that indicates that the operation would not cause any change to occur.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ShieldException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListProtectionsResponse listProtections() throws InternalErrorException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Lists all Protection objects for the account.
InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.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.SdkServiceException
listProtections(ListProtectionsRequest)
,
AWS API
Documentationdefault ListProtectionsResponse listProtections(ListProtectionsRequest listProtectionsRequest) throws InternalErrorException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Lists all Protection objects for the account.
listProtectionsRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.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.SdkServiceException
default ListProtectionsResponse listProtections(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest) throws InternalErrorException, ResourceNotFoundException, SdkServiceException, SdkClientException, ShieldException
Lists all Protection objects for the account.
listProtectionsRequest
- InternalErrorException
- Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ResourceNotFoundException
- Exception indicating the specified resource does not exist.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.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.