@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSShield
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSShield instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| 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.
|
DisableApplicationLayerAutomaticResponseResult |
disableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest disableApplicationLayerAutomaticResponseRequest)
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource.
|
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.
|
EnableApplicationLayerAutomaticResponseResult |
enableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest enableApplicationLayerAutomaticResponseRequest)
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected 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 ProtectionGroup objects for the account.
|
ListProtectionsResult |
listProtections(ListProtectionsRequest listProtectionsRequest)
Retrieves 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.
|
UpdateApplicationLayerAutomaticResponseResult |
updateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest updateApplicationLayerAutomaticResponseRequest)
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified
resource.
|
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.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)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.
associateDRTLogBucketRequest - 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.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 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.
associateDRTRoleRequest - 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.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 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.
associateHealthCheckRequest - 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.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.
associateProactiveEngagementDetailsRequest - 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.CreateProtectionResult createProtection(CreateProtectionRequest createProtectionRequest)
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.
createProtectionRequest - 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.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.
createProtectionGroupRequest - 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.CreateSubscriptionResult createSubscription(CreateSubscriptionRequest createSubscriptionRequest)
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.
createSubscriptionRequest - 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.DeleteProtectionResult deleteProtection(DeleteProtectionRequest deleteProtectionRequest)
Deletes an Shield Advanced Protection.
deleteProtectionRequest - 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.DeleteProtectionGroupResult deleteProtectionGroup(DeleteProtectionGroupRequest deleteProtectionGroupRequest)
Removes the specified protection group.
deleteProtectionGroupRequest - 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 DeleteSubscriptionResult deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest)
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.
deleteSubscriptionRequest - 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.DescribeAttackResult describeAttack(DescribeAttackRequest describeAttackRequest)
Describes the details of a DDoS attack.
describeAttackRequest - 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.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.
describeAttackStatisticsRequest - InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.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.
describeDRTAccessRequest - 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.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.
describeEmergencyContactSettingsRequest - 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.DescribeProtectionResult describeProtection(DescribeProtectionRequest describeProtectionRequest)
Lists the details of a Protection object.
describeProtectionRequest - 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.DescribeProtectionGroupResult describeProtectionGroup(DescribeProtectionGroupRequest describeProtectionGroupRequest)
Returns the specification for the specified protection group.
describeProtectionGroupRequest - 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.DescribeSubscriptionResult describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest)
Provides details about the Shield Advanced subscription for an account.
describeSubscriptionRequest - 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.DisableApplicationLayerAutomaticResponseResult disableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest disableApplicationLayerAutomaticResponseRequest)
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.
disableApplicationLayerAutomaticResponseRequest - 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.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.
disableProactiveEngagementRequest - 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.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.
disassociateDRTLogBucketRequest - 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.DisassociateDRTRoleResult disassociateDRTRole(DisassociateDRTRoleRequest disassociateDRTRoleRequest)
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
disassociateDRTRoleRequest - 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.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 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.
disassociateHealthCheckRequest - 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.EnableApplicationLayerAutomaticResponseResult enableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest enableApplicationLayerAutomaticResponseRequest)
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.
enableApplicationLayerAutomaticResponseRequest - 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.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.
enableProactiveEngagementRequest - 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.GetSubscriptionStateResult getSubscriptionState(GetSubscriptionStateRequest getSubscriptionStateRequest)
Returns the SubscriptionState, either Active or Inactive.
getSubscriptionStateRequest - InternalErrorException - Exception that indicates that a problem occurred with the service infrastructure. You can retry the
request.ListAttacksResult listAttacks(ListAttacksRequest listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
listAttacksRequest - 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.ListProtectionGroupsResult listProtectionGroups(ListProtectionGroupsRequest listProtectionGroupsRequest)
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.
listProtectionGroupsRequest - 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.ListProtectionsResult listProtections(ListProtectionsRequest listProtectionsRequest)
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.
listProtectionsRequest - 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.ListResourcesInProtectionGroupResult listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest)
Retrieves the resources that are included in the protection group.
listResourcesInProtectionGroupRequest - 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
listTagsForResourceRequest - 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for a resource in Shield.
tagResourceRequest - 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource in Shield.
untagResourceRequest - 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.UpdateApplicationLayerAutomaticResponseResult updateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest updateApplicationLayerAutomaticResponseRequest)
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
updateApplicationLayerAutomaticResponseRequest - 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.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.
updateEmergencyContactSettingsRequest - 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.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.
updateProtectionGroupRequest - 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.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.
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.
updateSubscriptionRequest - 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.void shutdown()
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 a request.
request - The originally executed request.Copyright © 2023. All rights reserved.