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
AssociateDRTLogBucketResult	associateDRTLogBucket(AssociateDRTLogBucketRequest associateDRTLogBucketRequest) Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow logs.
AssociateDRTRoleResult	associateDRTRole(AssociateDRTRoleRequest associateDRTRoleRequest) Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks.
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) Deprecated.
DescribeAttackResult	describeAttack(DescribeAttackRequest describeAttackRequest) Describes the details of a DDoS attack.
DescribeDRTAccessResult	describeDRTAccess(DescribeDRTAccessRequest describeDRTAccessRequest) Returns the current role and list of Amazon S3 log buckets used by the DDoS Response team (DRT) to access your AWS account while assisting with attack mitigation.
DescribeEmergencyContactSettingsResult	describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest) Lists the email addresses that the DRT can use to contact you during a suspected 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.
DisassociateDRTLogBucketResult	disassociateDRTLogBucket(DisassociateDRTLogBucketRequest disassociateDRTLogBucketRequest) Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs.
DisassociateDRTRoleResult	disassociateDRTRole(DisassociateDRTRoleRequest disassociateDRTRoleRequest) Removes the DDoS Response team's (DRT) access to your AWS 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 getSubscriptionStateRequest) Returns the SubscriptionState, either Active or Inactive.
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.
UpdateEmergencyContactSettingsResult	updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest) Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.
UpdateSubscriptionResult	updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest) Updates the details of an existing subscription.

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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

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)

associateDRTLogBucket

AssociateDRTLogBucketResult associateDRTLogBucket(AssociateDRTLogBucketRequest associateDRTLogBucketRequest)

Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow logs. You can associate up to 10 Amazon S3 buckets with your subscription.

To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

Parameters:

associateDRTLogBucketRequest -

Returns:

Result of the AssociateDRTLogBucket operation returned by the service.

Throws:

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

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

NoAssociatedRoleException - The ARN of the role that you specifed does not exist.

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.

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

AccessDeniedForDependencyException - In order to grant the necessary access to the DDoS Response Team, the user submitting AssociateDRTRole must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.

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

associateDRTRole

AssociateDRTRoleResult associateDRTRole(AssociateDRTRoleRequest associateDRTRoleRequest)

Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.

You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com . For more information, see IAM JSON Policy Elements: Principal.

The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you.

You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.

To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

Parameters:

associateDRTRoleRequest -

Returns:

Result of the AssociateDRTRole operation returned by the service.

Throws:

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

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

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

AccessDeniedForDependencyException - In order to grant the necessary access to the DDoS Response Team, the user submitting AssociateDRTRole must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.

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

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, Elastic IP Address, or an Amazon Route 53 hosted zone.

You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.

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

CreateSubscriptionResult createSubscription(CreateSubscriptionRequest createSubscriptionRequest)

Activates AWS Shield Advanced for an account.

As part of this request you can specify EmergencySettings that automaticaly grant the DDoS response team (DRT) needed permissions to assist you during a suspected DDoS attack. For more information see Authorize the DDoS Response Team to Create Rules and Web ACLs on Your Behalf.

When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.

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

@Deprecated
DeleteSubscriptionResult deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest)

Deprecated.

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.

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 - You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.

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

describeDRTAccess

DescribeDRTAccessResult describeDRTAccess(DescribeDRTAccessRequest describeDRTAccessRequest)

Returns the current role and list of Amazon S3 log buckets used by the DDoS Response team (DRT) to access your AWS account while assisting with attack mitigation.

Parameters:

describeDRTAccessRequest -

Returns:

Result of the DescribeDRTAccess 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

describeEmergencyContactSettings

DescribeEmergencyContactSettingsResult describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest)

Lists the email addresses that the DRT can use to contact you during a suspected attack.

Parameters:

describeEmergencyContactSettingsRequest -

Returns:

Result of the DescribeEmergencyContactSettings 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

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

disassociateDRTLogBucket

DisassociateDRTLogBucketResult disassociateDRTLogBucket(DisassociateDRTLogBucketRequest disassociateDRTLogBucketRequest)

Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs.

To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.

Parameters:

disassociateDRTLogBucketRequest -

Returns:

Result of the DisassociateDRTLogBucket operation returned by the service.

Throws:

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

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

NoAssociatedRoleException - The ARN of the role that you specifed does not exist.

AccessDeniedForDependencyException - In order to grant the necessary access to the DDoS Response Team, the user submitting AssociateDRTRole must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.

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

disassociateDRTRole

DisassociateDRTRoleResult disassociateDRTRole(DisassociateDRTRoleRequest disassociateDRTRoleRequest)

Removes the DDoS Response team's (DRT) access to your AWS account.

To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.

Parameters:

disassociateDRTRoleRequest -

Returns:

Result of the DisassociateDRTRole operation returned by the service.

Throws:

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

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

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

getSubscriptionState

GetSubscriptionStateResult getSubscriptionState(GetSubscriptionStateRequest getSubscriptionStateRequest)

Returns the SubscriptionState, either Active or Inactive.

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

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.

InvalidPaginationTokenException - Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the response.

See Also:

AWS API Documentation

updateEmergencyContactSettings

UpdateEmergencyContactSettingsResult updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest)

Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.

Parameters:

updateEmergencyContactSettingsRequest -

Returns:

Result of the UpdateEmergencyContactSettings 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.

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

updateSubscription

UpdateSubscriptionResult updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest)

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

Parameters:

updateSubscriptionRequest -

Returns:

Result of the UpdateSubscription operation returned by the service.

Throws:

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

LockedSubscriptionException - You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.

ResourceNotFoundException - Exception indicating the specified resource does not exist.

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

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

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.