@aws-sdk/client-shield 3.296.0 → 3.298.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/dist-cjs/commands/AssociateDRTLogBucketCommand.js +2 -3
  2. package/dist-cjs/commands/AssociateDRTRoleCommand.js +2 -3
  3. package/dist-cjs/commands/AssociateHealthCheckCommand.js +2 -3
  4. package/dist-cjs/commands/AssociateProactiveEngagementDetailsCommand.js +2 -3
  5. package/dist-cjs/commands/CreateProtectionCommand.js +2 -3
  6. package/dist-cjs/commands/CreateProtectionGroupCommand.js +2 -3
  7. package/dist-cjs/commands/CreateSubscriptionCommand.js +2 -3
  8. package/dist-cjs/commands/DeleteProtectionCommand.js +2 -3
  9. package/dist-cjs/commands/DeleteProtectionGroupCommand.js +2 -3
  10. package/dist-cjs/commands/DeleteSubscriptionCommand.js +2 -3
  11. package/dist-cjs/commands/DescribeAttackCommand.js +2 -3
  12. package/dist-cjs/commands/DescribeAttackStatisticsCommand.js +2 -3
  13. package/dist-cjs/commands/DescribeDRTAccessCommand.js +2 -3
  14. package/dist-cjs/commands/DescribeEmergencyContactSettingsCommand.js +2 -3
  15. package/dist-cjs/commands/DescribeProtectionCommand.js +2 -3
  16. package/dist-cjs/commands/DescribeProtectionGroupCommand.js +2 -3
  17. package/dist-cjs/commands/DescribeSubscriptionCommand.js +2 -3
  18. package/dist-cjs/commands/DisableApplicationLayerAutomaticResponseCommand.js +2 -3
  19. package/dist-cjs/commands/DisableProactiveEngagementCommand.js +2 -3
  20. package/dist-cjs/commands/DisassociateDRTLogBucketCommand.js +2 -3
  21. package/dist-cjs/commands/DisassociateDRTRoleCommand.js +2 -3
  22. package/dist-cjs/commands/DisassociateHealthCheckCommand.js +2 -3
  23. package/dist-cjs/commands/EnableApplicationLayerAutomaticResponseCommand.js +2 -3
  24. package/dist-cjs/commands/EnableProactiveEngagementCommand.js +2 -3
  25. package/dist-cjs/commands/GetSubscriptionStateCommand.js +2 -3
  26. package/dist-cjs/commands/ListAttacksCommand.js +2 -3
  27. package/dist-cjs/commands/ListProtectionGroupsCommand.js +2 -3
  28. package/dist-cjs/commands/ListProtectionsCommand.js +2 -3
  29. package/dist-cjs/commands/ListResourcesInProtectionGroupCommand.js +2 -3
  30. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  31. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  32. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  33. package/dist-cjs/commands/UpdateApplicationLayerAutomaticResponseCommand.js +2 -3
  34. package/dist-cjs/commands/UpdateEmergencyContactSettingsCommand.js +2 -3
  35. package/dist-cjs/commands/UpdateProtectionGroupCommand.js +2 -3
  36. package/dist-cjs/commands/UpdateSubscriptionCommand.js +2 -3
  37. package/dist-cjs/models/models_0.js +1 -415
  38. package/dist-es/commands/AssociateDRTLogBucketCommand.js +2 -3
  39. package/dist-es/commands/AssociateDRTRoleCommand.js +2 -3
  40. package/dist-es/commands/AssociateHealthCheckCommand.js +2 -3
  41. package/dist-es/commands/AssociateProactiveEngagementDetailsCommand.js +2 -3
  42. package/dist-es/commands/CreateProtectionCommand.js +2 -3
  43. package/dist-es/commands/CreateProtectionGroupCommand.js +2 -3
  44. package/dist-es/commands/CreateSubscriptionCommand.js +2 -3
  45. package/dist-es/commands/DeleteProtectionCommand.js +2 -3
  46. package/dist-es/commands/DeleteProtectionGroupCommand.js +2 -3
  47. package/dist-es/commands/DeleteSubscriptionCommand.js +2 -3
  48. package/dist-es/commands/DescribeAttackCommand.js +2 -3
  49. package/dist-es/commands/DescribeAttackStatisticsCommand.js +2 -3
  50. package/dist-es/commands/DescribeDRTAccessCommand.js +2 -3
  51. package/dist-es/commands/DescribeEmergencyContactSettingsCommand.js +2 -3
  52. package/dist-es/commands/DescribeProtectionCommand.js +2 -3
  53. package/dist-es/commands/DescribeProtectionGroupCommand.js +2 -3
  54. package/dist-es/commands/DescribeSubscriptionCommand.js +2 -3
  55. package/dist-es/commands/DisableApplicationLayerAutomaticResponseCommand.js +2 -3
  56. package/dist-es/commands/DisableProactiveEngagementCommand.js +2 -3
  57. package/dist-es/commands/DisassociateDRTLogBucketCommand.js +2 -3
  58. package/dist-es/commands/DisassociateDRTRoleCommand.js +2 -3
  59. package/dist-es/commands/DisassociateHealthCheckCommand.js +2 -3
  60. package/dist-es/commands/EnableApplicationLayerAutomaticResponseCommand.js +2 -3
  61. package/dist-es/commands/EnableProactiveEngagementCommand.js +2 -3
  62. package/dist-es/commands/GetSubscriptionStateCommand.js +2 -3
  63. package/dist-es/commands/ListAttacksCommand.js +2 -3
  64. package/dist-es/commands/ListProtectionGroupsCommand.js +2 -3
  65. package/dist-es/commands/ListProtectionsCommand.js +2 -3
  66. package/dist-es/commands/ListResourcesInProtectionGroupCommand.js +2 -3
  67. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  68. package/dist-es/commands/TagResourceCommand.js +2 -3
  69. package/dist-es/commands/UntagResourceCommand.js +2 -3
  70. package/dist-es/commands/UpdateApplicationLayerAutomaticResponseCommand.js +2 -3
  71. package/dist-es/commands/UpdateEmergencyContactSettingsCommand.js +2 -3
  72. package/dist-es/commands/UpdateProtectionGroupCommand.js +2 -3
  73. package/dist-es/commands/UpdateSubscriptionCommand.js +2 -3
  74. package/dist-es/models/models_0.js +0 -309
  75. package/dist-types/Shield.d.ts +37 -0
  76. package/dist-types/ShieldClient.d.ts +24 -4
  77. package/dist-types/commands/AssociateDRTLogBucketCommand.d.ts +16 -0
  78. package/dist-types/commands/AssociateDRTRoleCommand.d.ts +16 -0
  79. package/dist-types/commands/AssociateHealthCheckCommand.d.ts +16 -0
  80. package/dist-types/commands/AssociateProactiveEngagementDetailsCommand.d.ts +16 -0
  81. package/dist-types/commands/CreateProtectionCommand.d.ts +16 -0
  82. package/dist-types/commands/CreateProtectionGroupCommand.d.ts +16 -0
  83. package/dist-types/commands/CreateSubscriptionCommand.d.ts +16 -0
  84. package/dist-types/commands/DeleteProtectionCommand.d.ts +16 -0
  85. package/dist-types/commands/DeleteProtectionGroupCommand.d.ts +16 -0
  86. package/dist-types/commands/DeleteSubscriptionCommand.d.ts +16 -0
  87. package/dist-types/commands/DescribeAttackCommand.d.ts +16 -0
  88. package/dist-types/commands/DescribeAttackStatisticsCommand.d.ts +16 -0
  89. package/dist-types/commands/DescribeDRTAccessCommand.d.ts +16 -0
  90. package/dist-types/commands/DescribeEmergencyContactSettingsCommand.d.ts +16 -0
  91. package/dist-types/commands/DescribeProtectionCommand.d.ts +16 -0
  92. package/dist-types/commands/DescribeProtectionGroupCommand.d.ts +16 -0
  93. package/dist-types/commands/DescribeSubscriptionCommand.d.ts +16 -0
  94. package/dist-types/commands/DisableApplicationLayerAutomaticResponseCommand.d.ts +16 -0
  95. package/dist-types/commands/DisableProactiveEngagementCommand.d.ts +16 -0
  96. package/dist-types/commands/DisassociateDRTLogBucketCommand.d.ts +16 -0
  97. package/dist-types/commands/DisassociateDRTRoleCommand.d.ts +16 -0
  98. package/dist-types/commands/DisassociateHealthCheckCommand.d.ts +16 -0
  99. package/dist-types/commands/EnableApplicationLayerAutomaticResponseCommand.d.ts +16 -0
  100. package/dist-types/commands/EnableProactiveEngagementCommand.d.ts +16 -0
  101. package/dist-types/commands/GetSubscriptionStateCommand.d.ts +16 -0
  102. package/dist-types/commands/ListAttacksCommand.d.ts +16 -0
  103. package/dist-types/commands/ListProtectionGroupsCommand.d.ts +16 -0
  104. package/dist-types/commands/ListProtectionsCommand.d.ts +16 -0
  105. package/dist-types/commands/ListResourcesInProtectionGroupCommand.d.ts +16 -0
  106. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  107. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  108. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  109. package/dist-types/commands/UpdateApplicationLayerAutomaticResponseCommand.d.ts +16 -0
  110. package/dist-types/commands/UpdateEmergencyContactSettingsCommand.d.ts +16 -0
  111. package/dist-types/commands/UpdateProtectionGroupCommand.d.ts +16 -0
  112. package/dist-types/commands/UpdateSubscriptionCommand.d.ts +16 -0
  113. package/dist-types/models/ShieldServiceException.d.ts +2 -0
  114. package/dist-types/models/models_0.d.ts +298 -414
  115. package/dist-types/pagination/Interfaces.d.ts +3 -0
  116. package/dist-types/pagination/ListAttacksPaginator.d.ts +3 -0
  117. package/dist-types/pagination/ListProtectionGroupsPaginator.d.ts +3 -0
  118. package/dist-types/pagination/ListProtectionsPaginator.d.ts +3 -0
  119. package/dist-types/pagination/ListResourcesInProtectionGroupPaginator.d.ts +3 -0
  120. package/dist-types/ts3.4/models/models_0.d.ts +0 -287
  121. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssociateDRTLogBucketRequest, AssociateDRTLogBucketResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateDRTLogBucketCommand}.
8
10
  */
9
11
  export interface AssociateDRTLogBucketCommandInput extends AssociateDRTLogBucketRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateDRTLogBucketCommand}.
13
17
  */
14
18
  export interface AssociateDRTLogBucketCommandOutput extends AssociateDRTLogBucketResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <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>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface AssociateDRTLogBucketCommandOutput extends AssociateDRTLogBucke
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param AssociateDRTLogBucketCommandInput - {@link AssociateDRTLogBucketCommandInput}
35
+ * @returns {@link AssociateDRTLogBucketCommandOutput}
29
36
  * @see {@link AssociateDRTLogBucketCommandInput} for command's `input` shape.
30
37
  * @see {@link AssociateDRTLogBucketCommandOutput} for command's `response` shape.
31
38
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -60,11 +67,20 @@ export interface AssociateDRTLogBucketCommandOutput extends AssociateDRTLogBucke
60
67
  export declare class AssociateDRTLogBucketCommand extends $Command<AssociateDRTLogBucketCommandInput, AssociateDRTLogBucketCommandOutput, ShieldClientResolvedConfig> {
61
68
  readonly input: AssociateDRTLogBucketCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: AssociateDRTLogBucketCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateDRTLogBucketCommandInput, AssociateDRTLogBucketCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssociateDRTRoleRequest, AssociateDRTRoleResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateDRTRoleCommand}.
8
10
  */
9
11
  export interface AssociateDRTRoleCommandInput extends AssociateDRTRoleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateDRTRoleCommand}.
13
17
  */
14
18
  export interface AssociateDRTRoleCommandOutput extends AssociateDRTRoleResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <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>
19
24
  * <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,
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param AssociateDRTRoleCommandInput - {@link AssociateDRTRoleCommandInput}
41
+ * @returns {@link AssociateDRTRoleCommandOutput}
35
42
  * @see {@link AssociateDRTRoleCommandInput} for command's `input` shape.
36
43
  * @see {@link AssociateDRTRoleCommandOutput} for command's `response` shape.
37
44
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -60,11 +67,20 @@ export interface AssociateDRTRoleCommandOutput extends AssociateDRTRoleResponse,
60
67
  export declare class AssociateDRTRoleCommand extends $Command<AssociateDRTRoleCommandInput, AssociateDRTRoleCommandOutput, ShieldClientResolvedConfig> {
61
68
  readonly input: AssociateDRTRoleCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: AssociateDRTRoleCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateDRTRoleCommandInput, AssociateDRTRoleCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssociateHealthCheckRequest, AssociateHealthCheckResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateHealthCheckCommand}.
8
10
  */
9
11
  export interface AssociateHealthCheckCommandInput extends AssociateHealthCheckRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateHealthCheckCommand}.
13
17
  */
14
18
  export interface AssociateHealthCheckCommandOutput extends AssociateHealthCheckResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <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>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface AssociateHealthCheckCommandOutput extends AssociateHealthCheckR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param AssociateHealthCheckCommandInput - {@link AssociateHealthCheckCommandInput}
35
+ * @returns {@link AssociateHealthCheckCommandOutput}
29
36
  * @see {@link AssociateHealthCheckCommandInput} for command's `input` shape.
30
37
  * @see {@link AssociateHealthCheckCommandOutput} for command's `response` shape.
31
38
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -54,11 +61,20 @@ export interface AssociateHealthCheckCommandOutput extends AssociateHealthCheckR
54
61
  export declare class AssociateHealthCheckCommand extends $Command<AssociateHealthCheckCommandInput, AssociateHealthCheckCommandOutput, ShieldClientResolvedConfig> {
55
62
  readonly input: AssociateHealthCheckCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: AssociateHealthCheckCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateHealthCheckCommandInput, AssociateHealthCheckCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssociateProactiveEngagementDetailsRequest, AssociateProactiveEngagementDetailsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateProactiveEngagementDetailsCommand}.
8
10
  */
9
11
  export interface AssociateProactiveEngagementDetailsCommandInput extends AssociateProactiveEngagementDetailsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateProactiveEngagementDetailsCommand}.
13
17
  */
14
18
  export interface AssociateProactiveEngagementDetailsCommandOutput extends AssociateProactiveEngagementDetailsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <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>
19
24
  * <note>
@@ -30,6 +35,8 @@ export interface AssociateProactiveEngagementDetailsCommandOutput extends Associ
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param AssociateProactiveEngagementDetailsCommandInput - {@link AssociateProactiveEngagementDetailsCommandInput}
39
+ * @returns {@link AssociateProactiveEngagementDetailsCommandOutput}
33
40
  * @see {@link AssociateProactiveEngagementDetailsCommandInput} for command's `input` shape.
34
41
  * @see {@link AssociateProactiveEngagementDetailsCommandOutput} for command's `response` shape.
35
42
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -55,11 +62,20 @@ export interface AssociateProactiveEngagementDetailsCommandOutput extends Associ
55
62
  export declare class AssociateProactiveEngagementDetailsCommand extends $Command<AssociateProactiveEngagementDetailsCommandInput, AssociateProactiveEngagementDetailsCommandOutput, ShieldClientResolvedConfig> {
56
63
  readonly input: AssociateProactiveEngagementDetailsCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: AssociateProactiveEngagementDetailsCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateProactiveEngagementDetailsCommandInput, AssociateProactiveEngagementDetailsCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateProtectionRequest, CreateProtectionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateProtectionCommand}.
8
10
  */
9
11
  export interface CreateProtectionCommandInput extends CreateProtectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateProtectionCommand}.
13
17
  */
14
18
  export interface CreateProtectionCommandOutput extends CreateProtectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <p>You can add protection to only a single resource with each <code>CreateProtection</code> request. You can add protection to multiple resources
19
24
  * 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,
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param CreateProtectionCommandInput - {@link CreateProtectionCommandInput}
39
+ * @returns {@link CreateProtectionCommandOutput}
33
40
  * @see {@link CreateProtectionCommandInput} for command's `input` shape.
34
41
  * @see {@link CreateProtectionCommandOutput} for command's `response` shape.
35
42
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -64,11 +71,20 @@ export interface CreateProtectionCommandOutput extends CreateProtectionResponse,
64
71
  export declare class CreateProtectionCommand extends $Command<CreateProtectionCommandInput, CreateProtectionCommandOutput, ShieldClientResolvedConfig> {
65
72
  readonly input: CreateProtectionCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: CreateProtectionCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateProtectionCommandInput, CreateProtectionCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateProtectionGroupRequest, CreateProtectionGroupResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateProtectionGroupCommand}.
8
10
  */
9
11
  export interface CreateProtectionGroupCommandInput extends CreateProtectionGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateProtectionGroupCommand}.
13
17
  */
14
18
  export interface CreateProtectionGroupCommandOutput extends CreateProtectionGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateProtectionGroupCommandOutput extends CreateProtectionGrou
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateProtectionGroupCommandInput - {@link CreateProtectionGroupCommandInput}
34
+ * @returns {@link CreateProtectionGroupCommandOutput}
28
35
  * @see {@link CreateProtectionGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateProtectionGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -53,11 +60,20 @@ export interface CreateProtectionGroupCommandOutput extends CreateProtectionGrou
53
60
  export declare class CreateProtectionGroupCommand extends $Command<CreateProtectionGroupCommandInput, CreateProtectionGroupCommandOutput, ShieldClientResolvedConfig> {
54
61
  readonly input: CreateProtectionGroupCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: CreateProtectionGroupCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateProtectionGroupCommandInput, CreateProtectionGroupCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateSubscriptionRequest, CreateSubscriptionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateSubscriptionCommand}.
8
10
  */
9
11
  export interface CreateSubscriptionCommandInput extends CreateSubscriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateSubscriptionCommand}.
13
17
  */
14
18
  export interface CreateSubscriptionCommandOutput extends CreateSubscriptionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Activates Shield Advanced for an account.</p>
18
23
  * <note>
19
24
  * <p>For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account,
@@ -30,6 +35,8 @@ export interface CreateSubscriptionCommandOutput extends CreateSubscriptionRespo
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param CreateSubscriptionCommandInput - {@link CreateSubscriptionCommandInput}
39
+ * @returns {@link CreateSubscriptionCommandOutput}
33
40
  * @see {@link CreateSubscriptionCommandInput} for command's `input` shape.
34
41
  * @see {@link CreateSubscriptionCommandOutput} for command's `response` shape.
35
42
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -45,11 +52,20 @@ export interface CreateSubscriptionCommandOutput extends CreateSubscriptionRespo
45
52
  export declare class CreateSubscriptionCommand extends $Command<CreateSubscriptionCommandInput, CreateSubscriptionCommandOutput, ShieldClientResolvedConfig> {
46
53
  readonly input: CreateSubscriptionCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: CreateSubscriptionCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSubscriptionCommandInput, CreateSubscriptionCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteProtectionRequest, DeleteProtectionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteProtectionCommand}.
8
10
  */
9
11
  export interface DeleteProtectionCommandInput extends DeleteProtectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteProtectionCommand}.
13
17
  */
14
18
  export interface DeleteProtectionCommandOutput extends DeleteProtectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an Shield Advanced <a>Protection</a>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteProtectionCommandOutput extends DeleteProtectionResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteProtectionCommandInput - {@link DeleteProtectionCommandInput}
34
+ * @returns {@link DeleteProtectionCommandOutput}
28
35
  * @see {@link DeleteProtectionCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteProtectionCommandOutput} for command's `response` shape.
30
37
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DeleteProtectionCommandOutput extends DeleteProtectionResponse,
44
51
  export declare class DeleteProtectionCommand extends $Command<DeleteProtectionCommandInput, DeleteProtectionCommandOutput, ShieldClientResolvedConfig> {
45
52
  readonly input: DeleteProtectionCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DeleteProtectionCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProtectionCommandInput, DeleteProtectionCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteProtectionGroupRequest, DeleteProtectionGroupResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteProtectionGroupCommand}.
8
10
  */
9
11
  export interface DeleteProtectionGroupCommandInput extends DeleteProtectionGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteProtectionGroupCommand}.
13
17
  */
14
18
  export interface DeleteProtectionGroupCommandOutput extends DeleteProtectionGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the specified protection group.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteProtectionGroupCommandOutput extends DeleteProtectionGrou
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteProtectionGroupCommandInput - {@link DeleteProtectionGroupCommandInput}
34
+ * @returns {@link DeleteProtectionGroupCommandOutput}
28
35
  * @see {@link DeleteProtectionGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteProtectionGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DeleteProtectionGroupCommandOutput extends DeleteProtectionGrou
44
51
  export declare class DeleteProtectionGroupCommand extends $Command<DeleteProtectionGroupCommandInput, DeleteProtectionGroupCommandOutput, ShieldClientResolvedConfig> {
45
52
  readonly input: DeleteProtectionGroupCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DeleteProtectionGroupCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProtectionGroupCommandInput, DeleteProtectionGroupCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteSubscriptionRequest, DeleteSubscriptionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSubscriptionCommand}.
8
10
  */
9
11
  export interface DeleteSubscriptionCommandInput extends DeleteSubscriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSubscriptionCommand}.
13
17
  */
14
18
  export interface DeleteSubscriptionCommandOutput extends DeleteSubscriptionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * @deprecated
18
23
  *
19
24
  * <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>
@@ -27,6 +32,8 @@ export interface DeleteSubscriptionCommandOutput extends DeleteSubscriptionRespo
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteSubscriptionCommandInput - {@link DeleteSubscriptionCommandInput}
36
+ * @returns {@link DeleteSubscriptionCommandOutput}
30
37
  * @see {@link DeleteSubscriptionCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteSubscriptionCommandOutput} for command's `response` shape.
32
39
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -45,11 +52,20 @@ export interface DeleteSubscriptionCommandOutput extends DeleteSubscriptionRespo
45
52
  export declare class DeleteSubscriptionCommand extends $Command<DeleteSubscriptionCommandInput, DeleteSubscriptionCommandOutput, ShieldClientResolvedConfig> {
46
53
  readonly input: DeleteSubscriptionCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: DeleteSubscriptionCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSubscriptionCommandInput, DeleteSubscriptionCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAttackRequest, DescribeAttackResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAttackCommand}.
8
10
  */
9
11
  export interface DescribeAttackCommandInput extends DescribeAttackRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAttackCommand}.
13
17
  */
14
18
  export interface DescribeAttackCommandOutput extends DescribeAttackResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the details of a DDoS attack. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAttackCommandOutput extends DescribeAttackResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAttackCommandInput - {@link DescribeAttackCommandInput}
34
+ * @returns {@link DescribeAttackCommandOutput}
28
35
  * @see {@link DescribeAttackCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAttackCommandOutput} for command's `response` shape.
30
37
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -40,11 +47,20 @@ export interface DescribeAttackCommandOutput extends DescribeAttackResponse, __M
40
47
  export declare class DescribeAttackCommand extends $Command<DescribeAttackCommandInput, DescribeAttackCommandOutput, ShieldClientResolvedConfig> {
41
48
  readonly input: DescribeAttackCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: DescribeAttackCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAttackCommandInput, DescribeAttackCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAttackStatisticsRequest, DescribeAttackStatisticsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, ShieldClientResolvedConfig } from "../ShieldClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAttackStatisticsCommand}.
8
10
  */
9
11
  export interface DescribeAttackStatisticsCommandInput extends DescribeAttackStatisticsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAttackStatisticsCommand}.
13
17
  */
14
18
  export interface DescribeAttackStatisticsCommandOutput extends DescribeAttackStatisticsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <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>
19
24
  * <p>The time range indicates the period covered by the attack statistics data items.</p>
@@ -27,6 +32,8 @@ export interface DescribeAttackStatisticsCommandOutput extends DescribeAttackSta
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeAttackStatisticsCommandInput - {@link DescribeAttackStatisticsCommandInput}
36
+ * @returns {@link DescribeAttackStatisticsCommandOutput}
30
37
  * @see {@link DescribeAttackStatisticsCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeAttackStatisticsCommandOutput} for command's `response` shape.
32
39
  * @see {@link ShieldClientResolvedConfig | config} for ShieldClient's `config` shape.
@@ -39,11 +46,20 @@ export interface DescribeAttackStatisticsCommandOutput extends DescribeAttackSta
39
46
  export declare class DescribeAttackStatisticsCommand extends $Command<DescribeAttackStatisticsCommandInput, DescribeAttackStatisticsCommandOutput, ShieldClientResolvedConfig> {
40
47
  readonly input: DescribeAttackStatisticsCommandInput;
41
48
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
49
+ /**
50
+ * @public
51
+ */
42
52
  constructor(input: DescribeAttackStatisticsCommandInput);
43
53
  /**
44
54
  * @internal
45
55
  */
46
56
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ShieldClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAttackStatisticsCommandInput, DescribeAttackStatisticsCommandOutput>;
57
+ /**
58
+ * @internal
59
+ */
47
60
  private serialize;
61
+ /**
62
+ * @internal
63
+ */
48
64
  private deserialize;
49
65
  }