com.amazonaws.services.shield

Interface AWSShield

All Known Subinterfaces:

AWSShieldAsync

All Known Implementing Classes:

AbstractAWSShield, AbstractAWSShieldAsync, AWSShieldAsyncClient, AWSShieldClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSShield

Interface for accessing AWS Shield.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSShield instead.

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateProtectionResult	createProtection(CreateProtectionRequest createProtectionRequest) Enables AWS Shield Advanced for a specific AWS resource.
CreateSubscriptionResult	createSubscription(CreateSubscriptionRequest createSubscriptionRequest) Activates AWS Shield Advanced for an account.
DeleteProtectionResult	deleteProtection(DeleteProtectionRequest deleteProtectionRequest) Deletes an AWS Shield Advanced Protection.
DeleteSubscriptionResult	deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest) Removes AWS Shield Advanced from an account.
DescribeAttackResult	describeAttack(DescribeAttackRequest describeAttackRequest) Describes the details of a DDoS attack.
DescribeProtectionResult	describeProtection(DescribeProtectionRequest describeProtectionRequest) Lists the details of a Protection object.
DescribeSubscriptionResult	describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest) 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.
ListAttacksResult	listAttacks(ListAttacksRequest listAttacksRequest) Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
ListProtectionsResult	listProtections(ListProtectionsRequest listProtectionsRequest) Lists all Protection objects for the account.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("shield.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "shield.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "shield.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "shield.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "shield.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

createProtection

CreateProtectionResult 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:

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.

See Also:

AWS API Documentation

createSubscription

CreateSubscriptionResult createSubscription(CreateSubscriptionRequest createSubscriptionRequest)

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.

See Also:

AWS API Documentation

deleteProtection

DeleteProtectionResult deleteProtection(DeleteProtectionRequest deleteProtectionRequest)

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.

See Also:

AWS API Documentation

deleteSubscription

DeleteSubscriptionResult deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest)

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.

See Also:

AWS API Documentation

describeAttack

DescribeAttackResult describeAttack(DescribeAttackRequest describeAttackRequest)

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.

See Also:

AWS API Documentation

describeProtection

DescribeProtectionResult describeProtection(DescribeProtectionRequest describeProtectionRequest)

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.

See Also:

AWS API Documentation

describeSubscription

DescribeSubscriptionResult describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest)

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.

See Also:

AWS API Documentation

listAttacks

ListAttacksResult listAttacks(ListAttacksRequest listAttacksRequest)

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.

See Also:

AWS API Documentation

listProtections

ListProtectionsResult listProtections(ListProtectionsRequest listProtectionsRequest)

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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