AssociateDRTLogBucket

$result = $client->associateDRTLogBucket([/* ... */]);
$promise = $client->associateDRTLogBucketAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateDRTLogBucket([
    'LogBucket' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

NoAssociatedRoleException:

The ARN of the role that you specified does not exist.

LimitsExceededException:

Exception that indicates that the operation would exceed a limit.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

AccessDeniedForDependencyException:

In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an Amazon Web Services Service.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

AssociateDRTRole

$result = $client->associateDRTRole([/* ... */]);
$promise = $client->associateDRTRoleAsync([/* ... */]);

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 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 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 principal drt.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 an AssociateDRTRole 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.

Parameter Syntax

$result = $client->associateDRTRole([
    'RoleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

AccessDeniedForDependencyException:

In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an Amazon Web Services Service.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

AssociateHealthCheck

$result = $client->associateHealthCheck([/* ... */]);
$promise = $client->associateHealthCheckAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateHealthCheck([
    'HealthCheckArn' => '<string>', // REQUIRED
    'ProtectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

LimitsExceededException:

Exception that indicates that the operation would exceed a limit.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

InvalidResourceException:

Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

AssociateProactiveEngagementDetails

$result = $client->associateProactiveEngagementDetails([/* ... */]);
$promise = $client->associateProactiveEngagementDetailsAsync([/* ... */]);

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 and EnableProactiveEngagement.

Parameter Syntax

$result = $client->associateProactiveEngagementDetails([
    'EmergencyContactList' => [ // REQUIRED
        [
            'ContactNotes' => '<string>',
            'EmailAddress' => '<string>', // REQUIRED
            'PhoneNumber' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

CreateProtection

$result = $client->createProtection([/* ... */]);
$promise = $client->createProtectionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createProtection([
    'Name' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ProtectionId' => '<string>',
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidResourceException:

Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

LimitsExceededException:

Exception that indicates that the operation would exceed a limit.

ResourceAlreadyExistsException:

Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

CreateProtectionGroup

$result = $client->createProtectionGroup([/* ... */]);
$promise = $client->createProtectionGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createProtectionGroup([
    'Aggregation' => 'SUM|MEAN|MAX', // REQUIRED
    'Members' => ['<string>', ...],
    'Pattern' => 'ALL|ARBITRARY|BY_RESOURCE_TYPE', // REQUIRED
    'ProtectionGroupId' => '<string>', // REQUIRED
    'ResourceType' => 'CLOUDFRONT_DISTRIBUTION|ROUTE_53_HOSTED_ZONE|ELASTIC_IP_ALLOCATION|CLASSIC_LOAD_BALANCER|APPLICATION_LOAD_BALANCER|GLOBAL_ACCELERATOR',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceAlreadyExistsException:

Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

LimitsExceededException:

Exception that indicates that the operation would exceed a limit.

CreateSubscription

$result = $client->createSubscription([/* ... */]);
$promise = $client->createSubscriptionAsync([/* ... */]);

Activates Shield Advanced for an account.

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.

Parameter Syntax

$result = $client->createSubscription([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceAlreadyExistsException:

Exception indicating the specified resource already exists. If available, this exception includes details in additional properties.

DeleteProtection

$result = $client->deleteProtection([/* ... */]);
$promise = $client->deleteProtectionAsync([/* ... */]);

Deletes an Shield Advanced Protection.

Parameter Syntax

$result = $client->deleteProtection([
    'ProtectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

DeleteProtectionGroup

$result = $client->deleteProtectionGroup([/* ... */]);
$promise = $client->deleteProtectionGroupAsync([/* ... */]);

Removes the specified protection group.

Parameter Syntax

$result = $client->deleteProtectionGroup([
    'ProtectionGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

DeleteSubscription

$result = $client->deleteSubscription([/* ... */]);
$promise = $client->deleteSubscriptionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteSubscription([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

LockedSubscriptionException:

You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

DescribeAttack

$result = $client->describeAttack([/* ... */]);
$promise = $client->describeAttackAsync([/* ... */]);

Describes the details of a DDoS attack.

Parameter Syntax

$result = $client->describeAttack([
    'AttackId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attack' => [
        'AttackCounters' => [
            [
                'Average' => <float>,
                'Max' => <float>,
                'N' => <integer>,
                'Name' => '<string>',
                'Sum' => <float>,
                'Unit' => '<string>',
            ],
            // ...
        ],
        'AttackId' => '<string>',
        'AttackProperties' => [
            [
                'AttackLayer' => 'NETWORK|APPLICATION',
                'AttackPropertyIdentifier' => 'DESTINATION_URL|REFERRER|SOURCE_ASN|SOURCE_COUNTRY|SOURCE_IP_ADDRESS|SOURCE_USER_AGENT|WORDPRESS_PINGBACK_REFLECTOR|WORDPRESS_PINGBACK_SOURCE',
                'TopContributors' => [
                    [
                        'Name' => '<string>',
                        'Value' => <integer>,
                    ],
                    // ...
                ],
                'Total' => <integer>,
                'Unit' => 'BITS|BYTES|PACKETS|REQUESTS',
            ],
            // ...
        ],
        'EndTime' => <DateTime>,
        'Mitigations' => [
            [
                'MitigationName' => '<string>',
            ],
            // ...
        ],
        'ResourceArn' => '<string>',
        'StartTime' => <DateTime>,
        'SubResources' => [
            [
                'AttackVectors' => [
                    [
                        'VectorCounters' => [
                            [
                                'Average' => <float>,
                                'Max' => <float>,
                                'N' => <integer>,
                                'Name' => '<string>',
                                'Sum' => <float>,
                                'Unit' => '<string>',
                            ],
                            // ...
                        ],
                        'VectorType' => '<string>',
                    ],
                    // ...
                ],
                'Counters' => [
                    [
                        'Average' => <float>,
                        'Max' => <float>,
                        'N' => <integer>,
                        'Name' => '<string>',
                        'Sum' => <float>,
                        'Unit' => '<string>',
                    ],
                    // ...
                ],
                'Id' => '<string>',
                'Type' => 'IP|URL',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

AccessDeniedException:

Exception that indicates the specified AttackId does not exist, or the requester does not have the appropriate permissions to access the AttackId.

DescribeAttackStatistics

$result = $client->describeAttackStatistics([/* ... */]);
$promise = $client->describeAttackStatisticsAsync([/* ... */]);

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 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.

Parameter Syntax

$result = $client->describeAttackStatistics([
]);

Parameter Details

Result Syntax

[
    'DataItems' => [
        [
            'AttackCount' => <integer>,
            'AttackVolume' => [
                'BitsPerSecond' => [
                    'Max' => <float>,
                ],
                'PacketsPerSecond' => [
                    'Max' => <float>,
                ],
                'RequestsPerSecond' => [
                    'Max' => <float>,
                ],
            ],
        ],
        // ...
    ],
    'TimeRange' => [
        'FromInclusive' => <DateTime>,
        'ToExclusive' => <DateTime>,
    ],
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

DescribeDRTAccess

$result = $client->describeDRTAccess([/* ... */]);
$promise = $client->describeDRTAccessAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeDRTAccess([
]);

Parameter Details

Result Syntax

[
    'LogBucketList' => ['<string>', ...],
    'RoleArn' => '<string>',
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

DescribeEmergencyContactSettings

$result = $client->describeEmergencyContactSettings([/* ... */]);
$promise = $client->describeEmergencyContactSettingsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeEmergencyContactSettings([
]);

Parameter Details

Result Syntax

[
    'EmergencyContactList' => [
        [
            'ContactNotes' => '<string>',
            'EmailAddress' => '<string>',
            'PhoneNumber' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

DescribeProtection

$result = $client->describeProtection([/* ... */]);
$promise = $client->describeProtectionAsync([/* ... */]);

Lists the details of a Protection object.

Parameter Syntax

$result = $client->describeProtection([
    'ProtectionId' => '<string>',
    'ResourceArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Protection' => [
        'ApplicationLayerAutomaticResponseConfiguration' => [
            'Action' => [
                'Block' => [
                ],
                'Count' => [
                ],
            ],
            'Status' => 'ENABLED|DISABLED',
        ],
        'HealthCheckIds' => ['<string>', ...],
        'Id' => '<string>',
        'Name' => '<string>',
        'ProtectionArn' => '<string>',
        'ResourceArn' => '<string>',
    ],
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

DescribeProtectionGroup

$result = $client->describeProtectionGroup([/* ... */]);
$promise = $client->describeProtectionGroupAsync([/* ... */]);

Returns the specification for the specified protection group.

Parameter Syntax

$result = $client->describeProtectionGroup([
    'ProtectionGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProtectionGroup' => [
        'Aggregation' => 'SUM|MEAN|MAX',
        'Members' => ['<string>', ...],
        'Pattern' => 'ALL|ARBITRARY|BY_RESOURCE_TYPE',
        'ProtectionGroupArn' => '<string>',
        'ProtectionGroupId' => '<string>',
        'ResourceType' => 'CLOUDFRONT_DISTRIBUTION|ROUTE_53_HOSTED_ZONE|ELASTIC_IP_ALLOCATION|CLASSIC_LOAD_BALANCER|APPLICATION_LOAD_BALANCER|GLOBAL_ACCELERATOR',
    ],
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

DescribeSubscription

$result = $client->describeSubscription([/* ... */]);
$promise = $client->describeSubscriptionAsync([/* ... */]);

Provides details about the Shield Advanced subscription for an account.

Parameter Syntax

$result = $client->describeSubscription([
]);

Parameter Details

Result Syntax

[
    'Subscription' => [
        'AutoRenew' => 'ENABLED|DISABLED',
        'EndTime' => <DateTime>,
        'Limits' => [
            [
                'Max' => <integer>,
                'Type' => '<string>',
            ],
            // ...
        ],
        'ProactiveEngagementStatus' => 'ENABLED|DISABLED|PENDING',
        'StartTime' => <DateTime>,
        'SubscriptionArn' => '<string>',
        'SubscriptionLimits' => [
            'ProtectionGroupLimits' => [
                'MaxProtectionGroups' => <integer>,
                'PatternTypeLimits' => [
                    'ArbitraryPatternLimits' => [
                        'MaxMembers' => <integer>,
                    ],
                ],
            ],
            'ProtectionLimits' => [
                'ProtectedResourceTypeLimits' => [
                    [
                        'Max' => <integer>,
                        'Type' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        'TimeCommitmentInSeconds' => <integer>,
    ],
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

DisableApplicationLayerAutomaticResponse

$result = $client->disableApplicationLayerAutomaticResponse([/* ... */]);
$promise = $client->disableApplicationLayerAutomaticResponseAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disableApplicationLayerAutomaticResponse([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

DisableProactiveEngagement

$result = $client->disableProactiveEngagement([/* ... */]);
$promise = $client->disableProactiveEngagementAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disableProactiveEngagement([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

DisassociateDRTLogBucket

$result = $client->disassociateDRTLogBucket([/* ... */]);
$promise = $client->disassociateDRTLogBucketAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateDRTLogBucket([
    'LogBucket' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

NoAssociatedRoleException:

The ARN of the role that you specified does not exist.

AccessDeniedForDependencyException:

In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an Amazon Web Services Service.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

DisassociateDRTRole

$result = $client->disassociateDRTRole([/* ... */]);
$promise = $client->disassociateDRTRoleAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateDRTRole([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

DisassociateHealthCheck

$result = $client->disassociateHealthCheck([/* ... */]);
$promise = $client->disassociateHealthCheckAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disassociateHealthCheck([
    'HealthCheckArn' => '<string>', // REQUIRED
    'ProtectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

InvalidResourceException:

Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

EnableApplicationLayerAutomaticResponse

$result = $client->enableApplicationLayerAutomaticResponse([/* ... */]);
$promise = $client->enableApplicationLayerAutomaticResponseAsync([/* ... */]);

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

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.

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.

Parameter Syntax

$result = $client->enableApplicationLayerAutomaticResponse([
    'Action' => [ // REQUIRED
        'Block' => [
        ],
        'Count' => [
        ],
    ],
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

LimitsExceededException:

Exception that indicates that the operation would exceed a limit.

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

EnableProactiveEngagement

$result = $client->enableProactiveEngagement([/* ... */]);
$promise = $client->enableProactiveEngagementAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->enableProactiveEngagement([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

GetSubscriptionState

$result = $client->getSubscriptionState([/* ... */]);
$promise = $client->getSubscriptionStateAsync([/* ... */]);

Returns the SubscriptionState, either Active or Inactive.

Parameter Syntax

$result = $client->getSubscriptionState([
]);

Parameter Details

Result Syntax

[
    'SubscriptionState' => 'ACTIVE|INACTIVE',
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ListAttacks

$result = $client->listAttacks([/* ... */]);
$promise = $client->listAttacksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAttacks([
    'EndTime' => [
        'FromInclusive' => <integer || string || DateTime>,
        'ToExclusive' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArns' => ['<string>', ...],
    'StartTime' => [
        'FromInclusive' => <integer || string || DateTime>,
        'ToExclusive' => <integer || string || DateTime>,
    ],
]);

Parameter Details

Result Syntax

[
    'AttackSummaries' => [
        [
            'AttackId' => '<string>',
            'AttackVectors' => [
                [
                    'VectorType' => '<string>',
                ],
                // ...
            ],
            'EndTime' => <DateTime>,
            'ResourceArn' => '<string>',
            'StartTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

ListProtectionGroups

$result = $client->listProtectionGroups([/* ... */]);
$promise = $client->listProtectionGroupsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listProtectionGroups([
    'InclusionFilters' => [
        'Aggregations' => ['<string>', ...],
        'Patterns' => ['<string>', ...],
        'ProtectionGroupIds' => ['<string>', ...],
        'ResourceTypes' => ['<string>', ...],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProtectionGroups' => [
        [
            'Aggregation' => 'SUM|MEAN|MAX',
            'Members' => ['<string>', ...],
            'Pattern' => 'ALL|ARBITRARY|BY_RESOURCE_TYPE',
            'ProtectionGroupArn' => '<string>',
            'ProtectionGroupId' => '<string>',
            'ResourceType' => 'CLOUDFRONT_DISTRIBUTION|ROUTE_53_HOSTED_ZONE|ELASTIC_IP_ALLOCATION|CLASSIC_LOAD_BALANCER|APPLICATION_LOAD_BALANCER|GLOBAL_ACCELERATOR',
        ],
        // ...
    ],
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidPaginationTokenException:

Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the prior response.

ListProtections

$result = $client->listProtections([/* ... */]);
$promise = $client->listProtectionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listProtections([
    'InclusionFilters' => [
        'ProtectionNames' => ['<string>', ...],
        'ResourceArns' => ['<string>', ...],
        'ResourceTypes' => ['<string>', ...],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Protections' => [
        [
            'ApplicationLayerAutomaticResponseConfiguration' => [
                'Action' => [
                    'Block' => [
                    ],
                    'Count' => [
                    ],
                ],
                'Status' => 'ENABLED|DISABLED',
            ],
            'HealthCheckIds' => ['<string>', ...],
            'Id' => '<string>',
            'Name' => '<string>',
            'ProtectionArn' => '<string>',
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidPaginationTokenException:

Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the prior response.

ListResourcesInProtectionGroup

$result = $client->listResourcesInProtectionGroup([/* ... */]);
$promise = $client->listResourcesInProtectionGroupAsync([/* ... */]);

Retrieves the resources that are included in the protection group.

Parameter Syntax

$result = $client->listResourcesInProtectionGroup([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProtectionGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceArns' => ['<string>', ...],
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidPaginationTokenException:

Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the prior response.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidResourceException:

Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or updates tags for a resource in Shield.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidResourceException:

Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a resource in Shield.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidResourceException:

Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

UpdateApplicationLayerAutomaticResponse

$result = $client->updateApplicationLayerAutomaticResponse([/* ... */]);
$promise = $client->updateApplicationLayerAutomaticResponseAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateApplicationLayerAutomaticResponse([
    'Action' => [ // REQUIRED
        'Block' => [
        ],
        'Count' => [
        ],
    ],
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

InvalidOperationException:

Exception that indicates that the operation would not cause any change to occur.

UpdateEmergencyContactSettings

$result = $client->updateEmergencyContactSettings([/* ... */]);
$promise = $client->updateEmergencyContactSettingsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateEmergencyContactSettings([
    'EmergencyContactList' => [
        [
            'ContactNotes' => '<string>',
            'EmailAddress' => '<string>', // REQUIRED
            'PhoneNumber' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

UpdateProtectionGroup

$result = $client->updateProtectionGroup([/* ... */]);
$promise = $client->updateProtectionGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateProtectionGroup([
    'Aggregation' => 'SUM|MEAN|MAX', // REQUIRED
    'Members' => ['<string>', ...],
    'Pattern' => 'ALL|ARBITRARY|BY_RESOURCE_TYPE', // REQUIRED
    'ProtectionGroupId' => '<string>', // REQUIRED
    'ResourceType' => 'CLOUDFRONT_DISTRIBUTION|ROUTE_53_HOSTED_ZONE|ELASTIC_IP_ALLOCATION|CLASSIC_LOAD_BALANCER|APPLICATION_LOAD_BALANCER|GLOBAL_ACCELERATOR',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

UpdateSubscription

$result = $client->updateSubscription([/* ... */]);
$promise = $client->updateSubscriptionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateSubscription([
    'AutoRenew' => 'ENABLED|DISABLED',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalErrorException:

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

LockedSubscriptionException:

You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.

ResourceNotFoundException:

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

InvalidParameterException:

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

OptimisticLockException:

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.