AWS SDK for PHP 3.x

Service ID: shield

Version: 2016-06-02

This page describes the parameters and results for the operations of the AWS Shield (2016-06-02), and shows how to use the Aws\Shield\ShieldClient object to call the described operations. This documentation is specific to the 2016-06-02 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateDRTLogBucket ( array $params = [] )
Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs.
AssociateDRTRole ( array $params = [] )
Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks.
AssociateHealthCheck ( array $params = [] )
Adds health-based detection to the Shield Advanced protection for a resource.
AssociateProactiveEngagementDetails ( array $params = [] )
Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use.
CreateProtection ( array $params = [] )
Enables AWS Shield Advanced for a specific AWS resource.
CreateSubscription ( array $params = [] )
Activates AWS Shield Advanced for an account.
DeleteProtection ( array $params = [] )
Deletes an AWS Shield Advanced Protection.
DeleteSubscription ( array $params = [] )
Removes AWS Shield Advanced from an account.
DescribeAttack ( array $params = [] )
Describes the details of a DDoS attack.
DescribeDRTAccess ( array $params = [] )
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 ( array $params = [] )
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 ( array $params = [] )
Lists the details of a Protection object.
DescribeSubscription ( array $params = [] )
Provides details about the AWS Shield Advanced subscription for an account.
DisableProactiveEngagement ( array $params = [] )
Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
DisassociateDRTLogBucket ( array $params = [] )
Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.
DisassociateDRTRole ( array $params = [] )
Removes the DDoS Response Team's (DRT) access to your AWS account.
DisassociateHealthCheck ( array $params = [] )
Removes health-based detection from the Shield Advanced protection for a resource.
EnableProactiveEngagement ( array $params = [] )
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 ( array $params = [] )
Returns the SubscriptionState, either Active or Inactive.
ListAttacks ( array $params = [] )
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
ListProtections ( array $params = [] )
Lists all Protection objects for the account.
UpdateEmergencyContactSettings ( array $params = [] )
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.
UpdateSubscription ( array $params = [] )
Updates the details of an existing subscription.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAttacks
ListProtections

Operations

AssociateDRTLogBucket

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

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.

Parameter Syntax

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

Parameter Details

Members

LogBucket

Required: Yes
Type: string

The Amazon S3 bucket that contains your AWS WAF logs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 specifed does not exist.
LimitsExceededException:
Exception that indicates that the operation would exceed a limit.

Type is the type of limit that would be exceeded.

Limit is the threshold that would be exceeded.
InvalidParameterException:
Exception that indicates that the parameters passed to the API are invalid.
AccessDeniedForDependencyException:
In order to grant the necessary access to the DDoS Response Team (DRT), 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 AWS 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.

AssociateDRTRole

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

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.

Parameter Syntax

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

Parameter Details

Members

RoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the role the DRT will use to access your AWS account.

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
AccessDeniedForDependencyException:
In order to grant the necessary access to the DDoS Response Team (DRT), 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 AWS 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.

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

Parameter Syntax

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

Parameter Details

Members

HealthCheckArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the health check to associate with the protection.

ProtectionId

Required: Yes
Type: string

The unique identifier (ID) for the Protection object to add the health check association to.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

Type is the type of limit that would be exceeded.

Limit is the threshold that would be exceeded.
ResourceNotFoundException:
Exception indicating the specified resource does not exist.
InvalidParameterException:
Exception that indicates that the parameters passed to the API are invalid.
OptimisticLockException:
Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

AssociateProactiveEngagementDetails

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

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.

Parameter Syntax

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

Parameter Details

Members

EmergencyContactList

Required: Yes
Type: Array of EmergencyContact structures

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

To enable proactive engagement, the contact list must include at least one phone number.

The contacts that you provide here 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 here.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
ResourceNotFoundException:
Exception indicating the specified resource does not exist.
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 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.

Parameter Syntax

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

Parameter Details

Members

Name

Required: Yes
Type: string

Friendly name for the Protection you are creating.

ResourceArn

Required: Yes
Type: string

The ARN (Amazon Resource Name) of the resource to be protected.

The ARN should be in one of the following formats:

For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
For an AWS CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
For an AWS Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id

Result Syntax

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

Result Details

Members

ProtectionId

Type: string

The unique identifier (ID) for the Protection object that is created.

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.

Type is the type of limit that would be exceeded.

Limit is the threshold that would be exceeded.
ResourceAlreadyExistsException:
Exception indicating the specified resource already exists.
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.

CreateSubscription

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

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.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteProtection

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

Deletes an AWS Shield Advanced Protection.

Parameter Syntax

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

Parameter Details

Members

ProtectionId

Required: Yes
Type: string

The unique identifier (ID) for the Protection object to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
OptimisticLockException:
Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

DeleteSubscription

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

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.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DescribeAttack

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

Describes the details of a DDoS attack.

Parameter Syntax

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

Parameter Details

Members

AttackId

Required: Yes
Type: string

The unique identifier (ID) for the attack that to be described.

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

Members

Attack

Type: AttackDetail structure

The attack that is described.

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.

DescribeDRTAccess

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

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.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

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

Result Details

Members

LogBucketList

Type: Array of strings

The list of Amazon S3 buckets accessed by the DRT.

RoleArn

Type: string

The Amazon Resource Name (ARN) of the role the DRT used to access your AWS account.

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.

DescribeEmergencyContactSettings

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

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.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

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

Result Details

Members

EmergencyContactList

Type: Array of EmergencyContact structures

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.

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

Members

ProtectionId

Type: string

The unique identifier (ID) for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.

ResourceArn

Type: string

The ARN (Amazon Resource Name) of the AWS resource for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.

Result Syntax

[
    'Protection' => [
        'HealthCheckIds' => ['<string>', ...],
        'Id' => '<string>',
        'Name' => '<string>',
        'ResourceArn' => '<string>',
    ],
]

Result Details

Members

Protection

Type: Protection structure

The Protection object that is described.

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.
ResourceNotFoundException:
Exception indicating the specified resource does not exist.

DescribeSubscription

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

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

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'Subscription' => [
        'AutoRenew' => 'ENABLED|DISABLED',
        'EndTime' => <DateTime>,
        'Limits' => [
            [
                'Max' => <integer>,
                'Type' => '<string>',
            ],
            // ...
        ],
        'ProactiveEngagementStatus' => 'ENABLED|DISABLED|PENDING',
        'StartTime' => <DateTime>,
        'TimeCommitmentInSeconds' => <integer>,
    ],
]

Result Details

Members

Subscription

Type: Subscription structure

The AWS Shield Advanced subscription details for an account.

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.

DisableProactiveEngagement

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

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

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
ResourceNotFoundException:
Exception indicating the specified resource does not exist.
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 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.

Parameter Syntax

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

Parameter Details

Members

LogBucket

Required: Yes
Type: string

The Amazon S3 bucket that contains your AWS WAF logs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 specifed does not exist.
AccessDeniedForDependencyException:
In order to grant the necessary access to the DDoS Response Team (DRT), 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 AWS 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.

DisassociateDRTRole

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

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.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

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

Parameter Syntax

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

Parameter Details

Members

HealthCheckArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the health check that is associated with the protection.

ProtectionId

Required: Yes
Type: string

The unique identifier (ID) for the Protection object to remove the health check association from.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
ResourceNotFoundException:
Exception indicating the specified resource does not exist.
OptimisticLockException:
Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

EnableProactiveEngagement

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

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.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
ResourceNotFoundException:
Exception indicating the specified resource does not exist.
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

Members

Result Syntax

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

Result Details

Members

SubscriptionState

Required: Yes
Type: string

The status of the subscription.

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

Members

EndTime

Type: TimeRange structure

The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

MaxResults

Type: int

The maximum number of AttackSummary objects to be returned. If this is left blank, the first 20 results will be returned.

This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of AttackSummary objects returned could be less than MaxResults, even if there are still more AttackSummary objects yet to return. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.

NextToken

Type: string

The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.

ResourceArns

Type: Array of strings

The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.

StartTime

Type: TimeRange structure

The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

Result Syntax

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

Result Details

Members

AttackSummaries

Type: Array of AttackSummary structures

The attack information for the specified time range.

NextToken

Type: string

The token returned by a previous call to indicate that there is more data available. If not null, more results are available. Pass this value for the NextMarker parameter in a subsequent call to ListAttacks to retrieve the next set of items.

AWS WAF might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.

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.
InvalidOperationException:
Exception that indicates that the operation would not cause any change to occur.

ListProtections

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

Lists all Protection objects for the account.

Parameter Syntax

$result = $client->listProtections([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of Protection objects to be returned. If this is left blank the first 20 results will be returned.

This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of Protection objects returned could be less than MaxResults, even if there are still more Protection objects yet to return. If there are more Protection objects to return, AWS WAF will always also return a NextToken.

NextToken

Type: string

The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.

Result Syntax

[
    'NextToken' => '<string>',
    'Protections' => [
        [
            'HealthCheckIds' => ['<string>', ...],
            'Id' => '<string>',
            'Name' => '<string>',
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.

AWS WAF might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, AWS WAF will always also return a NextToken.

Protections

Type: Array of Protection structures

The array of enabled Protection objects.

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

UpdateEmergencyContactSettings

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

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.

Parameter Syntax

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

Parameter Details

Members

EmergencyContactList

Type: Array of EmergencyContact structures

If you have proactive engagement enabled, the contact list must include at least one phone number.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

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

Members

AutoRenew

Type: string

When you initally create a subscription, AutoRenew is set to ENABLED. If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
InvalidParameterException:
Exception that indicates that the parameters passed to the API are invalid.
OptimisticLockException:
Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

Type: Array of SummarizedCounter structures

List of counters that describe the attack for the specified time period.

AttackId

Type: string

The unique identifier (ID) of the attack.

AttackProperties

Type: Array of AttackProperty structures

The array of AttackProperty objects.

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the attack ended, in Unix time in seconds. For more information see timestamp.

Mitigations

Type: Array of Mitigation structures

List of mitigation actions taken for the attack.

ResourceArn

Type: string

The ARN (Amazon Resource Name) of the resource that was attacked.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the attack started, in Unix time in seconds. For more information see timestamp.

SubResources

Type: Array of SubResourceSummary structures

If applicable, additional detail about the resource being attacked, for example, IP address or URL.

AttackProperty

Description

Details of the described attack.

Members

AttackLayer

Type: string

The type of distributed denial of service (DDoS) event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.

AttackPropertyIdentifier

Type: string

Defines the DDoS attack property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only for WordPress reflective pingback DDoS attacks.

TopContributors

Type: Array of Contributor structures

The array of Contributor objects that includes the top five contributors to an attack.

Total

Type: long (int|float)

The total contributions made to this attack by all contributors, not just the five listed in the TopContributors list.

Unit

Type: string

The unit of the Value of the contributions.

AttackSummary

Description

Summarizes all DDoS attacks for a specified time period.

Members

AttackId

Type: string

The unique identifier (ID) of the attack.

AttackVectors

Type: Array of AttackVectorDescription structures

The list of attacks for a specified time period.

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time of the attack, in Unix time in seconds. For more information see timestamp.

ResourceArn

Type: string

The ARN (Amazon Resource Name) of the resource that was attacked.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the attack, in Unix time in seconds. For more information see timestamp.

AttackVectorDescription

Description

Describes the attack.

Members

VectorType

Required: Yes
Type: string

The attack type. Valid values:

UDP_TRAFFIC
UDP_FRAGMENT
GENERIC_UDP_REFLECTION
DNS_REFLECTION
NTP_REFLECTION
CHARGEN_REFLECTION
SSDP_REFLECTION
PORT_MAPPER
RIP_REFLECTION
SNMP_REFLECTION
MSSQL_REFLECTION
NET_BIOS_REFLECTION
SYN_FLOOD
ACK_FLOOD
REQUEST_FLOOD
HTTP_REFLECTION
UDS_REFLECTION
MEMCACHED_REFLECTION

Contributor

Description

A contributor to the attack and their contribution.

Members

Name

Type: string

The name of the contributor. This is dependent on the AttackPropertyIdentifier. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States.

Value

Type: long (int|float)

The contribution of this contributor expressed in Protection units. For example 10,000.

EmergencyContact

Description

Contact information that the DRT can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.

Members

ContactNotes

Type: string

Additional notes regarding the contact.

EmailAddress

Required: Yes
Type: string

The email address for the contact.

PhoneNumber

Type: string

Type: long (int|float)

The maximum number of protections that can be created for the specified Type.

Type

Type: string

The type of protection.

LimitsExceededException

Description

Exception that indicates that the operation would exceed a limit.

Type is the type of limit that would be exceeded.

Limit is the threshold that would be exceeded.

Members

Limit

Type: long (int|float)

Type

Type: string

message

Type: string

LockedSubscriptionException

Description

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.

Members

message

Type: string

Mitigation

Description

The mitigation applied to a DDoS attack.

Members

MitigationName

Type: string

Type: Array of strings

The unique identifier (ID) for the Route 53 health check that's associated with the protection.

Id

Type: string

The unique identifier (ID) of the protection.

Name

Type: string

The friendly name of the protection. For example, My CloudFront distributions.

ResourceArn

Type: string

Type: Array of SummarizedAttackVector structures

The list of attack types and associated counters.

Counters

Type: Array of SummarizedCounter structures

The counters that describe the details of the attack.

Id

Type: string

The unique identifier (ID) of the SubResource.

Type

Type: string

The SubResource type.

Subscription

Description

Information about the AWS Shield Advanced subscription for an account.

Members

AutoRenew

Type: string

If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.

When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time your subscription will end.

Limits

Type: Array of Limit structures

Specifies how many protections of a given type you can create.

ProactiveEngagementStatus

Type: string

If ENABLED, the DDoS Response Team (DRT) will use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.

If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.

If DISABLED, the DRT will not proactively notify contacts about escalations or to initiate proactive customer support.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the subscription, in Unix time in seconds. For more information see timestamp.

TimeCommitmentInSeconds

Type: long (int|float)

The length, in seconds, of the AWS Shield Advanced subscription for the account.

SummarizedAttackVector

Description

A summary of information about the attack.

Members

VectorCounters

Type: Array of SummarizedCounter structures

The list of counters that describe the details of the attack.

VectorType

Required: Yes
Type: string

The attack type, for example, SNMP reflection or SYN flood.

SummarizedCounter

Description

The counter that describes a DDoS attack.

Members

Average

Type: double

The average value of the counter for a specified time period.

Max

Type: double

The maximum value of the counter for a specified time period.

N

Type: int

The number of counters for a specified time period.

Name

Type: string

The counter name.

Sum

Type: double

The total of counter values for a specified time period.

Unit

Type: string

The unit of the counters.

TimeRange

Description

The time range.

Members

FromInclusive

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time, in Unix time in seconds. For more information see timestamp.

ToExclusive

Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time, in Unix time in seconds. For more information see timestamp.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Shield 2016-06-02

Operation Summary

Paginators

Operations

AssociateDRTLogBucket

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateDRTRole

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateHealthCheck

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateProactiveEngagementDetails

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateProtection

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateSubscription

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteProtection

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteSubscription

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeAttack

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeDRTAccess

Parameter Syntax

Parameter Details

Members

Result Syntax