Interface ShieldClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and Shield Developer Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AssociateDrtLogBucketResponse
associateDRTLogBucket
(Consumer<AssociateDrtLogBucketRequest.Builder> 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.default AssociateDrtLogBucketResponse
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.default AssociateDrtRoleResponse
associateDRTRole
(Consumer<AssociateDrtRoleRequest.Builder> 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.default AssociateDrtRoleResponse
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.default AssociateHealthCheckResponse
associateHealthCheck
(Consumer<AssociateHealthCheckRequest.Builder> associateHealthCheckRequest) Adds health-based detection to the Shield Advanced protection for a resource.default AssociateHealthCheckResponse
associateHealthCheck
(AssociateHealthCheckRequest associateHealthCheckRequest) Adds health-based detection to the Shield Advanced protection for a resource.associateProactiveEngagementDetails
(Consumer<AssociateProactiveEngagementDetailsRequest.Builder> associateProactiveEngagementDetailsRequest) Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use.associateProactiveEngagementDetails
(AssociateProactiveEngagementDetailsRequest associateProactiveEngagementDetailsRequest) Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use.static ShieldClientBuilder
builder()
Create a builder that can be used to configure and create aShieldClient
.static ShieldClient
create()
Create aShieldClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateProtectionResponse
createProtection
(Consumer<CreateProtectionRequest.Builder> createProtectionRequest) Enables Shield Advanced for a specific Amazon Web Services resource.default CreateProtectionResponse
createProtection
(CreateProtectionRequest createProtectionRequest) Enables Shield Advanced for a specific Amazon Web Services resource.default CreateProtectionGroupResponse
createProtectionGroup
(Consumer<CreateProtectionGroupRequest.Builder> createProtectionGroupRequest) Creates a grouping of protected resources so they can be handled as a collective.default CreateProtectionGroupResponse
createProtectionGroup
(CreateProtectionGroupRequest createProtectionGroupRequest) Creates a grouping of protected resources so they can be handled as a collective.default CreateSubscriptionResponse
Activates Shield Advanced for an account.default CreateSubscriptionResponse
createSubscription
(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) Activates Shield Advanced for an account.default CreateSubscriptionResponse
createSubscription
(CreateSubscriptionRequest createSubscriptionRequest) Activates Shield Advanced for an account.default DeleteProtectionResponse
deleteProtection
(Consumer<DeleteProtectionRequest.Builder> deleteProtectionRequest) Deletes an Shield Advanced Protection.default DeleteProtectionResponse
deleteProtection
(DeleteProtectionRequest deleteProtectionRequest) Deletes an Shield Advanced Protection.default DeleteProtectionGroupResponse
deleteProtectionGroup
(Consumer<DeleteProtectionGroupRequest.Builder> deleteProtectionGroupRequest) Removes the specified protection group.default DeleteProtectionGroupResponse
deleteProtectionGroup
(DeleteProtectionGroupRequest deleteProtectionGroupRequest) Removes the specified protection group.default DescribeAttackResponse
describeAttack
(Consumer<DescribeAttackRequest.Builder> describeAttackRequest) Describes the details of a DDoS attack.default DescribeAttackResponse
describeAttack
(DescribeAttackRequest describeAttackRequest) Describes the details of a DDoS attack.default DescribeAttackStatisticsResponse
describeAttackStatistics
(Consumer<DescribeAttackStatisticsRequest.Builder> 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.default DescribeAttackStatisticsResponse
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.default DescribeDrtAccessResponse
describeDRTAccess
(Consumer<DescribeDrtAccessRequest.Builder> 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.default DescribeDrtAccessResponse
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.describeEmergencyContactSettings
(Consumer<DescribeEmergencyContactSettingsRequest.Builder> 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.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.default DescribeProtectionResponse
describeProtection
(Consumer<DescribeProtectionRequest.Builder> describeProtectionRequest) Lists the details of a Protection object.default DescribeProtectionResponse
describeProtection
(DescribeProtectionRequest describeProtectionRequest) Lists the details of a Protection object.default DescribeProtectionGroupResponse
describeProtectionGroup
(Consumer<DescribeProtectionGroupRequest.Builder> describeProtectionGroupRequest) Returns the specification for the specified protection group.default DescribeProtectionGroupResponse
describeProtectionGroup
(DescribeProtectionGroupRequest describeProtectionGroupRequest) Returns the specification for the specified protection group.default DescribeSubscriptionResponse
Provides details about the Shield Advanced subscription for an account.default DescribeSubscriptionResponse
describeSubscription
(Consumer<DescribeSubscriptionRequest.Builder> describeSubscriptionRequest) Provides details about the Shield Advanced subscription for an account.default DescribeSubscriptionResponse
describeSubscription
(DescribeSubscriptionRequest describeSubscriptionRequest) Provides details about the Shield Advanced subscription for an account.disableApplicationLayerAutomaticResponse
(Consumer<DisableApplicationLayerAutomaticResponseRequest.Builder> disableApplicationLayerAutomaticResponseRequest) Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource.disableApplicationLayerAutomaticResponse
(DisableApplicationLayerAutomaticResponseRequest disableApplicationLayerAutomaticResponseRequest) Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource.disableProactiveEngagement
(Consumer<DisableProactiveEngagementRequest.Builder> disableProactiveEngagementRequest) Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.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.default DisassociateDrtLogBucketResponse
disassociateDRTLogBucket
(Consumer<DisassociateDrtLogBucketRequest.Builder> disassociateDrtLogBucketRequest) Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.default DisassociateDrtLogBucketResponse
disassociateDRTLogBucket
(DisassociateDrtLogBucketRequest disassociateDrtLogBucketRequest) Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.default DisassociateDrtRoleResponse
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.default DisassociateDrtRoleResponse
disassociateDRTRole
(Consumer<DisassociateDrtRoleRequest.Builder> disassociateDrtRoleRequest) Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.default DisassociateDrtRoleResponse
disassociateDRTRole
(DisassociateDrtRoleRequest disassociateDrtRoleRequest) Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.default DisassociateHealthCheckResponse
disassociateHealthCheck
(Consumer<DisassociateHealthCheckRequest.Builder> disassociateHealthCheckRequest) Removes health-based detection from the Shield Advanced protection for a resource.default DisassociateHealthCheckResponse
disassociateHealthCheck
(DisassociateHealthCheckRequest disassociateHealthCheckRequest) Removes health-based detection from the Shield Advanced protection for a resource.enableApplicationLayerAutomaticResponse
(Consumer<EnableApplicationLayerAutomaticResponseRequest.Builder> enableApplicationLayerAutomaticResponseRequest) Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.enableApplicationLayerAutomaticResponse
(EnableApplicationLayerAutomaticResponseRequest enableApplicationLayerAutomaticResponseRequest) Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.enableProactiveEngagement
(Consumer<EnableProactiveEngagementRequest.Builder> 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.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.default GetSubscriptionStateResponse
Returns theSubscriptionState
, eitherActive
orInactive
.default GetSubscriptionStateResponse
getSubscriptionState
(Consumer<GetSubscriptionStateRequest.Builder> getSubscriptionStateRequest) Returns theSubscriptionState
, eitherActive
orInactive
.default GetSubscriptionStateResponse
getSubscriptionState
(GetSubscriptionStateRequest getSubscriptionStateRequest) Returns theSubscriptionState
, eitherActive
orInactive
.default ListAttacksResponse
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.default ListAttacksResponse
listAttacks
(Consumer<ListAttacksRequest.Builder> listAttacksRequest) Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.default ListAttacksResponse
listAttacks
(ListAttacksRequest listAttacksRequest) Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.default ListAttacksIterable
This is a variant oflistAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.default ListAttacksIterable
listAttacksPaginator
(Consumer<ListAttacksRequest.Builder> listAttacksRequest) This is a variant oflistAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.default ListAttacksIterable
listAttacksPaginator
(ListAttacksRequest listAttacksRequest) This is a variant oflistAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.default ListProtectionGroupsResponse
listProtectionGroups
(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest) Retrieves ProtectionGroup objects for the account.default ListProtectionGroupsResponse
listProtectionGroups
(ListProtectionGroupsRequest listProtectionGroupsRequest) Retrieves ProtectionGroup objects for the account.default ListProtectionGroupsIterable
listProtectionGroupsPaginator
(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest) This is a variant oflistProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation.default ListProtectionGroupsIterable
listProtectionGroupsPaginator
(ListProtectionGroupsRequest listProtectionGroupsRequest) This is a variant oflistProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation.default ListProtectionsResponse
Retrieves Protection objects for the account.default ListProtectionsResponse
listProtections
(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest) Retrieves Protection objects for the account.default ListProtectionsResponse
listProtections
(ListProtectionsRequest listProtectionsRequest) Retrieves Protection objects for the account.default ListProtectionsIterable
This is a variant oflistProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.default ListProtectionsIterable
listProtectionsPaginator
(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest) This is a variant oflistProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.default ListProtectionsIterable
listProtectionsPaginator
(ListProtectionsRequest listProtectionsRequest) This is a variant oflistProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.listResourcesInProtectionGroup
(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest) Retrieves the resources that are included in the protection group.listResourcesInProtectionGroup
(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest) Retrieves the resources that are included in the protection group.listResourcesInProtectionGroupPaginator
(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest) This is a variant oflistResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation.listResourcesInProtectionGroupPaginator
(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest) This is a variant oflistResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.default ShieldServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for a resource in Shield.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds or updates tags for a resource in Shield.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a resource in Shield.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from a resource in Shield.updateApplicationLayerAutomaticResponse
(Consumer<UpdateApplicationLayerAutomaticResponseRequest.Builder> updateApplicationLayerAutomaticResponseRequest) Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.updateApplicationLayerAutomaticResponse
(UpdateApplicationLayerAutomaticResponseRequest updateApplicationLayerAutomaticResponseRequest) Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.updateEmergencyContactSettings
(Consumer<UpdateEmergencyContactSettingsRequest.Builder> 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.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.default UpdateProtectionGroupResponse
updateProtectionGroup
(Consumer<UpdateProtectionGroupRequest.Builder> updateProtectionGroupRequest) Updates an existing protection group.default UpdateProtectionGroupResponse
updateProtectionGroup
(UpdateProtectionGroupRequest updateProtectionGroupRequest) Updates an existing protection group.default UpdateSubscriptionResponse
updateSubscription
(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest) Updates the details of an existing subscription.default UpdateSubscriptionResponse
updateSubscription
(UpdateSubscriptionRequest updateSubscriptionRequest) Updates the details of an existing subscription.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateDRTLogBucket
default AssociateDrtLogBucketResponse associateDRTLogBucket(AssociateDrtLogBucketRequest associateDrtLogBucketRequest) throws InternalErrorException, InvalidOperationException, NoAssociatedRoleException, LimitsExceededException, InvalidParameterException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an
AssociateDRTLogBucket
request, you must be subscribed to the Business Support plan or the Enterprise Support plan.- Parameters:
associateDrtLogBucketRequest
-- Returns:
- Result of the AssociateDRTLogBucket operation returned by the service.
- See Also:
-
associateDRTLogBucket
default AssociateDrtLogBucketResponse associateDRTLogBucket(Consumer<AssociateDrtLogBucketRequest.Builder> associateDrtLogBucketRequest) throws InternalErrorException, InvalidOperationException, NoAssociatedRoleException, LimitsExceededException, InvalidParameterException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
AssociateDrtLogBucketRequest.Builder
avoiding the need to create one manually viaAssociateDrtLogBucketRequest.builder()
- Parameters:
associateDrtLogBucketRequest
- AConsumer
that will call methods onAssociateDrtLogBucketRequest.Builder
to create a request.- Returns:
- Result of the AssociateDRTLogBucket operation returned by the service.
- See Also:
-
associateDRTRole
default AssociateDrtRoleResponse associateDRTRole(AssociateDrtRoleRequest associateDrtRoleRequest) throws InternalErrorException, InvalidOperationException, InvalidParameterException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException 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 anAssociateDRTRole
request for an account that already has an associated role, the newRoleArn
will replace the existingRoleArn
.Prior to making the
AssociateDRTRole
request, you must attach theAWSShieldDRTAccessPolicy
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 principaldrt.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 anAssociateDRTRole
request. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.To use the services of the SRT and make an
AssociateDRTRole
request, you must be subscribed to the Business Support plan or the Enterprise Support plan.- Parameters:
associateDrtRoleRequest
-- Returns:
- Result of the AssociateDRTRole operation returned by the service.
- See Also:
-
associateDRTRole
default AssociateDrtRoleResponse associateDRTRole(Consumer<AssociateDrtRoleRequest.Builder> associateDrtRoleRequest) throws InternalErrorException, InvalidOperationException, InvalidParameterException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException 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 anAssociateDRTRole
request for an account that already has an associated role, the newRoleArn
will replace the existingRoleArn
.Prior to making the
AssociateDRTRole
request, you must attach theAWSShieldDRTAccessPolicy
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 principaldrt.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 anAssociateDRTRole
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.
This is a convenience which creates an instance of the
AssociateDrtRoleRequest.Builder
avoiding the need to create one manually viaAssociateDrtRoleRequest.builder()
- Parameters:
associateDrtRoleRequest
- AConsumer
that will call methods onAssociateDrtRoleRequest.Builder
to create a request.- Returns:
- Result of the AssociateDRTRole operation returned by the service.
- See Also:
-
associateHealthCheck
default AssociateHealthCheckResponse associateHealthCheck(AssociateHealthCheckRequest associateHealthCheckRequest) throws InternalErrorException, LimitsExceededException, ResourceNotFoundException, InvalidParameterException, OptimisticLockException, InvalidResourceException, AwsServiceException, SdkClientException, ShieldException 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.
- Parameters:
associateHealthCheckRequest
-- Returns:
- Result of the AssociateHealthCheck operation returned by the service.
- See Also:
-
associateHealthCheck
default AssociateHealthCheckResponse associateHealthCheck(Consumer<AssociateHealthCheckRequest.Builder> associateHealthCheckRequest) throws InternalErrorException, LimitsExceededException, ResourceNotFoundException, InvalidParameterException, OptimisticLockException, InvalidResourceException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
AssociateHealthCheckRequest.Builder
avoiding the need to create one manually viaAssociateHealthCheckRequest.builder()
- Parameters:
associateHealthCheckRequest
- AConsumer
that will call methods onAssociateHealthCheckRequest.Builder
to create a request.- Returns:
- Result of the AssociateHealthCheck operation returned by the service.
- See Also:
-
associateProactiveEngagementDetails
default AssociateProactiveEngagementDetailsResponse associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest associateProactiveEngagementDetailsRequest) throws InternalErrorException, InvalidOperationException, InvalidParameterException, ResourceNotFoundException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException 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
andEnableProactiveEngagement
.This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.
The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using
DescribeEmergencyContactSettings
and then provide it to this call.- Parameters:
associateProactiveEngagementDetailsRequest
-- Returns:
- Result of the AssociateProactiveEngagementDetails operation returned by the service.
- See Also:
-
associateProactiveEngagementDetails
default AssociateProactiveEngagementDetailsResponse associateProactiveEngagementDetails(Consumer<AssociateProactiveEngagementDetailsRequest.Builder> associateProactiveEngagementDetailsRequest) throws InternalErrorException, InvalidOperationException, InvalidParameterException, ResourceNotFoundException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException 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
andEnableProactiveEngagement
.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.
This is a convenience which creates an instance of the
AssociateProactiveEngagementDetailsRequest.Builder
avoiding the need to create one manually viaAssociateProactiveEngagementDetailsRequest.builder()
- Parameters:
associateProactiveEngagementDetailsRequest
- AConsumer
that will call methods onAssociateProactiveEngagementDetailsRequest.Builder
to create a request.- Returns:
- Result of the AssociateProactiveEngagementDetails operation returned by the service.
- See Also:
-
createProtection
default CreateProtectionResponse createProtection(CreateProtectionRequest createProtectionRequest) throws InternalErrorException, InvalidResourceException, InvalidOperationException, LimitsExceededException, ResourceAlreadyExistsException, OptimisticLockException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, ShieldException 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.- Parameters:
createProtectionRequest
-- Returns:
- Result of the CreateProtection operation returned by the service.
- See Also:
-
createProtection
default CreateProtectionResponse createProtection(Consumer<CreateProtectionRequest.Builder> createProtectionRequest) throws InternalErrorException, InvalidResourceException, InvalidOperationException, LimitsExceededException, ResourceAlreadyExistsException, OptimisticLockException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
CreateProtectionRequest.Builder
avoiding the need to create one manually viaCreateProtectionRequest.builder()
- Parameters:
createProtectionRequest
- AConsumer
that will call methods onCreateProtectionRequest.Builder
to create a request.- Returns:
- Result of the CreateProtection operation returned by the service.
- See Also:
-
createProtectionGroup
default CreateProtectionGroupResponse createProtectionGroup(CreateProtectionGroupRequest createProtectionGroupRequest) throws InternalErrorException, ResourceAlreadyExistsException, OptimisticLockException, ResourceNotFoundException, InvalidParameterException, LimitsExceededException, AwsServiceException, SdkClientException, ShieldException Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
- Parameters:
createProtectionGroupRequest
-- Returns:
- Result of the CreateProtectionGroup operation returned by the service.
- See Also:
-
createProtectionGroup
default CreateProtectionGroupResponse createProtectionGroup(Consumer<CreateProtectionGroupRequest.Builder> createProtectionGroupRequest) throws InternalErrorException, ResourceAlreadyExistsException, OptimisticLockException, ResourceNotFoundException, InvalidParameterException, LimitsExceededException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
CreateProtectionGroupRequest.Builder
avoiding the need to create one manually viaCreateProtectionGroupRequest.builder()
- Parameters:
createProtectionGroupRequest
- AConsumer
that will call methods onCreateProtectionGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateProtectionGroup operation returned by the service.
- See Also:
-
createSubscription
default CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest createSubscriptionRequest) throws InternalErrorException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, ShieldException 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.- Parameters:
createSubscriptionRequest
-- Returns:
- Result of the CreateSubscription operation returned by the service.
- See Also:
-
createSubscription
default CreateSubscriptionResponse createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) throws InternalErrorException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
CreateSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateSubscriptionRequest.builder()
- Parameters:
createSubscriptionRequest
- AConsumer
that will call methods onCreateSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the CreateSubscription operation returned by the service.
- See Also:
-
createSubscription
default CreateSubscriptionResponse createSubscription() throws InternalErrorException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, ShieldExceptionActivates 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.- Returns:
- Result of the CreateSubscription operation returned by the service.
- See Also:
-
deleteProtection
default DeleteProtectionResponse deleteProtection(DeleteProtectionRequest deleteProtectionRequest) throws InternalErrorException, ResourceNotFoundException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException Deletes an Shield Advanced Protection.
- Parameters:
deleteProtectionRequest
-- Returns:
- Result of the DeleteProtection operation returned by the service.
- See Also:
-
deleteProtection
default DeleteProtectionResponse deleteProtection(Consumer<DeleteProtectionRequest.Builder> deleteProtectionRequest) throws InternalErrorException, ResourceNotFoundException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException Deletes an Shield Advanced Protection.
This is a convenience which creates an instance of the
DeleteProtectionRequest.Builder
avoiding the need to create one manually viaDeleteProtectionRequest.builder()
- Parameters:
deleteProtectionRequest
- AConsumer
that will call methods onDeleteProtectionRequest.Builder
to create a request.- Returns:
- Result of the DeleteProtection operation returned by the service.
- See Also:
-
deleteProtectionGroup
default DeleteProtectionGroupResponse deleteProtectionGroup(DeleteProtectionGroupRequest deleteProtectionGroupRequest) throws InternalErrorException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Removes the specified protection group.
- Parameters:
deleteProtectionGroupRequest
-- Returns:
- Result of the DeleteProtectionGroup operation returned by the service.
- See Also:
-
deleteProtectionGroup
default DeleteProtectionGroupResponse deleteProtectionGroup(Consumer<DeleteProtectionGroupRequest.Builder> deleteProtectionGroupRequest) throws InternalErrorException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Removes the specified protection group.
This is a convenience which creates an instance of the
DeleteProtectionGroupRequest.Builder
avoiding the need to create one manually viaDeleteProtectionGroupRequest.builder()
- Parameters:
deleteProtectionGroupRequest
- AConsumer
that will call methods onDeleteProtectionGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteProtectionGroup operation returned by the service.
- See Also:
-
describeAttack
default DescribeAttackResponse describeAttack(DescribeAttackRequest describeAttackRequest) throws InternalErrorException, AccessDeniedException, AwsServiceException, SdkClientException, ShieldException Describes the details of a DDoS attack.
- Parameters:
describeAttackRequest
-- Returns:
- Result of the DescribeAttack operation returned by the service.
- See Also:
-
describeAttack
default DescribeAttackResponse describeAttack(Consumer<DescribeAttackRequest.Builder> describeAttackRequest) throws InternalErrorException, AccessDeniedException, AwsServiceException, SdkClientException, ShieldException Describes the details of a DDoS attack.
This is a convenience which creates an instance of the
DescribeAttackRequest.Builder
avoiding the need to create one manually viaDescribeAttackRequest.builder()
- Parameters:
describeAttackRequest
- AConsumer
that will call methods onDescribeAttackRequest.Builder
to create a request.- Returns:
- Result of the DescribeAttack operation returned by the service.
- See Also:
-
describeAttackStatistics
default DescribeAttackStatisticsResponse describeAttackStatistics(DescribeAttackStatisticsRequest describeAttackStatisticsRequest) throws InternalErrorException, AwsServiceException, SdkClientException, ShieldException 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 to2020-10-26 22:39:32 UTC
, then the time range for the attack data returned is from2019-10-26 00:00:00 UTC
to2020-10-26 00:00:00 UTC
.The time range indicates the period covered by the attack statistics data items.
- Parameters:
describeAttackStatisticsRequest
-- Returns:
- Result of the DescribeAttackStatistics operation returned by the service.
- See Also:
-
describeAttackStatistics
default DescribeAttackStatisticsResponse describeAttackStatistics(Consumer<DescribeAttackStatisticsRequest.Builder> describeAttackStatisticsRequest) throws InternalErrorException, AwsServiceException, SdkClientException, ShieldException 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 to2020-10-26 22:39:32 UTC
, then the time range for the attack data returned is from2019-10-26 00:00:00 UTC
to2020-10-26 00:00:00 UTC
.The time range indicates the period covered by the attack statistics data items.
This is a convenience which creates an instance of the
DescribeAttackStatisticsRequest.Builder
avoiding the need to create one manually viaDescribeAttackStatisticsRequest.builder()
- Parameters:
describeAttackStatisticsRequest
- AConsumer
that will call methods onDescribeAttackStatisticsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAttackStatistics operation returned by the service.
- See Also:
-
describeDRTAccess
default DescribeDrtAccessResponse describeDRTAccess(DescribeDrtAccessRequest describeDrtAccessRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.
- Parameters:
describeDrtAccessRequest
-- Returns:
- Result of the DescribeDRTAccess operation returned by the service.
- See Also:
-
describeDRTAccess
default DescribeDrtAccessResponse describeDRTAccess(Consumer<DescribeDrtAccessRequest.Builder> describeDrtAccessRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
DescribeDrtAccessRequest.Builder
avoiding the need to create one manually viaDescribeDrtAccessRequest.builder()
- Parameters:
describeDrtAccessRequest
- AConsumer
that will call methods onDescribeDrtAccessRequest.Builder
to create a request.- Returns:
- Result of the DescribeDRTAccess operation returned by the service.
- See Also:
-
describeEmergencyContactSettings
default DescribeEmergencyContactSettingsResponse describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
- Parameters:
describeEmergencyContactSettingsRequest
-- Returns:
- Result of the DescribeEmergencyContactSettings operation returned by the service.
- See Also:
-
describeEmergencyContactSettings
default DescribeEmergencyContactSettingsResponse describeEmergencyContactSettings(Consumer<DescribeEmergencyContactSettingsRequest.Builder> describeEmergencyContactSettingsRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
DescribeEmergencyContactSettingsRequest.Builder
avoiding the need to create one manually viaDescribeEmergencyContactSettingsRequest.builder()
- Parameters:
describeEmergencyContactSettingsRequest
- AConsumer
that will call methods onDescribeEmergencyContactSettingsRequest.Builder
to create a request.- Returns:
- Result of the DescribeEmergencyContactSettings operation returned by the service.
- See Also:
-
describeProtection
default DescribeProtectionResponse describeProtection(DescribeProtectionRequest describeProtectionRequest) throws InternalErrorException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Lists the details of a Protection object.
- Parameters:
describeProtectionRequest
-- Returns:
- Result of the DescribeProtection operation returned by the service.
- See Also:
-
describeProtection
default DescribeProtectionResponse describeProtection(Consumer<DescribeProtectionRequest.Builder> describeProtectionRequest) throws InternalErrorException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Lists the details of a Protection object.
This is a convenience which creates an instance of the
DescribeProtectionRequest.Builder
avoiding the need to create one manually viaDescribeProtectionRequest.builder()
- Parameters:
describeProtectionRequest
- AConsumer
that will call methods onDescribeProtectionRequest.Builder
to create a request.- Returns:
- Result of the DescribeProtection operation returned by the service.
- See Also:
-
describeProtectionGroup
default DescribeProtectionGroupResponse describeProtectionGroup(DescribeProtectionGroupRequest describeProtectionGroupRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Returns the specification for the specified protection group.
- Parameters:
describeProtectionGroupRequest
-- Returns:
- Result of the DescribeProtectionGroup operation returned by the service.
- See Also:
-
describeProtectionGroup
default DescribeProtectionGroupResponse describeProtectionGroup(Consumer<DescribeProtectionGroupRequest.Builder> describeProtectionGroupRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Returns the specification for the specified protection group.
This is a convenience which creates an instance of the
DescribeProtectionGroupRequest.Builder
avoiding the need to create one manually viaDescribeProtectionGroupRequest.builder()
- Parameters:
describeProtectionGroupRequest
- AConsumer
that will call methods onDescribeProtectionGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeProtectionGroup operation returned by the service.
- See Also:
-
describeSubscription
default DescribeSubscriptionResponse describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Provides details about the Shield Advanced subscription for an account.
- Parameters:
describeSubscriptionRequest
-- Returns:
- Result of the DescribeSubscription operation returned by the service.
- See Also:
-
describeSubscription
default DescribeSubscriptionResponse describeSubscription(Consumer<DescribeSubscriptionRequest.Builder> describeSubscriptionRequest) throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Provides details about the Shield Advanced subscription for an account.
This is a convenience which creates an instance of the
DescribeSubscriptionRequest.Builder
avoiding the need to create one manually viaDescribeSubscriptionRequest.builder()
- Parameters:
describeSubscriptionRequest
- AConsumer
that will call methods onDescribeSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the DescribeSubscription operation returned by the service.
- See Also:
-
describeSubscription
default DescribeSubscriptionResponse describeSubscription() throws InternalErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldExceptionProvides details about the Shield Advanced subscription for an account.
- Returns:
- Result of the DescribeSubscription operation returned by the service.
- See Also:
-
disableApplicationLayerAutomaticResponse
default DisableApplicationLayerAutomaticResponseResponse disableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest disableApplicationLayerAutomaticResponseRequest) throws InternalErrorException, InvalidParameterException, ResourceNotFoundException, OptimisticLockException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException 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.
- Parameters:
disableApplicationLayerAutomaticResponseRequest
-- Returns:
- Result of the DisableApplicationLayerAutomaticResponse operation returned by the service.
- See Also:
-
disableApplicationLayerAutomaticResponse
default DisableApplicationLayerAutomaticResponseResponse disableApplicationLayerAutomaticResponse(Consumer<DisableApplicationLayerAutomaticResponseRequest.Builder> disableApplicationLayerAutomaticResponseRequest) throws InternalErrorException, InvalidParameterException, ResourceNotFoundException, OptimisticLockException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
DisableApplicationLayerAutomaticResponseRequest.Builder
avoiding the need to create one manually viaDisableApplicationLayerAutomaticResponseRequest.builder()
- Parameters:
disableApplicationLayerAutomaticResponseRequest
- AConsumer
that will call methods onDisableApplicationLayerAutomaticResponseRequest.Builder
to create a request.- Returns:
- Result of the DisableApplicationLayerAutomaticResponse operation returned by the service.
- See Also:
-
disableProactiveEngagement
default DisableProactiveEngagementResponse disableProactiveEngagement(DisableProactiveEngagementRequest disableProactiveEngagementRequest) throws InternalErrorException, InvalidOperationException, InvalidParameterException, ResourceNotFoundException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
- Parameters:
disableProactiveEngagementRequest
-- Returns:
- Result of the DisableProactiveEngagement operation returned by the service.
- See Also:
-
disableProactiveEngagement
default DisableProactiveEngagementResponse disableProactiveEngagement(Consumer<DisableProactiveEngagementRequest.Builder> disableProactiveEngagementRequest) throws InternalErrorException, InvalidOperationException, InvalidParameterException, ResourceNotFoundException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
This is a convenience which creates an instance of the
DisableProactiveEngagementRequest.Builder
avoiding the need to create one manually viaDisableProactiveEngagementRequest.builder()
- Parameters:
disableProactiveEngagementRequest
- AConsumer
that will call methods onDisableProactiveEngagementRequest.Builder
to create a request.- Returns:
- Result of the DisableProactiveEngagement operation returned by the service.
- See Also:
-
disassociateDRTLogBucket
default DisassociateDrtLogBucketResponse disassociateDRTLogBucket(DisassociateDrtLogBucketRequest disassociateDrtLogBucketRequest) throws InternalErrorException, InvalidOperationException, NoAssociatedRoleException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
- Parameters:
disassociateDrtLogBucketRequest
-- Returns:
- Result of the DisassociateDRTLogBucket operation returned by the service.
- See Also:
-
disassociateDRTLogBucket
default DisassociateDrtLogBucketResponse disassociateDRTLogBucket(Consumer<DisassociateDrtLogBucketRequest.Builder> disassociateDrtLogBucketRequest) throws InternalErrorException, InvalidOperationException, NoAssociatedRoleException, AccessDeniedForDependencyException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
This is a convenience which creates an instance of the
DisassociateDrtLogBucketRequest.Builder
avoiding the need to create one manually viaDisassociateDrtLogBucketRequest.builder()
- Parameters:
disassociateDrtLogBucketRequest
- AConsumer
that will call methods onDisassociateDrtLogBucketRequest.Builder
to create a request.- Returns:
- Result of the DisassociateDRTLogBucket operation returned by the service.
- See Also:
-
disassociateDRTRole
default DisassociateDrtRoleResponse disassociateDRTRole(DisassociateDrtRoleRequest disassociateDrtRoleRequest) throws InternalErrorException, InvalidOperationException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
- Parameters:
disassociateDrtRoleRequest
-- Returns:
- Result of the DisassociateDRTRole operation returned by the service.
- See Also:
-
disassociateDRTRole
default DisassociateDrtRoleResponse disassociateDRTRole(Consumer<DisassociateDrtRoleRequest.Builder> disassociateDrtRoleRequest) throws InternalErrorException, InvalidOperationException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
This is a convenience which creates an instance of the
DisassociateDrtRoleRequest.Builder
avoiding the need to create one manually viaDisassociateDrtRoleRequest.builder()
- Parameters:
disassociateDrtRoleRequest
- AConsumer
that will call methods onDisassociateDrtRoleRequest.Builder
to create a request.- Returns:
- Result of the DisassociateDRTRole operation returned by the service.
- See Also:
-
disassociateDRTRole
default DisassociateDrtRoleResponse disassociateDRTRole() throws InternalErrorException, InvalidOperationException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldExceptionRemoves the Shield Response Team's (SRT) access to your Amazon Web Services account.
- Returns:
- Result of the DisassociateDRTRole operation returned by the service.
- See Also:
-
disassociateHealthCheck
default DisassociateHealthCheckResponse disassociateHealthCheck(DisassociateHealthCheckRequest disassociateHealthCheckRequest) throws InternalErrorException, InvalidParameterException, ResourceNotFoundException, OptimisticLockException, InvalidResourceException, AwsServiceException, SdkClientException, ShieldException 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.
- Parameters:
disassociateHealthCheckRequest
-- Returns:
- Result of the DisassociateHealthCheck operation returned by the service.
- See Also:
-
disassociateHealthCheck
default DisassociateHealthCheckResponse disassociateHealthCheck(Consumer<DisassociateHealthCheckRequest.Builder> disassociateHealthCheckRequest) throws InternalErrorException, InvalidParameterException, ResourceNotFoundException, OptimisticLockException, InvalidResourceException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
DisassociateHealthCheckRequest.Builder
avoiding the need to create one manually viaDisassociateHealthCheckRequest.builder()
- Parameters:
disassociateHealthCheckRequest
- AConsumer
that will call methods onDisassociateHealthCheckRequest.Builder
to create a request.- Returns:
- Result of the DisassociateHealthCheck operation returned by the service.
- See Also:
-
enableApplicationLayerAutomaticResponse
default EnableApplicationLayerAutomaticResponseResponse enableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest enableApplicationLayerAutomaticResponseRequest) throws LimitsExceededException, InternalErrorException, ResourceNotFoundException, InvalidParameterException, OptimisticLockException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException 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.
- Parameters:
enableApplicationLayerAutomaticResponseRequest
-- Returns:
- Result of the EnableApplicationLayerAutomaticResponse operation returned by the service.
- See Also:
-
enableApplicationLayerAutomaticResponse
default EnableApplicationLayerAutomaticResponseResponse enableApplicationLayerAutomaticResponse(Consumer<EnableApplicationLayerAutomaticResponseRequest.Builder> enableApplicationLayerAutomaticResponseRequest) throws LimitsExceededException, InternalErrorException, ResourceNotFoundException, InvalidParameterException, OptimisticLockException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
EnableApplicationLayerAutomaticResponseRequest.Builder
avoiding the need to create one manually viaEnableApplicationLayerAutomaticResponseRequest.builder()
- Parameters:
enableApplicationLayerAutomaticResponseRequest
- AConsumer
that will call methods onEnableApplicationLayerAutomaticResponseRequest.Builder
to create a request.- Returns:
- Result of the EnableApplicationLayerAutomaticResponse operation returned by the service.
- See Also:
-
enableProactiveEngagement
default EnableProactiveEngagementResponse enableProactiveEngagement(EnableProactiveEngagementRequest enableProactiveEngagementRequest) throws InternalErrorException, InvalidOperationException, InvalidParameterException, ResourceNotFoundException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
- Parameters:
enableProactiveEngagementRequest
-- Returns:
- Result of the EnableProactiveEngagement operation returned by the service.
- See Also:
-
enableProactiveEngagement
default EnableProactiveEngagementResponse enableProactiveEngagement(Consumer<EnableProactiveEngagementRequest.Builder> enableProactiveEngagementRequest) throws InternalErrorException, InvalidOperationException, InvalidParameterException, ResourceNotFoundException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
EnableProactiveEngagementRequest.Builder
avoiding the need to create one manually viaEnableProactiveEngagementRequest.builder()
- Parameters:
enableProactiveEngagementRequest
- AConsumer
that will call methods onEnableProactiveEngagementRequest.Builder
to create a request.- Returns:
- Result of the EnableProactiveEngagement operation returned by the service.
- See Also:
-
getSubscriptionState
default GetSubscriptionStateResponse getSubscriptionState(GetSubscriptionStateRequest getSubscriptionStateRequest) throws InternalErrorException, AwsServiceException, SdkClientException, ShieldException Returns the
SubscriptionState
, eitherActive
orInactive
.- Parameters:
getSubscriptionStateRequest
-- Returns:
- Result of the GetSubscriptionState operation returned by the service.
- See Also:
-
getSubscriptionState
default GetSubscriptionStateResponse getSubscriptionState(Consumer<GetSubscriptionStateRequest.Builder> getSubscriptionStateRequest) throws InternalErrorException, AwsServiceException, SdkClientException, ShieldException Returns the
SubscriptionState
, eitherActive
orInactive
.
This is a convenience which creates an instance of the
GetSubscriptionStateRequest.Builder
avoiding the need to create one manually viaGetSubscriptionStateRequest.builder()
- Parameters:
getSubscriptionStateRequest
- AConsumer
that will call methods onGetSubscriptionStateRequest.Builder
to create a request.- Returns:
- Result of the GetSubscriptionState operation returned by the service.
- See Also:
-
getSubscriptionState
default GetSubscriptionStateResponse getSubscriptionState() throws InternalErrorException, AwsServiceException, SdkClientException, ShieldExceptionReturns the
SubscriptionState
, eitherActive
orInactive
.- Returns:
- Result of the GetSubscriptionState operation returned by the service.
- See Also:
-
listAttacks
default ListAttacksResponse listAttacks(ListAttacksRequest listAttacksRequest) throws InternalErrorException, InvalidParameterException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
- Parameters:
listAttacksRequest
-- Returns:
- Result of the ListAttacks operation returned by the service.
- See Also:
-
listAttacks
default ListAttacksResponse listAttacks(Consumer<ListAttacksRequest.Builder> listAttacksRequest) throws InternalErrorException, InvalidParameterException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
This is a convenience which creates an instance of the
ListAttacksRequest.Builder
avoiding the need to create one manually viaListAttacksRequest.builder()
- Parameters:
listAttacksRequest
- AConsumer
that will call methods onListAttacksRequest.Builder
to create a request.- Returns:
- Result of the ListAttacks operation returned by the service.
- See Also:
-
listAttacks
default ListAttacksResponse listAttacks() throws InternalErrorException, InvalidParameterException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldExceptionReturns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
- Returns:
- Result of the ListAttacks operation returned by the service.
- See Also:
-
listAttacksPaginator
default ListAttacksIterable listAttacksPaginator() throws InternalErrorException, InvalidParameterException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldExceptionThis is a variant of
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.shield.paginators.ListAttacksIterable responses = client.listAttacksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.shield.paginators.ListAttacksIterable responses = client.listAttacksPaginator(request); for (software.amazon.awssdk.services.shield.model.ListAttacksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.shield.paginators.ListAttacksIterable responses = client.listAttacksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAttacksPaginator
default ListAttacksIterable listAttacksPaginator(ListAttacksRequest listAttacksRequest) throws InternalErrorException, InvalidParameterException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException This is a variant of
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.shield.paginators.ListAttacksIterable responses = client.listAttacksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.shield.paginators.ListAttacksIterable responses = client.listAttacksPaginator(request); for (software.amazon.awssdk.services.shield.model.ListAttacksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.shield.paginators.ListAttacksIterable responses = client.listAttacksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.- Parameters:
listAttacksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAttacksPaginator
default ListAttacksIterable listAttacksPaginator(Consumer<ListAttacksRequest.Builder> listAttacksRequest) throws InternalErrorException, InvalidParameterException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException This is a variant of
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.shield.paginators.ListAttacksIterable responses = client.listAttacksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.shield.paginators.ListAttacksIterable responses = client.listAttacksPaginator(request); for (software.amazon.awssdk.services.shield.model.ListAttacksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.shield.paginators.ListAttacksIterable responses = client.listAttacksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation.
This is a convenience which creates an instance of the
ListAttacksRequest.Builder
avoiding the need to create one manually viaListAttacksRequest.builder()
- Parameters:
listAttacksRequest
- AConsumer
that will call methods onListAttacksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectionGroups
default ListProtectionGroupsResponse listProtectionGroups(ListProtectionGroupsRequest listProtectionGroupsRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException 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.
- Parameters:
listProtectionGroupsRequest
-- Returns:
- Result of the ListProtectionGroups operation returned by the service.
- See Also:
-
listProtectionGroups
default ListProtectionGroupsResponse listProtectionGroups(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
ListProtectionGroupsRequest.Builder
avoiding the need to create one manually viaListProtectionGroupsRequest.builder()
- Parameters:
listProtectionGroupsRequest
- AConsumer
that will call methods onListProtectionGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListProtectionGroups operation returned by the service.
- See Also:
-
listProtectionGroupsPaginator
default ListProtectionGroupsIterable listProtectionGroupsPaginator(ListProtectionGroupsRequest listProtectionGroupsRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException This is a variant of
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.shield.paginators.ListProtectionGroupsIterable responses = client.listProtectionGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.shield.paginators.ListProtectionGroupsIterable responses = client .listProtectionGroupsPaginator(request); for (software.amazon.awssdk.services.shield.model.ListProtectionGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.shield.paginators.ListProtectionGroupsIterable responses = client.listProtectionGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation.- Parameters:
listProtectionGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectionGroupsPaginator
default ListProtectionGroupsIterable listProtectionGroupsPaginator(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException This is a variant of
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.shield.paginators.ListProtectionGroupsIterable responses = client.listProtectionGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.shield.paginators.ListProtectionGroupsIterable responses = client .listProtectionGroupsPaginator(request); for (software.amazon.awssdk.services.shield.model.ListProtectionGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.shield.paginators.ListProtectionGroupsIterable responses = client.listProtectionGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListProtectionGroupsRequest.Builder
avoiding the need to create one manually viaListProtectionGroupsRequest.builder()
- Parameters:
listProtectionGroupsRequest
- AConsumer
that will call methods onListProtectionGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtections
default ListProtectionsResponse listProtections(ListProtectionsRequest listProtectionsRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException 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.
- Parameters:
listProtectionsRequest
-- Returns:
- Result of the ListProtections operation returned by the service.
- See Also:
-
listProtections
default ListProtectionsResponse listProtections(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
ListProtectionsRequest.Builder
avoiding the need to create one manually viaListProtectionsRequest.builder()
- Parameters:
listProtectionsRequest
- AConsumer
that will call methods onListProtectionsRequest.Builder
to create a request.- Returns:
- Result of the ListProtections operation returned by the service.
- See Also:
-
listProtections
default ListProtectionsResponse listProtections() throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldExceptionRetrieves 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.
- Returns:
- Result of the ListProtections operation returned by the service.
- See Also:
-
listProtectionsPaginator
default ListProtectionsIterable listProtectionsPaginator() throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldExceptionThis is a variant of
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.shield.paginators.ListProtectionsIterable responses = client.listProtectionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.shield.paginators.ListProtectionsIterable responses = client .listProtectionsPaginator(request); for (software.amazon.awssdk.services.shield.model.ListProtectionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.shield.paginators.ListProtectionsIterable responses = client.listProtectionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectionsPaginator
default ListProtectionsIterable listProtectionsPaginator(ListProtectionsRequest listProtectionsRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException This is a variant of
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.shield.paginators.ListProtectionsIterable responses = client.listProtectionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.shield.paginators.ListProtectionsIterable responses = client .listProtectionsPaginator(request); for (software.amazon.awssdk.services.shield.model.ListProtectionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.shield.paginators.ListProtectionsIterable responses = client.listProtectionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.- Parameters:
listProtectionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectionsPaginator
default ListProtectionsIterable listProtectionsPaginator(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException This is a variant of
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.shield.paginators.ListProtectionsIterable responses = client.listProtectionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.shield.paginators.ListProtectionsIterable responses = client .listProtectionsPaginator(request); for (software.amazon.awssdk.services.shield.model.ListProtectionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.shield.paginators.ListProtectionsIterable responses = client.listProtectionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest)
operation.
This is a convenience which creates an instance of the
ListProtectionsRequest.Builder
avoiding the need to create one manually viaListProtectionsRequest.builder()
- Parameters:
listProtectionsRequest
- AConsumer
that will call methods onListProtectionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourcesInProtectionGroup
default ListResourcesInProtectionGroupResponse listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException Retrieves the resources that are included in the protection group.
- Parameters:
listResourcesInProtectionGroupRequest
-- Returns:
- Result of the ListResourcesInProtectionGroup operation returned by the service.
- See Also:
-
listResourcesInProtectionGroup
default ListResourcesInProtectionGroupResponse listResourcesInProtectionGroup(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException Retrieves the resources that are included in the protection group.
This is a convenience which creates an instance of the
ListResourcesInProtectionGroupRequest.Builder
avoiding the need to create one manually viaListResourcesInProtectionGroupRequest.builder()
- Parameters:
listResourcesInProtectionGroupRequest
- AConsumer
that will call methods onListResourcesInProtectionGroupRequest.Builder
to create a request.- Returns:
- Result of the ListResourcesInProtectionGroup operation returned by the service.
- See Also:
-
listResourcesInProtectionGroupPaginator
default ListResourcesInProtectionGroupIterable listResourcesInProtectionGroupPaginator(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException This is a variant of
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupIterable responses = client.listResourcesInProtectionGroupPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupIterable responses = client .listResourcesInProtectionGroupPaginator(request); for (software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupIterable responses = client.listResourcesInProtectionGroupPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation.- Parameters:
listResourcesInProtectionGroupRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourcesInProtectionGroupPaginator
default ListResourcesInProtectionGroupIterable listResourcesInProtectionGroupPaginator(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest) throws InternalErrorException, ResourceNotFoundException, InvalidPaginationTokenException, AwsServiceException, SdkClientException, ShieldException This is a variant of
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupIterable responses = client.listResourcesInProtectionGroupPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupIterable responses = client .listResourcesInProtectionGroupPaginator(request); for (software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupIterable responses = client.listResourcesInProtectionGroupPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation.
This is a convenience which creates an instance of the
ListResourcesInProtectionGroupRequest.Builder
avoiding the need to create one manually viaListResourcesInProtectionGroupRequest.builder()
- Parameters:
listResourcesInProtectionGroupRequest
- AConsumer
that will call methods onListResourcesInProtectionGroupRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalErrorException, InvalidResourceException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalErrorException, InvalidResourceException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalErrorException, InvalidResourceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Adds or updates tags for a resource in Shield.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalErrorException, InvalidResourceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Adds or updates tags for a resource in Shield.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalErrorException, InvalidResourceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Removes tags from a resource in Shield.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalErrorException, InvalidResourceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Removes tags from a resource in Shield.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateApplicationLayerAutomaticResponse
default UpdateApplicationLayerAutomaticResponseResponse updateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest updateApplicationLayerAutomaticResponseRequest) throws InternalErrorException, ResourceNotFoundException, InvalidParameterException, OptimisticLockException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
- Parameters:
updateApplicationLayerAutomaticResponseRequest
-- Returns:
- Result of the UpdateApplicationLayerAutomaticResponse operation returned by the service.
- See Also:
-
updateApplicationLayerAutomaticResponse
default UpdateApplicationLayerAutomaticResponseResponse updateApplicationLayerAutomaticResponse(Consumer<UpdateApplicationLayerAutomaticResponseRequest.Builder> updateApplicationLayerAutomaticResponseRequest) throws InternalErrorException, ResourceNotFoundException, InvalidParameterException, OptimisticLockException, InvalidOperationException, AwsServiceException, SdkClientException, ShieldException Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
This is a convenience which creates an instance of the
UpdateApplicationLayerAutomaticResponseRequest.Builder
avoiding the need to create one manually viaUpdateApplicationLayerAutomaticResponseRequest.builder()
- Parameters:
updateApplicationLayerAutomaticResponseRequest
- AConsumer
that will call methods onUpdateApplicationLayerAutomaticResponseRequest.Builder
to create a request.- Returns:
- Result of the UpdateApplicationLayerAutomaticResponse operation returned by the service.
- See Also:
-
updateEmergencyContactSettings
default UpdateEmergencyContactSettingsResponse updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest) throws InternalErrorException, InvalidParameterException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
- Parameters:
updateEmergencyContactSettingsRequest
-- Returns:
- Result of the UpdateEmergencyContactSettings operation returned by the service.
- See Also:
-
updateEmergencyContactSettings
default UpdateEmergencyContactSettingsResponse updateEmergencyContactSettings(Consumer<UpdateEmergencyContactSettingsRequest.Builder> updateEmergencyContactSettingsRequest) throws InternalErrorException, InvalidParameterException, OptimisticLockException, ResourceNotFoundException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
UpdateEmergencyContactSettingsRequest.Builder
avoiding the need to create one manually viaUpdateEmergencyContactSettingsRequest.builder()
- Parameters:
updateEmergencyContactSettingsRequest
- AConsumer
that will call methods onUpdateEmergencyContactSettingsRequest.Builder
to create a request.- Returns:
- Result of the UpdateEmergencyContactSettings operation returned by the service.
- See Also:
-
updateProtectionGroup
default UpdateProtectionGroupResponse updateProtectionGroup(UpdateProtectionGroupRequest updateProtectionGroupRequest) throws InternalErrorException, ResourceNotFoundException, OptimisticLockException, InvalidParameterException, AwsServiceException, SdkClientException, ShieldException Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
- Parameters:
updateProtectionGroupRequest
-- Returns:
- Result of the UpdateProtectionGroup operation returned by the service.
- See Also:
-
updateProtectionGroup
default UpdateProtectionGroupResponse updateProtectionGroup(Consumer<UpdateProtectionGroupRequest.Builder> updateProtectionGroupRequest) throws InternalErrorException, ResourceNotFoundException, OptimisticLockException, InvalidParameterException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
UpdateProtectionGroupRequest.Builder
avoiding the need to create one manually viaUpdateProtectionGroupRequest.builder()
- Parameters:
updateProtectionGroupRequest
- AConsumer
that will call methods onUpdateProtectionGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateProtectionGroup operation returned by the service.
- See Also:
-
updateSubscription
default UpdateSubscriptionResponse updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest) throws InternalErrorException, LockedSubscriptionException, ResourceNotFoundException, InvalidParameterException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException 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.
- Parameters:
updateSubscriptionRequest
-- Returns:
- Result of the UpdateSubscription operation returned by the service.
- See Also:
-
updateSubscription
default UpdateSubscriptionResponse updateSubscription(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest) throws InternalErrorException, LockedSubscriptionException, ResourceNotFoundException, InvalidParameterException, OptimisticLockException, AwsServiceException, SdkClientException, ShieldException 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.
This is a convenience which creates an instance of the
UpdateSubscriptionRequest.Builder
avoiding the need to create one manually viaUpdateSubscriptionRequest.builder()
- Parameters:
updateSubscriptionRequest
- AConsumer
that will call methods onUpdateSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the UpdateSubscription operation returned by the service.
- See Also:
-
create
Create aShieldClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aShieldClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-