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.

Shield Advanced

This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and 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 Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources.
AssociateDRTRoleResult	associateDRTRole(AssociateDRTRoleRequest associateDRTRoleRequest) Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks.
AssociateHealthCheckResult	associateHealthCheck(AssociateHealthCheckRequest associateHealthCheckRequest) Adds health-based detection to the Shield Advanced protection for a resource.
AssociateProactiveEngagementDetailsResult	associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest associateProactiveEngagementDetailsRequest) Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use.
CreateProtectionResult	createProtection(CreateProtectionRequest createProtectionRequest) Enables Shield Advanced for a specific Amazon Web Services resource.
CreateProtectionGroupResult	createProtectionGroup(CreateProtectionGroupRequest createProtectionGroupRequest) Creates a grouping of protected resources so they can be handled as a collective.
CreateSubscriptionResult	createSubscription(CreateSubscriptionRequest createSubscriptionRequest) Activates Shield Advanced for an account.
DeleteProtectionResult	deleteProtection(DeleteProtectionRequest deleteProtectionRequest) Deletes an Shield Advanced Protection.
DeleteProtectionGroupResult	deleteProtectionGroup(DeleteProtectionGroupRequest deleteProtectionGroupRequest) Removes the specified protection group.
DeleteSubscriptionResult	deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest) Deprecated.
DescribeAttackResult	describeAttack(DescribeAttackRequest describeAttackRequest) Describes the details of a DDoS attack.
DescribeAttackStatisticsResult	describeAttackStatistics(DescribeAttackStatisticsRequest describeAttackStatisticsRequest) Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them.
DescribeDRTAccessResult	describeDRTAccess(DescribeDRTAccessRequest describeDRTAccessRequest) Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.
DescribeEmergencyContactSettingsResult	describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest) A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
DescribeProtectionResult	describeProtection(DescribeProtectionRequest describeProtectionRequest) Lists the details of a Protection object.
DescribeProtectionGroupResult	describeProtectionGroup(DescribeProtectionGroupRequest describeProtectionGroupRequest) Returns the specification for the specified protection group.
DescribeSubscriptionResult	describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest) Provides details about the Shield Advanced subscription for an account.
DisableProactiveEngagementResult	disableProactiveEngagement(DisableProactiveEngagementRequest disableProactiveEngagementRequest) Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
DisassociateDRTLogBucketResult	disassociateDRTLogBucket(DisassociateDRTLogBucketRequest disassociateDRTLogBucketRequest) Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
DisassociateDRTRoleResult	disassociateDRTRole(DisassociateDRTRoleRequest disassociateDRTRoleRequest) Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
DisassociateHealthCheckResult	disassociateHealthCheck(DisassociateHealthCheckRequest disassociateHealthCheckRequest) Removes health-based detection from the Shield Advanced protection for a resource.
EnableProactiveEngagementResult	enableProactiveEngagement(EnableProactiveEngagementRequest enableProactiveEngagementRequest) Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
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.
ListProtectionGroupsResult	listProtectionGroups(ListProtectionGroupsRequest listProtectionGroupsRequest) Retrieves the ProtectionGroup objects for the account.
ListProtectionsResult	listProtections(ListProtectionsRequest listProtectionsRequest) Lists all Protection objects for the account.
ListResourcesInProtectionGroupResult	listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest) Retrieves the resources that are included in the protection group.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
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.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds or updates tags for a resource in Shield.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a resource in Shield.
UpdateEmergencyContactSettingsResult	updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest) Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
UpdateProtectionGroupResult	updateProtectionGroup(UpdateProtectionGroupRequest updateProtectionGroupRequest) Updates an existing protection group.
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 Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.

To use the services of the SRT 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.

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

AccessDeniedForDependencyException - In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request 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 Amazon Web Services Service.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

associateDRTRole

AssociateDRTRoleResult associateDRTRole(AssociateDRTRoleRequest associateDRTRoleRequest)

Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update 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 SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT 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 Amazon Web Services Service.

To use the services of the SRT 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. If available, this exception includes details in additional properties.

AccessDeniedForDependencyException - In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request 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 Amazon Web Services Service.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

associateHealthCheck

AssociateHealthCheckResult associateHealthCheck(AssociateHealthCheckRequest associateHealthCheckRequest)

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and mitigation.

You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.

Parameters:

associateHealthCheckRequest -

Returns:

Result of the AssociateHealthCheck operation returned by the service.

Throws:

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

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

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

See Also:

AWS API Documentation

associateProactiveEngagementDetails

AssociateProactiveEngagementDetailsResult associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest associateProactiveEngagementDetailsRequest)

Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.

After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement.

This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.

The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.

Parameters:

associateProactiveEngagementDetailsRequest -

Returns:

Result of the AssociateProactiveEngagementDetails 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. If available, this exception includes details in additional properties.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

See Also:

AWS API Documentation

createProtection

CreateProtectionResult createProtection(CreateProtectionRequest createProtectionRequest)

Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, Global Accelerator accelerator, 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 WAF console. For more information see Getting Started with Shield Advanced and Add Shield Advanced Protection to more Amazon Web Services 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.

ResourceAlreadyExistsException - Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

createProtectionGroup

CreateProtectionGroupResult createProtectionGroup(CreateProtectionGroupRequest createProtectionGroupRequest)

Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

Parameters:

createProtectionGroupRequest -

Returns:

Result of the CreateProtectionGroup 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. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

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

See Also:

AWS API Documentation

createSubscription

CreateSubscriptionResult createSubscription(CreateSubscriptionRequest createSubscriptionRequest)

Activates Shield Advanced for an account.

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. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

deleteProtection

DeleteProtectionResult deleteProtection(DeleteProtectionRequest deleteProtectionRequest)

Deletes an 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. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

See Also:

AWS API Documentation

deleteProtectionGroup

DeleteProtectionGroupResult deleteProtectionGroup(DeleteProtectionGroupRequest deleteProtectionGroupRequest)

Removes the specified protection group.

Parameters:

deleteProtectionGroupRequest -

Returns:

Result of the DeleteProtectionGroup operation returned by the service.

Throws:

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

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

deleteSubscription

@Deprecated
DeleteSubscriptionResult deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest)

Deprecated.

Removes Shield Advanced from an account. 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. If available, this exception includes details in additional properties.

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.

AccessDeniedException - Exception that indicates the specified AttackId does not exist, or the requester does not have the appropriate permissions to access the AttackId.

See Also:

AWS API Documentation

describeAttackStatistics

DescribeAttackStatisticsResult describeAttackStatistics(DescribeAttackStatisticsRequest describeAttackStatisticsRequest)

Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.

The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is 2020-10-26 15:39:32 PDT, equal to 2020-10-26 22:39:32 UTC, then the time range for the attack data returned is from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC.

The time range indicates the period covered by the attack statistics data items.

Parameters:

describeAttackStatisticsRequest -

Returns:

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

describeDRTAccess

DescribeDRTAccessResult describeDRTAccess(DescribeDRTAccessRequest describeDRTAccessRequest)

Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services 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. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

describeEmergencyContactSettings

DescribeEmergencyContactSettingsResult describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest)

A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

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. If available, this exception includes details in additional properties.

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.

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

describeProtectionGroup

DescribeProtectionGroupResult describeProtectionGroup(DescribeProtectionGroupRequest describeProtectionGroupRequest)

Returns the specification for the specified protection group.

Parameters:

describeProtectionGroupRequest -

Returns:

Result of the DescribeProtectionGroup 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. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

describeSubscription

DescribeSubscriptionResult describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest)

Provides details about the 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. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

disableProactiveEngagement

DisableProactiveEngagementResult disableProactiveEngagement(DisableProactiveEngagementRequest disableProactiveEngagementRequest)

Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.

Parameters:

disableProactiveEngagementRequest -

Returns:

Result of the DisableProactiveEngagement 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. If available, this exception includes details in additional properties.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

See Also:

AWS API Documentation

disassociateDRTLogBucket

DisassociateDRTLogBucketResult disassociateDRTLogBucket(DisassociateDRTLogBucketRequest disassociateDRTLogBucketRequest)

Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.

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 SRT 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 Shield Response Team (SRT) the user submitting the request 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 Amazon Web Services Service.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

disassociateDRTRole

DisassociateDRTRoleResult disassociateDRTRole(DisassociateDRTRoleRequest disassociateDRTRoleRequest)

Removes the Shield Response Team's (SRT) access to your Amazon Web Services 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 SRT 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 resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

disassociateHealthCheck

DisassociateHealthCheckResult disassociateHealthCheck(DisassociateHealthCheckRequest disassociateHealthCheckRequest)

Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and mitigation.

You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.

Parameters:

disassociateHealthCheckRequest -

Returns:

Result of the DisassociateHealthCheck 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. If available, this exception includes details in additional properties.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

See Also:

AWS API Documentation

enableProactiveEngagement

EnableProactiveEngagementResult enableProactiveEngagement(EnableProactiveEngagementRequest enableProactiveEngagementRequest)

Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

Parameters:

enableProactiveEngagementRequest -

Returns:

Result of the EnableProactiveEngagement 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. If available, this exception includes details in additional properties.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

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. If available, this exception includes details in additional properties.

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

See Also:

AWS API Documentation

listProtectionGroups

ListProtectionGroupsResult listProtectionGroups(ListProtectionGroupsRequest listProtectionGroupsRequest)

Retrieves the ProtectionGroup objects for the account.

Parameters:

listProtectionGroupsRequest -

Returns:

Result of the ListProtectionGroups 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. If available, this exception includes details in additional properties.

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

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. If available, this exception includes details in additional properties.

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

listResourcesInProtectionGroup

ListResourcesInProtectionGroupResult listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest)

Retrieves the resources that are included in the protection group.

Parameters:

listResourcesInProtectionGroupRequest -

Returns:

Result of the ListResourcesInProtectionGroup 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. If available, this exception includes details in additional properties.

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

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.

Parameters:

listTagsForResourceRequest -

Returns:

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

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds or updates tags for a resource in Shield.

Parameters:

tagResourceRequest -

Returns:

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

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from a resource in Shield.

Parameters:

untagResourceRequest -

Returns:

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

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

updateEmergencyContactSettings

UpdateEmergencyContactSettingsResult updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest)

Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

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. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException - Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

See Also:

AWS API Documentation

updateProtectionGroup

UpdateProtectionGroupResult updateProtectionGroup(UpdateProtectionGroupRequest updateProtectionGroupRequest)

Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

Parameters:

updateProtectionGroupRequest -

Returns:

Result of the UpdateProtectionGroup 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. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

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. If available, this exception includes details in additional properties.

InvalidParameterException - Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

OptimisticLockException - Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your 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.