NAME

Paws::Shield - Perl Interface to AWS AWS Shield

SYNOPSIS

use Paws;

my $obj = Paws->service('Shield');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

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 (https://docs.aws.amazon.com/waf/latest/developerguide/).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02

METHODS

AssociateDRTLogBucket

LogBucket => Str

Each argument is described in detail in: Paws::Shield::AssociateDRTLogBucket

Returns: a Paws::Shield::AssociateDRTLogBucketResponse instance

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 (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).

AssociateDRTRole

RoleArn => Str

Each argument is described in detail in: Paws::Shield::AssociateDRTRole

Returns: a Paws::Shield::AssociateDRTRoleResponse instance

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 (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html).

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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).

To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).

AssociateHealthCheck

HealthCheckArn => Str
ProtectionId => Str

Each argument is described in detail in: Paws::Shield::AssociateHealthCheck

Returns: a Paws::Shield::AssociateHealthCheckResponse instance

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 (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option) in the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

AssociateProactiveEngagementDetails

EmergencyContactList => ArrayRef[Paws::Shield::EmergencyContact]

Each argument is described in detail in: Paws::Shield::AssociateProactiveEngagementDetails

Returns: a Paws::Shield::AssociateProactiveEngagementDetailsResponse instance

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.

CreateProtection

Name => Str
ResourceArn => Str
[Tags => ArrayRef[Paws::Shield::Tag]]

Each argument is described in detail in: Paws::Shield::CreateProtection

Returns: a Paws::Shield::CreateProtectionResponse instance

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 (https://console.aws.amazon.com/waf/). For more information see Getting Started with AWS Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html) and Add AWS Shield Advanced Protection to more AWS Resources (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html).

CreateProtectionGroup

Aggregation => Str
Pattern => Str
ProtectionGroupId => Str
[Members => ArrayRef[Str|Undef]]
[ResourceType => Str]
[Tags => ArrayRef[Paws::Shield::Tag]]

Each argument is described in detail in: Paws::Shield::CreateProtectionGroup

Returns: a Paws::Shield::CreateProtectionGroupResponse instance

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.

CreateSubscription

Each argument is described in detail in: Paws::Shield::CreateSubscription

Returns: a Paws::Shield::CreateSubscriptionResponse instance

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.

DeleteProtection

ProtectionId => Str

Each argument is described in detail in: Paws::Shield::DeleteProtection

Returns: a Paws::Shield::DeleteProtectionResponse instance

Deletes an AWS Shield Advanced Protection.

DeleteProtectionGroup

ProtectionGroupId => Str

Each argument is described in detail in: Paws::Shield::DeleteProtectionGroup

Returns: a Paws::Shield::DeleteProtectionGroupResponse instance

Removes the specified protection group.

DeleteSubscription

Each argument is described in detail in: Paws::Shield::DeleteSubscription

Returns: a Paws::Shield::DeleteSubscriptionResponse instance

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.

DescribeAttack

AttackId => Str

Each argument is described in detail in: Paws::Shield::DescribeAttack

Returns: a Paws::Shield::DescribeAttackResponse instance

Describes the details of a DDoS attack.

DescribeAttackStatistics

Each argument is described in detail in: Paws::Shield::DescribeAttackStatistics

Returns: a Paws::Shield::DescribeAttackStatisticsResponse instance

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.

DescribeDRTAccess

Each argument is described in detail in: Paws::Shield::DescribeDRTAccess

Returns: a Paws::Shield::DescribeDRTAccessResponse instance

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.

DescribeEmergencyContactSettings

Each argument is described in detail in: Paws::Shield::DescribeEmergencyContactSettings

Returns: a Paws::Shield::DescribeEmergencyContactSettingsResponse instance

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.

DescribeProtection

[ProtectionId => Str]
[ResourceArn => Str]

Each argument is described in detail in: Paws::Shield::DescribeProtection

Returns: a Paws::Shield::DescribeProtectionResponse instance

Lists the details of a Protection object.

DescribeProtectionGroup

ProtectionGroupId => Str

Each argument is described in detail in: Paws::Shield::DescribeProtectionGroup

Returns: a Paws::Shield::DescribeProtectionGroupResponse instance

Returns the specification for the specified protection group.

DescribeSubscription

Each argument is described in detail in: Paws::Shield::DescribeSubscription

Returns: a Paws::Shield::DescribeSubscriptionResponse instance

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

DisableProactiveEngagement

Each argument is described in detail in: Paws::Shield::DisableProactiveEngagement

Returns: a Paws::Shield::DisableProactiveEngagementResponse instance

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

DisassociateDRTLogBucket

LogBucket => Str

Each argument is described in detail in: Paws::Shield::DisassociateDRTLogBucket

Returns: a Paws::Shield::DisassociateDRTLogBucketResponse instance

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 (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). 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.

DisassociateDRTRole

Each argument is described in detail in: Paws::Shield::DisassociateDRTRole

Returns: a Paws::Shield::DisassociateDRTRoleResponse instance

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 (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). 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.

DisassociateHealthCheck

HealthCheckArn => Str
ProtectionId => Str

Each argument is described in detail in: Paws::Shield::DisassociateHealthCheck

Returns: a Paws::Shield::DisassociateHealthCheckResponse instance

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 (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option) in the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

EnableProactiveEngagement

Each argument is described in detail in: Paws::Shield::EnableProactiveEngagement

Returns: a Paws::Shield::EnableProactiveEngagementResponse instance

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.

GetSubscriptionState

Each argument is described in detail in: Paws::Shield::GetSubscriptionState

Returns: a Paws::Shield::GetSubscriptionStateResponse instance

Returns the SubscriptionState, either Active or Inactive.

ListAttacks

[EndTime => Paws::Shield::TimeRange]
[MaxResults => Int]
[NextToken => Str]
[ResourceArns => ArrayRef[Str|Undef]]
[StartTime => Paws::Shield::TimeRange]

Each argument is described in detail in: Paws::Shield::ListAttacks

Returns: a Paws::Shield::ListAttacksResponse instance

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

ListProtectionGroups

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Shield::ListProtectionGroups

Returns: a Paws::Shield::ListProtectionGroupsResponse instance

Retrieves the ProtectionGroup objects for the account.

ListProtections

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Shield::ListProtections

Returns: a Paws::Shield::ListProtectionsResponse instance

Lists all Protection objects for the account.

ListResourcesInProtectionGroup

ProtectionGroupId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Shield::ListResourcesInProtectionGroup

Returns: a Paws::Shield::ListResourcesInProtectionGroupResponse instance

Retrieves the resources that are included in the protection group.

ListTagsForResource

ResourceARN => Str

Each argument is described in detail in: Paws::Shield::ListTagsForResource

Returns: a Paws::Shield::ListTagsForResourceResponse instance

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

TagResource

ResourceARN => Str
Tags => ArrayRef[Paws::Shield::Tag]

Each argument is described in detail in: Paws::Shield::TagResource

Returns: a Paws::Shield::TagResourceResponse instance

Adds or updates tags for a resource in AWS Shield.

UntagResource

ResourceARN => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Shield::UntagResource

Returns: a Paws::Shield::UntagResourceResponse instance

Removes tags from a resource in AWS Shield.

UpdateEmergencyContactSettings

[EmergencyContactList => ArrayRef[Paws::Shield::EmergencyContact]]

Each argument is described in detail in: Paws::Shield::UpdateEmergencyContactSettings

Returns: a Paws::Shield::UpdateEmergencyContactSettingsResponse instance

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.

UpdateProtectionGroup

Aggregation => Str
Pattern => Str
ProtectionGroupId => Str
[Members => ArrayRef[Str|Undef]]
[ResourceType => Str]

Each argument is described in detail in: Paws::Shield::UpdateProtectionGroup

Returns: a Paws::Shield::UpdateProtectionGroupResponse instance

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.

UpdateSubscription

[AutoRenew => Str]

Each argument is described in detail in: Paws::Shield::UpdateSubscription

Returns: a Paws::Shield::UpdateSubscriptionResponse instance

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllAttacks(sub { },[EndTime => Paws::Shield::TimeRange, MaxResults => Int, NextToken => Str, ResourceArns => ArrayRef[Str|Undef], StartTime => Paws::Shield::TimeRange])

ListAllAttacks([EndTime => Paws::Shield::TimeRange, MaxResults => Int, NextToken => Str, ResourceArns => ArrayRef[Str|Undef], StartTime => Paws::Shield::TimeRange])

If passed a sub as first parameter, it will call the sub for each element found in :

- AttackSummaries, passing the object as the first parameter, and the string 'AttackSummaries' as the second parameter

If not, it will return a a Paws::Shield::ListAttacksResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllProtections(sub { },[MaxResults => Int, NextToken => Str])

ListAllProtections([MaxResults => Int, NextToken => Str])