@aws-sdk/client-shield 3.295.0 → 3.297.0

package/dist-types/Shield.d.ts

@@ -37,6 +37,7 @@ import { UpdateProtectionGroupCommandInput, UpdateProtectionGroupCommandOutput }
 import { UpdateSubscriptionCommandInput, UpdateSubscriptionCommandOutput } from "./commands/UpdateSubscriptionCommand";
 import { ShieldClient } from "./ShieldClient";
 /**
+ * @public
  * <fullname>Shield Advanced</fullname>
  *          <p>This is the <i>Shield Advanced API Reference</i>. This guide is for developers who need detailed information about the Shield Advanced API actions,
  *          data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the
@@ -44,6 +45,7 @@ import { ShieldClient } from "./ShieldClient";
  */
 export declare class Shield extends ShieldClient {
     /**
+     * @public
      * <p>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.</p>
      *          <p>To use the services of the SRT and make an <code>AssociateDRTLogBucket</code> request, you must be subscribed to the <a href="http://aws.amazon.com/premiumsupport/business-support/">Business Support plan</a> or the <a href="http://aws.amazon.com/premiumsupport/enterprise-support/">Enterprise Support plan</a>.</p>
      */
@@ -51,6 +53,7 @@ export declare class Shield extends ShieldClient {
     associateDRTLogBucket(args: AssociateDRTLogBucketCommandInput, cb: (err: any, data?: AssociateDRTLogBucketCommandOutput) => void): void;
     associateDRTLogBucket(args: AssociateDRTLogBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDRTLogBucketCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
      *          <p>You can associate only one <code>RoleArn</code> with your subscription. If you submit an <code>AssociateDRTRole</code> request for an account that already has an associated role, the new <code>RoleArn</code> will replace the existing <code>RoleArn</code>. </p>
      *          <p>Prior to making the <code>AssociateDRTRole</code> request, you must attach the <code>AWSShieldDRTAccessPolicy</code> managed policy to the role that you'll specify in the request. You can access this policy in the IAM console at <a href="https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy">AWSShieldDRTAccessPolicy</a>. For more information see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html">Adding and removing IAM identity permissions</a>. The role must also trust the service principal
@@ -64,6 +67,7 @@ export declare class Shield extends ShieldClient {
     associateDRTRole(args: AssociateDRTRoleCommandInput, cb: (err: any, data?: AssociateDRTRoleCommandOutput) => void): void;
     associateDRTRole(args: AssociateDRTRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDRTRoleCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.  </p>
      *          <p>You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option">Shield Advanced Health-Based Detection</a> in the <i>WAF Developer Guide</i>. </p>
      */
@@ -71,6 +75,7 @@ export declare class Shield extends ShieldClient {
     associateHealthCheck(args: AssociateHealthCheckCommandInput, cb: (err: any, data?: AssociateHealthCheckCommandOutput) => void): void;
     associateHealthCheck(args: AssociateHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateHealthCheckCommandOutput) => void): void;
     /**
+     * @public
      * <p>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. </p>
      *          <p>After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls <code>DisableProactiveEngagement</code> and <code>EnableProactiveEngagement</code>.  </p>
      *          <note>
@@ -82,6 +87,7 @@ export declare class Shield extends ShieldClient {
     associateProactiveEngagementDetails(args: AssociateProactiveEngagementDetailsCommandInput, cb: (err: any, data?: AssociateProactiveEngagementDetailsCommandOutput) => void): void;
     associateProactiveEngagementDetails(args: AssociateProactiveEngagementDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateProactiveEngagementDetailsCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
      *          <p>You can add protection to only a single resource with each <code>CreateProtection</code> request. You can add protection to multiple resources
      *           at once through the Shield Advanced console at <a href="https://console.aws.amazon.com/wafv2/shieldv2#/">https://console.aws.amazon.com/wafv2/shieldv2#/</a>.
@@ -93,12 +99,14 @@ export declare class Shield extends ShieldClient {
     createProtection(args: CreateProtectionCommandInput, cb: (err: any, data?: CreateProtectionCommandOutput) => void): void;
     createProtection(args: CreateProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProtectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>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. </p>
      */
     createProtectionGroup(args: CreateProtectionGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateProtectionGroupCommandOutput>;
     createProtectionGroup(args: CreateProtectionGroupCommandInput, cb: (err: any, data?: CreateProtectionGroupCommandOutput) => void): void;
     createProtectionGroup(args: CreateProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProtectionGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Activates Shield Advanced for an account.</p>
      *          <note>
      *             <p>For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account,
@@ -110,18 +118,21 @@ export declare class Shield extends ShieldClient {
     createSubscription(args: CreateSubscriptionCommandInput, cb: (err: any, data?: CreateSubscriptionCommandOutput) => void): void;
     createSubscription(args: CreateSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriptionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes an Shield Advanced <a>Protection</a>.</p>
      */
     deleteProtection(args: DeleteProtectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProtectionCommandOutput>;
     deleteProtection(args: DeleteProtectionCommandInput, cb: (err: any, data?: DeleteProtectionCommandOutput) => void): void;
     deleteProtection(args: DeleteProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProtectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes the specified protection group.</p>
      */
     deleteProtectionGroup(args: DeleteProtectionGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProtectionGroupCommandOutput>;
     deleteProtectionGroup(args: DeleteProtectionGroupCommandInput, cb: (err: any, data?: DeleteProtectionGroupCommandOutput) => void): void;
     deleteProtectionGroup(args: DeleteProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProtectionGroupCommandOutput) => void): void;
     /**
+     * @public
      * @deprecated
      *
      * <p>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. </p>
@@ -130,12 +141,14 @@ export declare class Shield extends ShieldClient {
     deleteSubscription(args: DeleteSubscriptionCommandInput, cb: (err: any, data?: DeleteSubscriptionCommandOutput) => void): void;
     deleteSubscription(args: DeleteSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriptionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes the details of a DDoS attack. </p>
      */
     describeAttack(args: DescribeAttackCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAttackCommandOutput>;
     describeAttack(args: DescribeAttackCommandInput, cb: (err: any, data?: DescribeAttackCommandOutput) => void): void;
     describeAttack(args: DescribeAttackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAttackCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
      *          <p>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 <code>2020-10-26 15:39:32 PDT</code>, equal to <code>2020-10-26 22:39:32 UTC</code>, then the time range for the attack data returned is from <code>2019-10-26 00:00:00 UTC</code> to <code>2020-10-26 00:00:00 UTC</code>. </p>
      *          <p>The time range indicates the period covered by the attack statistics data items.</p>
@@ -144,36 +157,42 @@ export declare class Shield extends ShieldClient {
     describeAttackStatistics(args: DescribeAttackStatisticsCommandInput, cb: (err: any, data?: DescribeAttackStatisticsCommandOutput) => void): void;
     describeAttackStatistics(args: DescribeAttackStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAttackStatisticsCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
      */
     describeDRTAccess(args: DescribeDRTAccessCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDRTAccessCommandOutput>;
     describeDRTAccess(args: DescribeDRTAccessCommandInput, cb: (err: any, data?: DescribeDRTAccessCommandOutput) => void): void;
     describeDRTAccess(args: DescribeDRTAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDRTAccessCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
      */
     describeEmergencyContactSettings(args: DescribeEmergencyContactSettingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEmergencyContactSettingsCommandOutput>;
     describeEmergencyContactSettings(args: DescribeEmergencyContactSettingsCommandInput, cb: (err: any, data?: DescribeEmergencyContactSettingsCommandOutput) => void): void;
     describeEmergencyContactSettings(args: DescribeEmergencyContactSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEmergencyContactSettingsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the details of a <a>Protection</a> object.</p>
      */
     describeProtection(args: DescribeProtectionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeProtectionCommandOutput>;
     describeProtection(args: DescribeProtectionCommandInput, cb: (err: any, data?: DescribeProtectionCommandOutput) => void): void;
     describeProtection(args: DescribeProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProtectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the specification for the specified protection group.</p>
      */
     describeProtectionGroup(args: DescribeProtectionGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeProtectionGroupCommandOutput>;
     describeProtectionGroup(args: DescribeProtectionGroupCommandInput, cb: (err: any, data?: DescribeProtectionGroupCommandOutput) => void): void;
     describeProtectionGroup(args: DescribeProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProtectionGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Provides details about the Shield Advanced subscription for an account.</p>
      */
     describeSubscription(args: DescribeSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSubscriptionCommandOutput>;
     describeSubscription(args: DescribeSubscriptionCommandInput, cb: (err: any, data?: DescribeSubscriptionCommandOutput) => void): void;
     describeSubscription(args: DescribeSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscriptionCommandOutput) => void): void;
     /**
+     * @public
      * <p>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. </p>
      */
@@ -181,24 +200,28 @@ export declare class Shield extends ShieldClient {
     disableApplicationLayerAutomaticResponse(args: DisableApplicationLayerAutomaticResponseCommandInput, cb: (err: any, data?: DisableApplicationLayerAutomaticResponseCommandOutput) => void): void;
     disableApplicationLayerAutomaticResponse(args: DisableApplicationLayerAutomaticResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableApplicationLayerAutomaticResponseCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.</p>
      */
     disableProactiveEngagement(args: DisableProactiveEngagementCommandInput, options?: __HttpHandlerOptions): Promise<DisableProactiveEngagementCommandOutput>;
     disableProactiveEngagement(args: DisableProactiveEngagementCommandInput, cb: (err: any, data?: DisableProactiveEngagementCommandOutput) => void): void;
     disableProactiveEngagement(args: DisableProactiveEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableProactiveEngagementCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.</p>
      */
     disassociateDRTLogBucket(args: DisassociateDRTLogBucketCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateDRTLogBucketCommandOutput>;
     disassociateDRTLogBucket(args: DisassociateDRTLogBucketCommandInput, cb: (err: any, data?: DisassociateDRTLogBucketCommandOutput) => void): void;
     disassociateDRTLogBucket(args: DisassociateDRTLogBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDRTLogBucketCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.</p>
      */
     disassociateDRTRole(args: DisassociateDRTRoleCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateDRTRoleCommandOutput>;
     disassociateDRTRole(args: DisassociateDRTRoleCommandInput, cb: (err: any, data?: DisassociateDRTRoleCommandOutput) => void): void;
     disassociateDRTRole(args: DisassociateDRTRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDRTRoleCommandOutput) => void): void;
     /**
+     * @public
      * <p>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. </p>
      *          <p>You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option">Shield Advanced Health-Based Detection</a> in the <i>WAF Developer Guide</i>. </p>
      */
@@ -206,6 +229,7 @@ export declare class Shield extends ShieldClient {
     disassociateHealthCheck(args: DisassociateHealthCheckCommandInput, cb: (err: any, data?: DisassociateHealthCheckCommandOutput) => void): void;
     disassociateHealthCheck(args: DisassociateHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateHealthCheckCommandOutput) => void): void;
     /**
+     * @public
      * <p>Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource. </p>
      *          <note>
      *             <p>This feature is available for Amazon CloudFront distributions and Application Load Balancers only.</p>
@@ -226,18 +250,21 @@ export declare class Shield extends ShieldClient {
     enableApplicationLayerAutomaticResponse(args: EnableApplicationLayerAutomaticResponseCommandInput, cb: (err: any, data?: EnableApplicationLayerAutomaticResponseCommandOutput) => void): void;
     enableApplicationLayerAutomaticResponse(args: EnableApplicationLayerAutomaticResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableApplicationLayerAutomaticResponseCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
      */
     enableProactiveEngagement(args: EnableProactiveEngagementCommandInput, options?: __HttpHandlerOptions): Promise<EnableProactiveEngagementCommandOutput>;
     enableProactiveEngagement(args: EnableProactiveEngagementCommandInput, cb: (err: any, data?: EnableProactiveEngagementCommandOutput) => void): void;
     enableProactiveEngagement(args: EnableProactiveEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableProactiveEngagementCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the <code>SubscriptionState</code>, either <code>Active</code> or <code>Inactive</code>.</p>
      */
     getSubscriptionState(args: GetSubscriptionStateCommandInput, options?: __HttpHandlerOptions): Promise<GetSubscriptionStateCommandOutput>;
     getSubscriptionState(args: GetSubscriptionStateCommandInput, cb: (err: any, data?: GetSubscriptionStateCommandOutput) => void): void;
     getSubscriptionState(args: GetSubscriptionStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionStateCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns all ongoing DDoS attacks or all DDoS attacks during a specified time
      *          period.</p>
      */
@@ -245,6 +272,7 @@ export declare class Shield extends ShieldClient {
     listAttacks(args: ListAttacksCommandInput, cb: (err: any, data?: ListAttacksCommandOutput) => void): void;
     listAttacks(args: ListAttacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttacksCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves <a>ProtectionGroup</a> 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. </p>
      */
@@ -252,6 +280,7 @@ export declare class Shield extends ShieldClient {
     listProtectionGroups(args: ListProtectionGroupsCommandInput, cb: (err: any, data?: ListProtectionGroupsCommandOutput) => void): void;
     listProtectionGroups(args: ListProtectionGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProtectionGroupsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves <a>Protection</a> 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. </p>
      */
@@ -259,48 +288,56 @@ export declare class Shield extends ShieldClient {
     listProtections(args: ListProtectionsCommandInput, cb: (err: any, data?: ListProtectionsCommandOutput) => void): void;
     listProtections(args: ListProtectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProtectionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the resources that are included in the protection group. </p>
      */
     listResourcesInProtectionGroup(args: ListResourcesInProtectionGroupCommandInput, options?: __HttpHandlerOptions): Promise<ListResourcesInProtectionGroupCommandOutput>;
     listResourcesInProtectionGroup(args: ListResourcesInProtectionGroupCommandInput, cb: (err: any, data?: ListResourcesInProtectionGroupCommandOutput) => void): void;
     listResourcesInProtectionGroup(args: ListResourcesInProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesInProtectionGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.</p>
      */
     listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Adds or updates tags for a resource in Shield.</p>
      */
     tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes tags from a resource in Shield.</p>
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.</p>
      */
     updateApplicationLayerAutomaticResponse(args: UpdateApplicationLayerAutomaticResponseCommandInput, options?: __HttpHandlerOptions): Promise<UpdateApplicationLayerAutomaticResponseCommandOutput>;
     updateApplicationLayerAutomaticResponse(args: UpdateApplicationLayerAutomaticResponseCommandInput, cb: (err: any, data?: UpdateApplicationLayerAutomaticResponseCommandOutput) => void): void;
     updateApplicationLayerAutomaticResponse(args: UpdateApplicationLayerAutomaticResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationLayerAutomaticResponseCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
      */
     updateEmergencyContactSettings(args: UpdateEmergencyContactSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEmergencyContactSettingsCommandOutput>;
     updateEmergencyContactSettings(args: UpdateEmergencyContactSettingsCommandInput, cb: (err: any, data?: UpdateEmergencyContactSettingsCommandOutput) => void): void;
     updateEmergencyContactSettings(args: UpdateEmergencyContactSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEmergencyContactSettingsCommandOutput) => void): void;
     /**
+     * @public
      * <p>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. </p>
      */
     updateProtectionGroup(args: UpdateProtectionGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateProtectionGroupCommandOutput>;
     updateProtectionGroup(args: UpdateProtectionGroupCommandInput, cb: (err: any, data?: UpdateProtectionGroupCommandOutput) => void): void;
     updateProtectionGroup(args: UpdateProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProtectionGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.</p>
      *          <note>
      *             <p>For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account,

package/dist-types/ShieldClient.d.ts

@@ -44,15 +44,24 @@ import { UpdateEmergencyContactSettingsCommandInput, UpdateEmergencyContactSetti
 import { UpdateProtectionGroupCommandInput, UpdateProtectionGroupCommandOutput } from "./commands/UpdateProtectionGroupCommand";
 import { UpdateSubscriptionCommandInput, UpdateSubscriptionCommandOutput } from "./commands/UpdateSubscriptionCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = AssociateDRTLogBucketCommandInput | AssociateDRTRoleCommandInput | AssociateHealthCheckCommandInput | AssociateProactiveEngagementDetailsCommandInput | CreateProtectionCommandInput | CreateProtectionGroupCommandInput | CreateSubscriptionCommandInput | DeleteProtectionCommandInput | DeleteProtectionGroupCommandInput | DeleteSubscriptionCommandInput | DescribeAttackCommandInput | DescribeAttackStatisticsCommandInput | DescribeDRTAccessCommandInput | DescribeEmergencyContactSettingsCommandInput | DescribeProtectionCommandInput | DescribeProtectionGroupCommandInput | DescribeSubscriptionCommandInput | DisableApplicationLayerAutomaticResponseCommandInput | DisableProactiveEngagementCommandInput | DisassociateDRTLogBucketCommandInput | DisassociateDRTRoleCommandInput | DisassociateHealthCheckCommandInput | EnableApplicationLayerAutomaticResponseCommandInput | EnableProactiveEngagementCommandInput | GetSubscriptionStateCommandInput | ListAttacksCommandInput | ListProtectionGroupsCommandInput | ListProtectionsCommandInput | ListResourcesInProtectionGroupCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateApplicationLayerAutomaticResponseCommandInput | UpdateEmergencyContactSettingsCommandInput | UpdateProtectionGroupCommandInput | UpdateSubscriptionCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = AssociateDRTLogBucketCommandOutput | AssociateDRTRoleCommandOutput | AssociateHealthCheckCommandOutput | AssociateProactiveEngagementDetailsCommandOutput | CreateProtectionCommandOutput | CreateProtectionGroupCommandOutput | CreateSubscriptionCommandOutput | DeleteProtectionCommandOutput | DeleteProtectionGroupCommandOutput | DeleteSubscriptionCommandOutput | DescribeAttackCommandOutput | DescribeAttackStatisticsCommandOutput | DescribeDRTAccessCommandOutput | DescribeEmergencyContactSettingsCommandOutput | DescribeProtectionCommandOutput | DescribeProtectionGroupCommandOutput | DescribeSubscriptionCommandOutput | DisableApplicationLayerAutomaticResponseCommandOutput | DisableProactiveEngagementCommandOutput | DisassociateDRTLogBucketCommandOutput | DisassociateDRTRoleCommandOutput | DisassociateHealthCheckCommandOutput | EnableApplicationLayerAutomaticResponseCommandOutput | EnableProactiveEngagementCommandOutput | GetSubscriptionStateCommandOutput | ListAttacksCommandOutput | ListProtectionGroupsCommandOutput | ListProtectionsCommandOutput | ListResourcesInProtectionGroupCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateApplicationLayerAutomaticResponseCommandOutput | UpdateEmergencyContactSettingsCommandOutput | UpdateProtectionGroupCommandOutput | UpdateSubscriptionCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -142,23 +151,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type ShieldClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of ShieldClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of ShieldClient class constructor that set the region, credentials and other options.
  */
 export interface ShieldClientConfig extends ShieldClientConfigType {
 }
+/**
+ * @public
+ */
 type ShieldClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of ShieldClient class. This is resolved and normalized from the {@link ShieldClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of ShieldClient class. This is resolved and normalized from the {@link ShieldClientConfig | constructor configuration interface}.
  */
 export interface ShieldClientResolvedConfig extends ShieldClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Shield Advanced</fullname>
  *          <p>This is the <i>Shield Advanced API Reference</i>. This guide is for developers who need detailed information about the Shield Advanced API actions,
  *          data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the

package/dist-types/commands/AssociateDRTLogBucketCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AssociateDRTLogBucketRequest, AssociateDRTLogBucketResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
 /**
+ * @public
+ *
  * The input for {@link AssociateDRTLogBucketCommand}.
  */
 export interface AssociateDRTLogBucketCommandInput extends AssociateDRTLogBucketRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link AssociateDRTLogBucketCommand}.
  */
 export interface AssociateDRTLogBucketCommandOutput extends AssociateDRTLogBucketResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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.</p>
  *          <p>To use the services of the SRT and make an <code>AssociateDRTLogBucket</code> request, you must be subscribed to the <a href="http://aws.amazon.com/premiumsupport/business-support/">Business Support plan</a> or the <a href="http://aws.amazon.com/premiumsupport/enterprise-support/">Enterprise Support plan</a>.</p>
  * @example
@@ -26,6 +31,8 @@ export interface AssociateDRTLogBucketCommandOutput extends AssociateDRTLogBucke
  * const response = await client.send(command);
  * ```
  *
+ * @param AssociateDRTLogBucketCommandInput - {@link AssociateDRTLogBucketCommandInput}
+ * @returns {@link AssociateDRTLogBucketCommandOutput}
  * @see {@link AssociateDRTLogBucketCommandInput} for command's `input` shape.
  * @see {@link AssociateDRTLogBucketCommandOutput} for command's `response` shape.
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -60,11 +67,20 @@ export interface AssociateDRTLogBucketCommandOutput extends AssociateDRTLogBucke
 export declare class AssociateDRTLogBucketCommand extends $Command<AssociateDRTLogBucketCommandInput, AssociateDRTLogBucketCommandOutput, ShieldClientResolvedConfig> {
     readonly input: AssociateDRTLogBucketCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: AssociateDRTLogBucketCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateDRTLogBucketCommandInput, AssociateDRTLogBucketCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/AssociateDRTRoleCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AssociateDRTRoleRequest, AssociateDRTRoleResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
 /**
+ * @public
+ *
  * The input for {@link AssociateDRTRoleCommand}.
  */
 export interface AssociateDRTRoleCommandInput extends AssociateDRTRoleRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link AssociateDRTRoleCommand}.
  */
 export interface AssociateDRTRoleCommandOutput extends AssociateDRTRoleResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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.</p>
  *          <p>You can associate only one <code>RoleArn</code> with your subscription. If you submit an <code>AssociateDRTRole</code> request for an account that already has an associated role, the new <code>RoleArn</code> will replace the existing <code>RoleArn</code>. </p>
  *          <p>Prior to making the <code>AssociateDRTRole</code> request, you must attach the <code>AWSShieldDRTAccessPolicy</code> managed policy to the role that you'll specify in the request. You can access this policy in the IAM console at <a href="https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy">AWSShieldDRTAccessPolicy</a>. For more information see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html">Adding and removing IAM identity permissions</a>. The role must also trust the service principal
@@ -32,6 +37,8 @@ export interface AssociateDRTRoleCommandOutput extends AssociateDRTRoleResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param AssociateDRTRoleCommandInput - {@link AssociateDRTRoleCommandInput}
+ * @returns {@link AssociateDRTRoleCommandOutput}
  * @see {@link AssociateDRTRoleCommandInput} for command's `input` shape.
  * @see {@link AssociateDRTRoleCommandOutput} for command's `response` shape.
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -60,11 +67,20 @@ export interface AssociateDRTRoleCommandOutput extends AssociateDRTRoleResponse,
 export declare class AssociateDRTRoleCommand extends $Command<AssociateDRTRoleCommandInput, AssociateDRTRoleCommandOutput, ShieldClientResolvedConfig> {
     readonly input: AssociateDRTRoleCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: AssociateDRTRoleCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateDRTRoleCommandInput, AssociateDRTRoleCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/AssociateHealthCheckCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AssociateHealthCheckRequest, AssociateHealthCheckResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
 /**
+ * @public
+ *
  * The input for {@link AssociateHealthCheckCommand}.
  */
 export interface AssociateHealthCheckCommandInput extends AssociateHealthCheckRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link AssociateHealthCheckCommand}.
  */
 export interface AssociateHealthCheckCommandOutput extends AssociateHealthCheckResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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.  </p>
  *          <p>You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option">Shield Advanced Health-Based Detection</a> in the <i>WAF Developer Guide</i>. </p>
  * @example
@@ -26,6 +31,8 @@ export interface AssociateHealthCheckCommandOutput extends AssociateHealthCheckR
  * const response = await client.send(command);
  * ```
  *
+ * @param AssociateHealthCheckCommandInput - {@link AssociateHealthCheckCommandInput}
+ * @returns {@link AssociateHealthCheckCommandOutput}
  * @see {@link AssociateHealthCheckCommandInput} for command's `input` shape.
  * @see {@link AssociateHealthCheckCommandOutput} for command's `response` shape.
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -54,11 +61,20 @@ export interface AssociateHealthCheckCommandOutput extends AssociateHealthCheckR
 export declare class AssociateHealthCheckCommand extends $Command<AssociateHealthCheckCommandInput, AssociateHealthCheckCommandOutput, ShieldClientResolvedConfig> {
     readonly input: AssociateHealthCheckCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: AssociateHealthCheckCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateHealthCheckCommandInput, AssociateHealthCheckCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/AssociateProactiveEngagementDetailsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AssociateProactiveEngagementDetailsRequest, AssociateProactiveEngagementDetailsResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
 /**
+ * @public
+ *
  * The input for {@link AssociateProactiveEngagementDetailsCommand}.
  */
 export interface AssociateProactiveEngagementDetailsCommandInput extends AssociateProactiveEngagementDetailsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link AssociateProactiveEngagementDetailsCommand}.
  */
 export interface AssociateProactiveEngagementDetailsCommandOutput extends AssociateProactiveEngagementDetailsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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. </p>
  *          <p>After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls <code>DisableProactiveEngagement</code> and <code>EnableProactiveEngagement</code>.  </p>
  *          <note>
@@ -30,6 +35,8 @@ export interface AssociateProactiveEngagementDetailsCommandOutput extends Associ
  * const response = await client.send(command);
  * ```
  *
+ * @param AssociateProactiveEngagementDetailsCommandInput - {@link AssociateProactiveEngagementDetailsCommandInput}
+ * @returns {@link AssociateProactiveEngagementDetailsCommandOutput}
  * @see {@link AssociateProactiveEngagementDetailsCommandInput} for command's `input` shape.
  * @see {@link AssociateProactiveEngagementDetailsCommandOutput} for command's `response` shape.
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -55,11 +62,20 @@ export interface AssociateProactiveEngagementDetailsCommandOutput extends Associ
 export declare class AssociateProactiveEngagementDetailsCommand extends $Command<AssociateProactiveEngagementDetailsCommandInput, AssociateProactiveEngagementDetailsCommandOutput, ShieldClientResolvedConfig> {
     readonly input: AssociateProactiveEngagementDetailsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: AssociateProactiveEngagementDetailsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateProactiveEngagementDetailsCommandInput, AssociateProactiveEngagementDetailsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateProtectionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateProtectionRequest, CreateProtectionResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
 /**
+ * @public
+ *
  * The input for {@link CreateProtectionCommand}.
  */
 export interface CreateProtectionCommandInput extends CreateProtectionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateProtectionCommand}.
  */
 export interface CreateProtectionCommandOutput extends CreateProtectionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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.</p>
  *          <p>You can add protection to only a single resource with each <code>CreateProtection</code> request. You can add protection to multiple resources
  *           at once through the Shield Advanced console at <a href="https://console.aws.amazon.com/wafv2/shieldv2#/">https://console.aws.amazon.com/wafv2/shieldv2#/</a>.
@@ -30,6 +35,8 @@ export interface CreateProtectionCommandOutput extends CreateProtectionResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateProtectionCommandInput - {@link CreateProtectionCommandInput}
+ * @returns {@link CreateProtectionCommandOutput}
  * @see {@link CreateProtectionCommandInput} for command's `input` shape.
  * @see {@link CreateProtectionCommandOutput} for command's `response` shape.
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -64,11 +71,20 @@ export interface CreateProtectionCommandOutput extends CreateProtectionResponse,
 export declare class CreateProtectionCommand extends $Command<CreateProtectionCommandInput, CreateProtectionCommandOutput, ShieldClientResolvedConfig> {
     readonly input: CreateProtectionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateProtectionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateProtectionCommandInput, CreateProtectionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }