@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSShieldClient extends AmazonWebServiceClient implements AWSShield
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSShieldClient()
Deprecated.
|
AWSShieldClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSShieldClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSShieldClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSShieldClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateDRTLogBucketResult |
associateDRTLogBucket(AssociateDRTLogBucketRequest request)
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 request)
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 request)
Adds health-based detection to the Shield Advanced protection for a resource.
|
AssociateProactiveEngagementDetailsResult |
associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest request)
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use.
|
static AWSShieldClientBuilder |
builder() |
CreateProtectionResult |
createProtection(CreateProtectionRequest request)
Enables Shield Advanced for a specific Amazon Web Services resource.
|
CreateProtectionGroupResult |
createProtectionGroup(CreateProtectionGroupRequest request)
Creates a grouping of protected resources so they can be handled as a collective.
|
CreateSubscriptionResult |
createSubscription(CreateSubscriptionRequest request)
Activates Shield Advanced for an account.
|
DeleteProtectionResult |
deleteProtection(DeleteProtectionRequest request)
Deletes an Shield Advanced Protection.
|
DeleteProtectionGroupResult |
deleteProtectionGroup(DeleteProtectionGroupRequest request)
Removes the specified protection group.
|
DeleteSubscriptionResult |
deleteSubscription(DeleteSubscriptionRequest request)
Deprecated.
|
DescribeAttackResult |
describeAttack(DescribeAttackRequest request)
Describes the details of a DDoS attack.
|
DescribeAttackStatisticsResult |
describeAttackStatistics(DescribeAttackStatisticsRequest request)
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 request)
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 request)
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 request)
Lists the details of a Protection object.
|
DescribeProtectionGroupResult |
describeProtectionGroup(DescribeProtectionGroupRequest request)
Returns the specification for the specified protection group.
|
DescribeSubscriptionResult |
describeSubscription(DescribeSubscriptionRequest request)
Provides details about the Shield Advanced subscription for an account.
|
DisableApplicationLayerAutomaticResponseResult |
disableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest request)
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource.
|
DisableProactiveEngagementResult |
disableProactiveEngagement(DisableProactiveEngagementRequest request)
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 request)
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you
shared previously.
|
DisassociateDRTRoleResult |
disassociateDRTRole(DisassociateDRTRoleRequest request)
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
|
DisassociateHealthCheckResult |
disassociateHealthCheck(DisassociateHealthCheckRequest request)
Removes health-based detection from the Shield Advanced protection for a resource.
|
EnableApplicationLayerAutomaticResponseResult |
enableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest request)
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
|
EnableProactiveEngagementResult |
enableProactiveEngagement(EnableProactiveEngagementRequest request)
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 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.
|
ListProtectionGroupsResult |
listProtectionGroups(ListProtectionGroupsRequest request)
Retrieves ProtectionGroup objects for the account.
|
ListProtectionsResult |
listProtections(ListProtectionsRequest request)
Retrieves Protection objects for the account.
|
ListResourcesInProtectionGroupResult |
listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest request)
Retrieves the resources that are included in the protection group.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds or updates tags for a resource in Shield.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a resource in Shield.
|
UpdateApplicationLayerAutomaticResponseResult |
updateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest request)
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified
resource.
|
UpdateEmergencyContactSettingsResult |
updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest request)
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 request)
Updates an existing protection group.
|
UpdateSubscriptionResult |
updateSubscription(UpdateSubscriptionRequest request)
Updates the details of an existing subscription.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AWSShieldClient()
AWSShieldClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSShieldClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to AWS Shield (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSShieldClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSShieldClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSShieldClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AWSShieldClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic static AWSShieldClientBuilder builder()
public AssociateDRTLogBucketResult associateDRTLogBucket(AssociateDRTLogBucketRequest request)
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.
associateDRTLogBucket in interface AWSShieldassociateDRTLogBucketRequest - 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 specified 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.public AssociateDRTRoleResult associateDRTRole(AssociateDRTRoleRequest request)
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 that you'll specify in the request. You can
access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and
removing IAM identity permissions. 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.
associateDRTRole in interface AWSShieldassociateDRTRoleRequest - 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.public AssociateHealthCheckResult associateHealthCheck(AssociateHealthCheckRequest request)
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 response.
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.
associateHealthCheck in interface AWSShieldassociateHealthCheckRequest - 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.InvalidResourceException - Exception that indicates that the resource is invalid. You might not have access to the resource, or the
resource might not exist.public AssociateProactiveEngagementDetailsResult associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest request)
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.
associateProactiveEngagementDetails in interface AWSShieldassociateProactiveEngagementDetailsRequest - 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.public CreateProtectionResult createProtection(CreateProtectionRequest request)
Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
You can add protection to only a single resource with each CreateProtection request. You can add
protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For
more information see Getting Started with
Shield Advanced and Adding Shield Advanced
protection to Amazon Web Services resources.
createProtection in interface AWSShieldcreateProtectionRequest - 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.public CreateProtectionGroupResult createProtectionGroup(CreateProtectionGroupRequest request)
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.
createProtectionGroup in interface AWSShieldcreateProtectionGroupRequest - 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.public CreateSubscriptionResult createSubscription(CreateSubscriptionRequest request)
Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially 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.
createSubscription in interface AWSShieldcreateSubscriptionRequest - 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.public DeleteProtectionResult deleteProtection(DeleteProtectionRequest request)
Deletes an Shield Advanced Protection.
deleteProtection in interface AWSShielddeleteProtectionRequest - 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.public DeleteProtectionGroupResult deleteProtectionGroup(DeleteProtectionGroupRequest request)
Removes the specified protection group.
deleteProtectionGroup in interface AWSShielddeleteProtectionGroupRequest - 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.@Deprecated public DeleteSubscriptionResult deleteSubscription(DeleteSubscriptionRequest request)
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.
deleteSubscription in interface AWSShielddeleteSubscriptionRequest - 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.public DescribeAttackResult describeAttack(DescribeAttackRequest request)
Describes the details of a DDoS attack.
describeAttack in interface AWSShielddescribeAttackRequest - 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.public DescribeAttackStatisticsResult describeAttackStatistics(DescribeAttackStatisticsRequest request)
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.
describeAttackStatistics in interface AWSShielddescribeAttackStatisticsRequest - InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.public DescribeDRTAccessResult describeDRTAccess(DescribeDRTAccessRequest request)
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.
describeDRTAccess in interface AWSShielddescribeDRTAccessRequest - 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.public DescribeEmergencyContactSettingsResult describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest request)
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.
describeEmergencyContactSettings in interface AWSShielddescribeEmergencyContactSettingsRequest - 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.public DescribeProtectionResult describeProtection(DescribeProtectionRequest request)
Lists the details of a Protection object.
describeProtection in interface AWSShielddescribeProtectionRequest - 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.public DescribeProtectionGroupResult describeProtectionGroup(DescribeProtectionGroupRequest request)
Returns the specification for the specified protection group.
describeProtectionGroup in interface AWSShielddescribeProtectionGroupRequest - 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.public DescribeSubscriptionResult describeSubscription(DescribeSubscriptionRequest request)
Provides details about the Shield Advanced subscription for an account.
describeSubscription in interface AWSShielddescribeSubscriptionRequest - 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.public DisableApplicationLayerAutomaticResponseResult disableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest request)
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.
disableApplicationLayerAutomaticResponse in interface AWSShielddisableApplicationLayerAutomaticResponseRequest - 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.InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.public DisableProactiveEngagementResult disableProactiveEngagement(DisableProactiveEngagementRequest request)
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
disableProactiveEngagement in interface AWSShielddisableProactiveEngagementRequest - 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.public DisassociateDRTLogBucketResult disassociateDRTLogBucket(DisassociateDRTLogBucketRequest request)
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
disassociateDRTLogBucket in interface AWSShielddisassociateDRTLogBucketRequest - 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 specified 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.public DisassociateDRTRoleResult disassociateDRTRole(DisassociateDRTRoleRequest request)
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
disassociateDRTRole in interface AWSShielddisassociateDRTRoleRequest - 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.public DisassociateHealthCheckResult disassociateHealthCheck(DisassociateHealthCheckRequest request)
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 response.
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.
disassociateHealthCheck in interface AWSShielddisassociateHealthCheckRequest - 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.InvalidResourceException - Exception that indicates that the resource is invalid. You might not have access to the resource, or the
resource might not exist.public EnableApplicationLayerAutomaticResponseResult enableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest request)
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
This feature is available for Amazon CloudFront distributions and Application Load Balancers only.
This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation.
Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.
To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide.
enableApplicationLayerAutomaticResponse in interface AWSShieldenableApplicationLayerAutomaticResponseRequest - LimitsExceededException - Exception that indicates that the operation would exceed a limit.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.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.InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.public EnableProactiveEngagementResult enableProactiveEngagement(EnableProactiveEngagementRequest request)
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.
enableProactiveEngagement in interface AWSShieldenableProactiveEngagementRequest - 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.public GetSubscriptionStateResult getSubscriptionState(GetSubscriptionStateRequest request)
Returns the SubscriptionState, either Active or Inactive.
getSubscriptionState in interface AWSShieldgetSubscriptionStateRequest - InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.public ListAttacksResult listAttacks(ListAttacksRequest request)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
listAttacks in interface AWSShieldlistAttacksRequest - 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.public ListProtectionGroupsResult listProtectionGroups(ListProtectionGroupsRequest request)
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
listProtectionGroups in interface AWSShieldlistProtectionGroupsRequest - 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 prior response.public ListProtectionsResult listProtections(ListProtectionsRequest request)
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
listProtections in interface AWSShieldlistProtectionsRequest - 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 prior response.public ListResourcesInProtectionGroupResult listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest request)
Retrieves the resources that are included in the protection group.
listResourcesInProtectionGroup in interface AWSShieldlistResourcesInProtectionGroupRequest - 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 prior response.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
listTagsForResource in interface AWSShieldlistTagsForResourceRequest - 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.public TagResourceResult tagResource(TagResourceRequest request)
Adds or updates tags for a resource in Shield.
tagResource in interface AWSShieldtagResourceRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a resource in Shield.
untagResource in interface AWSShielduntagResourceRequest - 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.public UpdateApplicationLayerAutomaticResponseResult updateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest request)
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
updateApplicationLayerAutomaticResponse in interface AWSShieldupdateApplicationLayerAutomaticResponseRequest - 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.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.InvalidOperationException - Exception that indicates that the operation would not cause any change to occur.public UpdateEmergencyContactSettingsResult updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest request)
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.
updateEmergencyContactSettings in interface AWSShieldupdateEmergencyContactSettingsRequest - 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.public UpdateProtectionGroupResult updateProtectionGroup(UpdateProtectionGroupRequest request)
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.
updateProtectionGroup in interface AWSShieldupdateProtectionGroupRequest - 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.public UpdateSubscriptionResult updateSubscription(UpdateSubscriptionRequest request)
Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
updateSubscription in interface AWSShieldupdateSubscriptionRequest - 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AWSShieldrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSShieldshutdown in class AmazonWebServiceClient