com.amazonaws.services.shield

Class AWSShieldClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.shield.AWSShieldClient

All Implemented Interfaces:

AWSShield

Direct Known Subclasses:

AWSShieldAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSShieldClient
extends AmazonWebServiceClient
implements AWSShield

Client for accessing AWS Shield. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.shield.AWSShield

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSShieldClient() Deprecated. use AWSShieldClientBuilder.defaultClient()
AWSShieldClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSShieldClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSShieldClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSShieldClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AWSShieldClientBuilder	builder()
CreateProtectionResult	createProtection(CreateProtectionRequest request) Enables AWS Shield Advanced for a specific AWS resource.
CreateSubscriptionResult	createSubscription(CreateSubscriptionRequest request) Activates AWS Shield Advanced for an account.
DeleteProtectionResult	deleteProtection(DeleteProtectionRequest request) Deletes an AWS Shield Advanced Protection.
DeleteSubscriptionResult	deleteSubscription(DeleteSubscriptionRequest request) Removes AWS Shield Advanced from an account.
DescribeAttackResult	describeAttack(DescribeAttackRequest request) Describes the details of a DDoS attack.
DescribeProtectionResult	describeProtection(DescribeProtectionRequest request) Lists the details of a Protection object.
DescribeSubscriptionResult	describeSubscription(DescribeSubscriptionRequest request) Provides details about the AWS Shield Advanced subscription for an account.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetSubscriptionStateResult	getSubscriptionState(GetSubscriptionStateRequest request) Returns the SubscriptionState, either Active or Inactive.
ListAttacksResult	listAttacks(ListAttacksRequest request) Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
ListProtectionsResult	listProtections(ListProtectionsRequest request) Lists all Protection objects for the account.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.shield.AWSShield

setEndpoint, setRegion, shutdown

Constructor Detail

AWSShieldClient

@Deprecated
public AWSShieldClient()

Deprecated. use AWSShieldClientBuilder.defaultClient()

Constructs a new client to invoke service methods on AWS Shield. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSShieldClient

@Deprecated
public AWSShieldClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS Shield. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS Shield (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSShieldClient

@Deprecated
public AWSShieldClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSShieldClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on AWS Shield using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSShieldClient

@Deprecated
public AWSShieldClient(AWSCredentials awsCredentials,
                                   ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS Shield using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Shield (ex: proxy settings, retry counts, etc.).

AWSShieldClient

@Deprecated
public AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on AWS Shield using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSShieldClient

@Deprecated
public AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS Shield using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Shield (ex: proxy settings, retry counts, etc.).

AWSShieldClient

@Deprecated
public AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration,
                                   RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on AWS Shield using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Shield (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AWSShieldClientBuilder builder()

createProtection

public CreateProtectionResult createProtection(CreateProtectionRequest request)

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

Specified by:

createProtection in interface AWSShield

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.

Type is the type of limit that would be exceeded.

Limit is the threshold that would be exceeded.

ResourceAlreadyExistsException - Exception indicating the specified resource already exists.

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

ResourceNotFoundException - Exception indicating the specified resource does not exist.

See Also:

AWS API Documentation

createSubscription

public CreateSubscriptionResult createSubscription(CreateSubscriptionRequest request)

Activates AWS Shield Advanced for an account.

Specified by:

createSubscription in interface AWSShield

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.

See Also:

AWS API Documentation

deleteProtection

public DeleteProtectionResult deleteProtection(DeleteProtectionRequest request)

Deletes an AWS Shield Advanced Protection.

Specified by:

deleteProtection in interface AWSShield

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.

See Also:

AWS API Documentation

deleteSubscription

public DeleteSubscriptionResult deleteSubscription(DeleteSubscriptionRequest request)

Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

Specified by:

deleteSubscription in interface AWSShield

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 you are trying to delete has not yet completed the 1-year commitment. You cannot delete this subscription.

ResourceNotFoundException - Exception indicating the specified resource does not exist.

See Also:

AWS API Documentation

describeAttack

public DescribeAttackResult describeAttack(DescribeAttackRequest request)

Describes the details of a DDoS attack.

Specified by:

describeAttack in interface AWSShield

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.

See Also:

AWS API Documentation

describeProtection

public DescribeProtectionResult describeProtection(DescribeProtectionRequest request)

Lists the details of a Protection object.

Specified by:

describeProtection in interface AWSShield

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.

See Also:

AWS API Documentation

describeSubscription

public DescribeSubscriptionResult describeSubscription(DescribeSubscriptionRequest request)

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

Specified by:

describeSubscription in interface AWSShield

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.

See Also:

AWS API Documentation

getSubscriptionState

public GetSubscriptionStateResult getSubscriptionState(GetSubscriptionStateRequest request)

Returns the SubscriptionState, either Active or Inactive.

Specified by:

getSubscriptionState in interface AWSShield

Parameters:

getSubscriptionStateRequest -

Returns:

Result of the GetSubscriptionState operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

listAttacks

public ListAttacksResult listAttacks(ListAttacksRequest request)

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

Specified by:

listAttacks in interface AWSShield

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.

See Also:

AWS API Documentation

listProtections

public ListProtectionsResult listProtections(ListProtectionsRequest request)

Lists all Protection objects for the account.

Specified by:

listProtections in interface AWSShield

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSShield

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.