Package-level declarations

Types

Link copied to clipboard

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Activates Shield Advanced for an account.

Link copied to clipboard

Deletes an Shield Advanced Protection.

Link copied to clipboard

Removes the specified protection group.

Link copied to clipboard

Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

Link copied to clipboard

Describes the details of a DDoS attack.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Lists the details of a Protection object.

Link copied to clipboard

Returns the specification for the specified protection group.

Link copied to clipboard

Provides details about the Shield Advanced subscription for an account.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.

Link copied to clipboard

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.

Link copied to clipboard

Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.

Link copied to clipboard

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.

Link copied to clipboard

Returns the SubscriptionState, either Active or Inactive.

Link copied to clipboard
inline suspend fun ShieldClient.listAttacks(crossinline block: ListAttacksRequest.Builder.() -> Unit): ListAttacksResponse

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Retrieves the resources that are included in the protection group.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun ShieldClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or updates tags for a resource in Shield.

Link copied to clipboard

Removes tags from a resource in Shield.

Link copied to clipboard

Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.