AWS.Shield (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs.

Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks.

Adds health-based detection to the Shield Advanced protection for a resource.

Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use.

Enables AWS Shield Advanced for a specific AWS resource.

Creates a grouping of protected resources so they can be handled as a collective.

Activates AWS Shield Advanced for an account.

Deletes an AWS Shield Advanced Protection.

Removes the specified protection group.

Removes AWS Shield Advanced from an account.

Describes the details of a DDoS attack.

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.

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.

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.

Lists the details of a Protection object.

Returns the specification for the specified protection group.

Provides details about the AWS Shield Advanced subscription for an account.

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

Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.

Removes the DDoS Response Team's (DRT) access to your AWS account.

Removes health-based detection from the Shield Advanced protection for a resource.

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.

Returns the SubscriptionState, either Active or Inactive.

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

Retrieves the ProtectionGroup objects for the account.

Lists all Protection objects for the account.

Retrieves the resources that are included in the protection group.

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

Adds or updates tags for a resource in AWS Shield.

Removes tags from a resource in AWS Shield.

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.

Updates an existing protection group.

Updates the details of an existing subscription.

Link to this section Functions

Link to this function

associate_drt_log_bucket(client, input, options \\ [])

View Source

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 an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

Link to this function

associate_drt_role(client, input, options \\ [])

View Source

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.

To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

Link to this function

associate_health_check(client, input, options \\ [])

View Source

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.

Link to this function

associate_proactive_engagement_details(client, input, options \\ [])

View Source

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 using DescribeEmergencyContactSettings and then provide it to this call.

Link to this function

create_protection(client, input, options \\ [])

View Source

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.

Link to this function

create_protection_group(client, input, options \\ [])

View Source

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 to this function

create_subscription(client, input, options \\ [])

View Source

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 an UpdateSubscription request.

Link to this function

delete_protection(client, input, options \\ [])

View Source

Deletes an AWS Shield Advanced Protection.

Link to this function

delete_protection_group(client, input, options \\ [])

View Source

Removes the specified protection group.

Link to this function

delete_subscription(client, input, options \\ [])

View Source

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.

Link to this function

describe_attack(client, input, options \\ [])

View Source

Describes the details of a DDoS attack.

Link to this function

describe_attack_statistics(client, input, options \\ [])

View Source

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.

The time range indicates the period covered by the attack statistics data items.

Link to this function

describe_drt_access(client, input, options \\ [])

View Source

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.

Link to this function

describe_emergency_contact_settings(client, input, options \\ [])

View Source

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.

Link to this function

describe_protection(client, input, options \\ [])

View Source

Lists the details of a Protection object.

Link to this function

describe_protection_group(client, input, options \\ [])

View Source

Returns the specification for the specified protection group.

Link to this function

describe_subscription(client, input, options \\ [])

View Source

Provides details about the AWS Shield Advanced subscription for an account.

Link to this function

disable_proactive_engagement(client, input, options \\ [])

View Source

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

Link to this function

disassociate_drt_log_bucket(client, input, options \\ [])

View Source

Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.

To make a DisassociateDRTLogBucket 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.

Link to this function

disassociate_drt_role(client, input, options \\ [])

View Source

Removes the DDoS Response Team's (DRT) access to your AWS account.

To make a DisassociateDRTRole 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.

Link to this function

disassociate_health_check(client, input, options \\ [])

View Source

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.

Link to this function

enable_proactive_engagement(client, input, options \\ [])

View Source

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.

Link to this function

get_subscription_state(client, input, options \\ [])

View Source

Returns the SubscriptionState, either Active or Inactive.

Link to this function

list_attacks(client, input, options \\ [])

View Source

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

Link to this function

list_protection_groups(client, input, options \\ [])

View Source

Retrieves the ProtectionGroup objects for the account.

Link to this function

list_protections(client, input, options \\ [])

View Source

Lists all Protection objects for the account.

Link to this function

list_resources_in_protection_group(client, input, options \\ [])

View Source

Retrieves the resources that are included in the protection group.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

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

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds or updates tags for a resource in AWS Shield.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from a resource in AWS Shield.

Link to this function

update_emergency_contact_settings(client, input, options \\ [])

View Source

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.

Link to this function

update_protection_group(client, input, options \\ [])

View Source

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 to this function

update_subscription(client, input, options \\ [])

View Source

Updates the details of an existing subscription.

Only enter values for parameters you want to change. Empty parameters are not updated.