aws_shield
AWS Shield Advanced
This is the AWS Shield Advanced API Reference.
This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.Summary
Functions
-
associate_drt_log_bucket(Client, Input)
Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs.
- associate_drt_log_bucket(Client, Input, Options)
-
associate_drt_role(Client, Input)
Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks.
- associate_drt_role(Client, Input, Options)
-
associate_health_check(Client, Input)
Adds health-based detection to the Shield Advanced protection for a resource.
- associate_health_check(Client, Input, Options)
-
associate_proactive_engagement_details(Client, Input)
Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use.
- associate_proactive_engagement_details(Client, Input, Options)
-
create_protection(Client, Input)
Enables AWS Shield Advanced for a specific AWS resource.
- create_protection(Client, Input, Options)
-
create_protection_group(Client, Input)
Creates a grouping of protected resources so they can be handled as a collective.
- create_protection_group(Client, Input, Options)
-
create_subscription(Client, Input)
Activates AWS Shield Advanced for an account.
- create_subscription(Client, Input, Options)
-
delete_protection(Client, Input)
Deletes an AWS Shield Advanced
Protection
. - delete_protection(Client, Input, Options)
-
delete_protection_group(Client, Input)
Removes the specified protection group.
- delete_protection_group(Client, Input, Options)
-
delete_subscription(Client, Input)
Removes AWS Shield Advanced from an account.
- delete_subscription(Client, Input, Options)
-
describe_attack(Client, Input)
Describes the details of a DDoS attack.
- describe_attack(Client, Input, Options)
-
describe_attack_statistics(Client, Input)
Provides information about the number and type of attacks AWS 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.
- describe_attack_statistics(Client, Input, Options)
-
describe_drt_access(Client, Input)
Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.
- describe_drt_access(Client, Input, Options)
-
describe_emergency_contact_settings(Client, Input)
A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
- describe_emergency_contact_settings(Client, Input, Options)
-
describe_protection(Client, Input)
Lists the details of a
Protection
object. - describe_protection(Client, Input, Options)
-
describe_protection_group(Client, Input)
Returns the specification for the specified protection group.
- describe_protection_group(Client, Input, Options)
-
describe_subscription(Client, Input)
Provides details about the AWS Shield Advanced subscription for an account.
- describe_subscription(Client, Input, Options)
-
disable_proactive_engagement(Client, Input)
Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
- disable_proactive_engagement(Client, Input, Options)
-
disassociate_drt_log_bucket(Client, Input)
Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.
- disassociate_drt_log_bucket(Client, Input, Options)
-
disassociate_drt_role(Client, Input)
Removes the DDoS Response Team's (DRT) access to your AWS account.
- disassociate_drt_role(Client, Input, Options)
-
disassociate_health_check(Client, Input)
Removes health-based detection from the Shield Advanced protection for a resource.
- disassociate_health_check(Client, Input, Options)
-
enable_proactive_engagement(Client, Input)
Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
- enable_proactive_engagement(Client, Input, Options)
-
get_subscription_state(Client, Input)
Returns the
SubscriptionState
, eitherActive
orInactive
. - get_subscription_state(Client, Input, Options)
-
list_attacks(Client, Input)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
- list_attacks(Client, Input, Options)
-
list_protection_groups(Client, Input)
Retrieves the
ProtectionGroup
objects for the account. - list_protection_groups(Client, Input, Options)
-
list_protections(Client, Input)
Lists all
Protection
objects for the account. - list_protections(Client, Input, Options)
-
list_resources_in_protection_group(Client, Input)
Retrieves the resources that are included in the protection group.
- list_resources_in_protection_group(Client, Input, Options)
-
update_emergency_contact_settings(Client, Input)
Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
- update_emergency_contact_settings(Client, Input, Options)
-
update_protection_group(Client, Input)
Updates an existing protection group.
- update_protection_group(Client, Input, Options)
-
update_subscription(Client, Input)
Updates the details of an existing subscription.
- update_subscription(Client, Input, Options)
Functions
associate_drt_log_bucket(Client, Input)
Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs.
You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the DRT and make anAssociateDRTLogBucket
request, you must be subscribed to the Business Support plan or the
Enterprise Support plan.
associate_drt_log_bucket(Client, Input, Options)
associate_drt_role(Client, Input)
Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks.
This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.
You can associate only one RoleArn
with your subscription. If you submit
an AssociateDRTRole
request for an account that already has an
associated role, the new RoleArn
will replace the existing RoleArn
.
Prior to making the AssociateDRTRole
request, you must attach the
AWSShieldDRTAccessPolicy managed policy to the role you will specify in
the request. For more information see Attaching and Detaching IAM
Policies. The role must also trust the service principal drt.shield.amazonaws.com
. For more information, see IAM JSON Policy
Elements: Principal.
The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you.
You must have the iam:PassRole
permission to make an AssociateDRTRole
request. For more information, see Granting a User Permissions to Pass a
Role to an AWS Service.
AssociateDRTRole
request, you
must be subscribed to the Business Support plan or the Enterprise Support
plan.
associate_drt_role(Client, Input, Options)
associate_health_check(Client, Input)
Adds health-based detection to the Shield Advanced protection for a resource.
Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the AWS WAF and AWS Shield Developer Guide.associate_health_check(Client, Input, Options)
associate_proactive_engagement_details(Client, Input)
Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use.
You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to
disable or enable proactive engagement, use the calls
DisableProactiveEngagement
and EnableProactiveEngagement
.
This call defines the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT 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 usingDescribeEmergencyContactSettings
and then
provide it to this call.
associate_proactive_engagement_details(Client, Input, Options)
create_protection(Client, Input)
Enables AWS Shield Advanced for a specific AWS resource.
The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.
You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.create_protection(Client, Input, Options)
create_protection_group(Client, Input)
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.create_protection_group(Client, Input, Options)
create_subscription(Client, Input)
Activates AWS Shield Advanced for an account.
When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting anUpdateSubscription
request.
create_subscription(Client, Input, Options)
delete_protection(Client, Input)
Deletes an AWS Shield Advanced Protection
.
delete_protection(Client, Input, Options)
delete_protection_group(Client, Input)
Removes the specified protection group.
delete_protection_group(Client, Input, Options)
delete_subscription(Client, Input)
Removes AWS Shield Advanced from an account.
AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.delete_subscription(Client, Input, Options)
describe_attack(Client, Input)
Describes the details of a DDoS attack.
describe_attack(Client, Input, Options)
describe_attack_statistics(Client, Input)
Provides information about the number and type of attacks AWS Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them.
This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year
ago, to midnight UTC, today. For example, if the current time is
2020-10-26 15:39:32 PDT
, equal to 2020-10-26 22:39:32 UTC
, then the
time range for the attack data returned is from 2019-10-26 00:00:00 UTC
to 2020-10-26 00:00:00 UTC
.
describe_attack_statistics(Client, Input, Options)
describe_drt_access(Client, Input)
Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.
describe_drt_access(Client, Input, Options)
describe_emergency_contact_settings(Client, Input)
A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
describe_emergency_contact_settings(Client, Input, Options)
describe_protection(Client, Input)
Lists the details of a Protection
object.
describe_protection(Client, Input, Options)
describe_protection_group(Client, Input)
Returns the specification for the specified protection group.
describe_protection_group(Client, Input, Options)
describe_subscription(Client, Input)
Provides details about the AWS Shield Advanced subscription for an account.
describe_subscription(Client, Input, Options)
disable_proactive_engagement(Client, Input)
Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
disable_proactive_engagement(Client, Input, Options)
disassociate_drt_log_bucket(Client, Input)
Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.
To make aDisassociateDRTLogBucket
request, you must be subscribed to
the Business Support plan or the Enterprise Support plan. However, if you
are not subscribed to one of these support plans, but had been previously
and had granted the DRT access to your account, you can submit a
DisassociateDRTLogBucket
request to remove this access.
disassociate_drt_log_bucket(Client, Input, Options)
disassociate_drt_role(Client, Input)
Removes the DDoS Response Team's (DRT) access to your AWS account.
To make aDisassociateDRTRole
request, you must be subscribed to the
Business Support plan or the Enterprise Support plan. However, if you are
not subscribed to one of these support plans, but had been previously and
had granted the DRT access to your account, you can submit a
DisassociateDRTRole
request to remove this access.
disassociate_drt_role(Client, Input, Options)
disassociate_health_check(Client, Input)
Removes health-based detection from the Shield Advanced protection for a resource.
Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.
You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the AWS WAF and AWS Shield Developer Guide.disassociate_health_check(Client, Input, Options)
enable_proactive_engagement(Client, Input)
Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
enable_proactive_engagement(Client, Input, Options)
get_subscription_state(Client, Input)
Returns the SubscriptionState
, either Active
or Inactive
.
get_subscription_state(Client, Input, Options)
list_attacks(Client, Input)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
list_attacks(Client, Input, Options)
list_protection_groups(Client, Input)
Retrieves the ProtectionGroup
objects for the account.
list_protection_groups(Client, Input, Options)
list_protections(Client, Input)
Lists all Protection
objects for the account.
list_protections(Client, Input, Options)
list_resources_in_protection_group(Client, Input)
Retrieves the resources that are included in the protection group.
list_resources_in_protection_group(Client, Input, Options)
update_emergency_contact_settings(Client, Input)
Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
update_emergency_contact_settings(Client, Input, Options)
update_protection_group(Client, Input)
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.update_protection_group(Client, Input, Options)
update_subscription(Client, Input)
Updates the details of an existing subscription.
Only enter values for parameters you want to change. Empty parameters are not updated.